Package org.neo4j.gds.embeddings.graphsage

Class GraphSageTrainProc

  • All Implemented Interfaces:
    org.neo4j.gds.executor.AlgorithmSpec<org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.embeddings.graphsage.ModelData,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.embeddings.graphsage.GraphSageModelTrainer.GraphSageTrainMetrics>,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​java.util.stream.Stream<org.neo4j.gds.TrainProc.TrainResult>,​org.neo4j.gds.AlgorithmFactory<?,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrain,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig>>
    public class GraphSageTrainProc
extends org.neo4j.gds.TrainProc<org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.embeddings.graphsage.ModelData,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.embeddings.graphsage.GraphSageModelTrainer.GraphSageTrainMetrics>,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.TrainProc.TrainResult>

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.neo4j.gds.TrainProc

        org.neo4j.gds.TrainProc.TrainingConfigValidation<TRAIN_CONFIG extends org.neo4j.gds.model.ModelConfig & org.neo4j.gds.config.AlgoBaseConfig>, org.neo4j.gds.TrainProc.TrainResult

    • Field Summary

      • Fields inherited from class org.neo4j.gds.AlgoBaseProc

        STATS_DESCRIPTION

      • Fields inherited from class org.neo4j.gds.BaseProc

        api, callContext, ESTIMATE_DESCRIPTION, internalModelCatalog, log, procedureTransaction, taskRegistryFactory, transaction, userLogRegistryFactory, username

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.neo4j.gds.GraphAlgorithmFactory<org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrain,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig> algorithmFactory()  
      protected org.neo4j.gds.TrainProc.TrainResult constructProcResult​(org.neo4j.gds.executor.ComputationResult<org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.embeddings.graphsage.ModelData,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.embeddings.graphsage.GraphSageModelTrainer.GraphSageTrainMetrics>,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig> computationResult)  
      java.util.stream.Stream<org.neo4j.gds.results.MemoryEstimateResult> estimate​(java.lang.Object graphNameOrConfiguration, java.util.Map<java.lang.String,​java.lang.Object> algoConfiguration)  
      protected org.neo4j.gds.core.model.Model<?,​?,​?> extractModel​(org.neo4j.gds.core.model.Model<org.neo4j.gds.embeddings.graphsage.ModelData,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.embeddings.graphsage.GraphSageModelTrainer.GraphSageTrainMetrics> model)  
      protected java.lang.String modelType()  
      protected org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig newConfig​(java.lang.String username, org.neo4j.gds.core.CypherMapWrapper config)  
      java.util.stream.Stream<org.neo4j.gds.TrainProc.TrainResult> train​(java.lang.String graphName, java.util.Map<java.lang.String,​java.lang.Object> configuration)  
      org.neo4j.gds.executor.validation.ValidationConfiguration<org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig> validationConfig()  

      • Methods inherited from class org.neo4j.gds.TrainProc

        computationResultConsumer, trainAndStoreModelWithResult, withModelCatalog

      • Methods inherited from class org.neo4j.gds.AlgoBaseProc

        compute, compute, computeEstimate, configParser, name, newConfigFunction, nodeProperties

      • Methods inherited from class org.neo4j.gds.BaseProc

        databaseId, executionContext, graphLoaderContext, graphStoreFromCatalog, isGdsAdmin, memoryUsageValidator, modelCatalog, runWithExceptionLogging, runWithExceptionLogging, setModelCatalog, username, validateConfig, validateConfig, validateGraphName

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface org.neo4j.gds.executor.AlgorithmSpec

        createDefaultExecutorSpec

    • Constructor Detail

      • GraphSageTrainProc

        public GraphSageTrainProc()

    • Method Detail

      • train

        public java.util.stream.Stream<org.neo4j.gds.TrainProc.TrainResult> train​(java.lang.String graphName,
                                                                          java.util.Map<java.lang.String,​java.lang.Object> configuration)

      • estimate

        public java.util.stream.Stream<org.neo4j.gds.results.MemoryEstimateResult> estimate​(java.lang.Object graphNameOrConfiguration,
                                                                                    java.util.Map<java.lang.String,​java.lang.Object> algoConfiguration)

      • newConfig

        protected org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig newConfig​(java.lang.String username,
                                                                                 org.neo4j.gds.core.CypherMapWrapper config)
        Specified by:
        newConfig in class org.neo4j.gds.AlgoBaseProc<org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.embeddings.graphsage.ModelData,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.embeddings.graphsage.GraphSageModelTrainer.GraphSageTrainMetrics>,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.TrainProc.TrainResult>

      • algorithmFactory

        public org.neo4j.gds.GraphAlgorithmFactory<org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrain,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig> algorithmFactory()

      • modelType

        protected java.lang.String modelType()
        Specified by:
        modelType in class org.neo4j.gds.TrainProc<org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.embeddings.graphsage.ModelData,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.embeddings.graphsage.GraphSageModelTrainer.GraphSageTrainMetrics>,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.TrainProc.TrainResult>

      • constructProcResult

        protected org.neo4j.gds.TrainProc.TrainResult constructProcResult​(org.neo4j.gds.executor.ComputationResult<org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.embeddings.graphsage.ModelData,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.embeddings.graphsage.GraphSageModelTrainer.GraphSageTrainMetrics>,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig> computationResult)
        Specified by:
        constructProcResult in class org.neo4j.gds.TrainProc<org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.embeddings.graphsage.ModelData,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.embeddings.graphsage.GraphSageModelTrainer.GraphSageTrainMetrics>,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.TrainProc.TrainResult>

      • extractModel

        protected org.neo4j.gds.core.model.Model<?,​?,​?> extractModel​(org.neo4j.gds.core.model.Model<org.neo4j.gds.embeddings.graphsage.ModelData,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.embeddings.graphsage.GraphSageModelTrainer.GraphSageTrainMetrics> model)
        Specified by:
        extractModel in class org.neo4j.gds.TrainProc<org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.embeddings.graphsage.ModelData,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.embeddings.graphsage.GraphSageModelTrainer.GraphSageTrainMetrics>,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.TrainProc.TrainResult>

      • validationConfig

        public org.neo4j.gds.executor.validation.ValidationConfiguration<org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig> validationConfig()
        Specified by:
        validationConfig in interface org.neo4j.gds.executor.AlgorithmSpec<org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.embeddings.graphsage.ModelData,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.embeddings.graphsage.GraphSageModelTrainer.GraphSageTrainMetrics>,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​java.util.stream.Stream<org.neo4j.gds.TrainProc.TrainResult>,​org.neo4j.gds.AlgorithmFactory<?,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrain,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig>>
        Overrides:
        validationConfig in class org.neo4j.gds.TrainProc<org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.embeddings.graphsage.ModelData,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.embeddings.graphsage.GraphSageModelTrainer.GraphSageTrainMetrics>,​org.neo4j.gds.embeddings.graphsage.algo.GraphSageTrainConfig,​org.neo4j.gds.TrainProc.TrainResult>