Package org.neo4j.gds.embeddings.graphsage.algo

Interface GraphSageTrainConfig

All Superinterfaces:

org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.BaseConfig, org.neo4j.gds.config.BatchSizeConfig, org.neo4j.gds.config.ConcurrencyConfig, org.neo4j.gds.config.EmbeddingDimensionConfig, org.neo4j.gds.config.FeaturePropertiesConfig, org.neo4j.gds.config.IterationsConfig, org.neo4j.gds.model.ModelConfig, org.neo4j.gds.config.RandomSeedConfig, org.neo4j.gds.config.RelationshipWeightConfig, java.io.Serializable, org.neo4j.gds.config.ToleranceConfig, org.neo4j.gds.config.ToMapConvertible

@Configuration("GraphSageTrainConfigImpl")
public interface GraphSageTrainConfig
extends org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.model.ModelConfig, org.neo4j.gds.config.BatchSizeConfig, org.neo4j.gds.config.IterationsConfig, org.neo4j.gds.config.ToleranceConfig, org.neo4j.gds.config.EmbeddingDimensionConfig, org.neo4j.gds.config.RelationshipWeightConfig, org.neo4j.gds.config.FeaturePropertiesConfig, org.neo4j.gds.config.RandomSeedConfig

Field Summary

Fields

Modifier and Type	Field	Description
static long	serialVersionUID

Fields inherited from interface org.neo4j.gds.config.AlgoBaseConfig

NODE_LABELS_KEY, RELATIONSHIP_TYPES_KEY

Fields inherited from interface org.neo4j.gds.config.BaseConfig

SUDO_KEY

Fields inherited from interface org.neo4j.gds.config.ConcurrencyConfig

CONCURRENCY_KEY, CONCURRENCY_LIMITATION, DEFAULT_CONCURRENCY

Fields inherited from interface org.neo4j.gds.model.ModelConfig

MODEL_NAME_KEY, MODEL_TYPE_KEY

Fields inherited from interface org.neo4j.gds.config.RelationshipWeightConfig

RELATIONSHIP_WEIGHT_PROPERTY

Method Summary

Modifier and Type	Method	Description
default ActivationFunction	activationFunction()
default Aggregator.AggregatorType	aggregator()
static java.util.List<java.lang.Integer>	convertToIntSamples(java.util.List<java.lang.Number> input)
default int	embeddingDimension()
default int	epochs()
default int	estimationFeatureDimension()
default boolean	isMultiLabel()
default boolean	isWeighted()
default java.util.List<LayerConfig>	layerConfigs(int featureDimension)
default double	learningRate()
default int	maxIterations()
default int	negativeSampleWeight()
static GraphSageTrainConfig	of(java.lang.String username, org.neo4j.gds.core.CypherMapWrapper userInput)
java.util.Optional<java.lang.Integer>	projectedFeatureDimension()
default boolean	propertiesMustExistForEachNodeLabel()
default java.util.List<java.lang.Integer>	sampleSizes()
default int	searchDepth()
static org.neo4j.gds.embeddings.graphsage.algo.ImmutableGraphSageTrainConfig.Builder	testBuilder()
default double	tolerance()
default void	validate()

Methods inherited from interface org.neo4j.gds.config.AlgoBaseConfig

graphStoreValidation, internalRelationshipTypes, nodeLabelIdentifiers, nodeLabels, relationshipTypes

Methods inherited from interface org.neo4j.gds.config.BaseConfig

configKeys, sudo, toMap, usernameOverride

Methods inherited from interface org.neo4j.gds.config.BatchSizeConfig

batchSize

Methods inherited from interface org.neo4j.gds.config.ConcurrencyConfig

concurrency, minBatchSize, validateConcurrency

Methods inherited from interface org.neo4j.gds.config.FeaturePropertiesConfig

featureProperties

Methods inherited from interface org.neo4j.gds.model.ModelConfig

modelName, username

Methods inherited from interface org.neo4j.gds.config.RandomSeedConfig

randomSeed

Methods inherited from interface org.neo4j.gds.config.RelationshipWeightConfig

hasRelationshipWeightProperty, relationshipWeightProperty, relationshipWeightValidation

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

embeddingDimension

@Default
default int embeddingDimension()

Specified by:

embeddingDimension in interface org.neo4j.gds.config.EmbeddingDimensionConfig

sampleSizes

@Default
@IntegerRange(min=1)
@ConvertWith("convertToIntSamples")
default java.util.List<java.lang.Integer> sampleSizes()

convertToIntSamples

static java.util.List<java.lang.Integer> convertToIntSamples(java.util.List<java.lang.Number> input)

aggregator

@Default
@ConvertWith("org.neo4j.gds.embeddings.graphsage.Aggregator.AggregatorType#parse")
@ToMapValue("org.neo4j.gds.embeddings.graphsage.Aggregator.AggregatorType#toString")
default Aggregator.AggregatorType aggregator()

activationFunction

@Default
@ConvertWith("org.neo4j.gds.embeddings.graphsage.ActivationFunction#parse")
@ToMapValue("org.neo4j.gds.embeddings.graphsage.ActivationFunction#toString")
default ActivationFunction activationFunction()

tolerance

@Default
default double tolerance()

Specified by:

tolerance in interface org.neo4j.gds.config.ToleranceConfig

learningRate

@Default
default double learningRate()

epochs

@Default
@IntegerRange(min=1)
default int epochs()

maxIterations

@Default
default int maxIterations()

Specified by:

maxIterations in interface org.neo4j.gds.config.IterationsConfig

searchDepth

@Default
default int searchDepth()

negativeSampleWeight

@Default
default int negativeSampleWeight()

projectedFeatureDimension

@IntegerRange(min=1)
java.util.Optional<java.lang.Integer> projectedFeatureDimension()

propertiesMustExistForEachNodeLabel

@Ignore
default boolean propertiesMustExistForEachNodeLabel()

Specified by:

propertiesMustExistForEachNodeLabel in interface org.neo4j.gds.config.FeaturePropertiesConfig

isWeighted

@Ignore
@Derived
default boolean isWeighted()

layerConfigs

@Ignore
default java.util.List<LayerConfig> layerConfigs(int featureDimension)

isMultiLabel

@Ignore
default boolean isMultiLabel()

estimationFeatureDimension

@Ignore
default int estimationFeatureDimension()

validate

@Check
default void validate()

of

static GraphSageTrainConfig of(java.lang.String username,
                               org.neo4j.gds.core.CypherMapWrapper userInput)

testBuilder

@TestOnly
static org.neo4j.gds.embeddings.graphsage.algo.ImmutableGraphSageTrainConfig.Builder testBuilder()