Package org.neo4j.gds.embeddings.node2vec

Interface Node2VecBaseConfig

All Superinterfaces:

org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.BaseConfig, org.neo4j.gds.config.ConcurrencyConfig, org.neo4j.gds.config.EmbeddingDimensionConfig, org.neo4j.gds.config.JobIdConfig, org.neo4j.gds.config.RandomSeedConfig, RandomWalkBaseConfig, org.neo4j.gds.config.RelationshipWeightConfig, org.neo4j.gds.config.SourceNodesConfig, org.neo4j.gds.config.ToMapConvertible

All Known Subinterfaces:

Node2VecMutateConfig, Node2VecStreamConfig, Node2VecWriteConfig

public interface Node2VecBaseConfig
extends org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.EmbeddingDimensionConfig, RandomWalkBaseConfig

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Node2VecBaseConfig.EmbeddingInitializer

Field Summary

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

NODE_LABELS_KEY, RELATIONSHIP_TYPES_KEY

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

LOG_PROGRESS_KEY, SUDO_KEY

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

CONCURRENCY_KEY, CONCURRENCY_LIMITATION, DEFAULT_CONCURRENCY

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

RELATIONSHIP_WEIGHT_PROPERTY

Method Summary

Modifier and Type	Method	Description
default int	embeddingDimension()
default Node2VecBaseConfig.EmbeddingInitializer	embeddingInitializer()
default double	initialLearningRate()
default int	iterations()
default double	minLearningRate()
default double	negativeSamplingExponent()
default int	negativeSamplingRate()
default double	positiveSamplingFactor()
default java.util.List<java.lang.Long>	sourceNodes()
default int	windowSize()

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

graphStoreValidation, internalRelationshipTypes, nodeLabelIdentifiers, nodeLabels, relationshipTypes, validateNodeLabels, validateRelationshipTypes

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

configKeys, logProgress, sudo, toMap, usernameOverride

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

concurrency, minBatchSize, validateConcurrency

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

jobId

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

randomSeed

Methods inherited from interface org.neo4j.gds.traversal.RandomWalkBaseConfig

inOutFactor, returnFactor, walkBufferSize, walkLength, walksPerNode

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

hasRelationshipWeightProperty, relationshipWeightProperty, relationshipWeightValidation, validateRelationshipWeightProperty

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

validateSourceLabels

Method Detail

windowSize

@Default
@IntegerRange(min=2)
default int windowSize()

negativeSamplingRate

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

positiveSamplingFactor

@Default
@DoubleRange(min=1.0E-5,
             minInclusive=false,
             max=1.0)
default double positiveSamplingFactor()

negativeSamplingExponent

@Default
@DoubleRange(min=1.0E-5,
             minInclusive=false,
             max=1.0)
default double negativeSamplingExponent()

embeddingDimension

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

Specified by:

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

embeddingInitializer

@Default
@ConvertWith(method="org.neo4j.gds.embeddings.node2vec.Node2VecBaseConfig.EmbeddingInitializer#parse",
             inverse="__USE_TO_MAP_METHOD__")
@ToMapValue("org.neo4j.gds.embeddings.node2vec.Node2VecBaseConfig.EmbeddingInitializer#toString")
default Node2VecBaseConfig.EmbeddingInitializer embeddingInitializer()

initialLearningRate

@Default
@DoubleRange(min=0.0,
             minInclusive=false)
default double initialLearningRate()

minLearningRate

@Default
@DoubleRange(min=0.0,
             minInclusive=false)
default double minLearningRate()

iterations

@Default
default int iterations()

sourceNodes

@Ignore
@Default
default java.util.List<java.lang.Long> sourceNodes()

Specified by:

sourceNodes in interface org.neo4j.gds.config.SourceNodesConfig