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.config.JobIdConfig, 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

        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.model.ModelConfig

        MODEL_NAME_KEY, MODEL_TYPE_KEY

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

        RELATIONSHIP_WEIGHT_PROPERTY

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default ActivationFunction activationFunction()  
      default Aggregator.AggregatorType aggregator()  
      default int batchesPerIteration​(long nodeCount)  
      static java.util.List<java.lang.Integer> convertToIntSamples​(java.util.List<? extends java.lang.Number> input)  
      default int embeddingDimension()  
      default int epochs()  
      default int estimationFeatureDimension()  
      java.util.List<java.lang.String> featureProperties()  
      default boolean isMultiLabel()  
      default java.util.List<LayerConfig> layerConfigs​(int featureDimension)  
      default double learningRate()  
      default int maxIterations()  
      java.util.Optional<java.lang.Double> maybeBatchSamplingRatio()  
      default int negativeSampleWeight()  
      static GraphSageTrainConfig of​(java.lang.String username, org.neo4j.gds.core.CypherMapWrapper userInput)  
      default double penaltyL2()  
      java.util.Optional<java.lang.Integer> projectedFeatureDimension()  
      default boolean propertiesMustExistForEachNodeLabel()  
      default java.util.List<java.lang.Integer> sampleSizes()  
      default int searchDepth()  
      default double tolerance()  
      default void validate()  
      default void validateNonEmptyGraph​(org.neo4j.gds.api.GraphStore graphStore, java.util.Collection<org.neo4j.gds.NodeLabel> selectedLabels, java.util.Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)  

      • 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.BatchSizeConfig

        batchSize

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

        concurrency, minBatchSize, validateConcurrency

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

        validateFeatureProperties

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

        jobId

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

        modelName, modelUser, username

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

        randomSeed

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

        hasRelationshipWeightProperty, relationshipWeightProperty, relationshipWeightValidation, validateRelationshipWeightProperty

    • Method Detail

      • featureProperties

        java.util.List<java.lang.String> featureProperties()
        Specified by:
        featureProperties in interface org.neo4j.gds.config.FeaturePropertiesConfig

      • embeddingDimension

        @Default
default int embeddingDimension()
        Specified by:
        embeddingDimension in interface org.neo4j.gds.config.EmbeddingDimensionConfig

      • sampleSizes

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

      • convertToIntSamples

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

      • aggregator

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

      • activationFunction

        @Default
@ConvertWith(method="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

      • maybeBatchSamplingRatio

        @Key("batchSamplingRatio")
@DoubleRange(min=0.0,
             max=1.0,
             minInclusive=false)
java.util.Optional<java.lang.Double> maybeBatchSamplingRatio()

      • penaltyL2

        @DoubleRange(min=0.0)
default double penaltyL2()

      • batchesPerIteration

        @Ignore
@Derived
default int batchesPerIteration​(long nodeCount)

      • 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

      • 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()

      • validateNonEmptyGraph

        @GraphStoreValidationCheck
@Default
default void validateNonEmptyGraph​(org.neo4j.gds.api.GraphStore graphStore,
                                   java.util.Collection<org.neo4j.gds.NodeLabel> selectedLabels,
                                   java.util.Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)

      • of

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