Package org.neo4j.gds.ml.linkmodels

Class LinkPredictionTrainProc

  • All Implemented Interfaces:
    org.neo4j.gds.executor.AlgorithmSpec<org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.ml.linkmodels.logisticregression.LinkLogisticRegressionData,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​org.neo4j.gds.ml.linkmodels.LinkPredictionModelInfo>,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​java.util.stream.Stream<MLTrainResult>,​org.neo4j.gds.AlgorithmFactory<?,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig>>
    public class LinkPredictionTrainProc
extends org.neo4j.gds.TrainProc<org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.ml.linkmodels.logisticregression.LinkLogisticRegressionData,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​org.neo4j.gds.ml.linkmodels.LinkPredictionModelInfo>,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​MLTrainResult>

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

        modelCatalog

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

        STATS_DESCRIPTION

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

        allocationTracker, api, callContext, ESTIMATE_DESCRIPTION, 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.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig> algorithmFactory()  
      protected MLTrainResult constructProcResult​(org.neo4j.gds.executor.ComputationResult<org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.ml.linkmodels.logisticregression.LinkLogisticRegressionData,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​org.neo4j.gds.ml.linkmodels.LinkPredictionModelInfo>,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig> 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.ml.linkmodels.logisticregression.LinkLogisticRegressionData,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​org.neo4j.gds.ml.linkmodels.LinkPredictionModelInfo> algoResult)  
      protected java.lang.String modelType()  
      protected org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig newConfig​(java.lang.String username, org.neo4j.gds.core.CypherMapWrapper config)  
      java.util.stream.Stream<MLTrainResult> train​(java.lang.String graphName, java.util.Map<java.lang.String,​java.lang.Object> configuration)  
      org.neo4j.gds.executor.validation.ValidationConfiguration<org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig> validationConfig()  

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

        computationResultConsumer, trainAndStoreModelWithResult

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

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

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

        allocationTracker, databaseId, executionContext, graphLoaderContext, graphStoreFromCatalog, isGdsAdmin, memoryUsageValidator, runWithExceptionLogging, runWithExceptionLogging, username, validateConfig, validateConfig, validateGraphName

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • LinkPredictionTrainProc

        public LinkPredictionTrainProc()

    • Method Detail

      • train

        public java.util.stream.Stream<MLTrainResult> 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.ml.linkmodels.LinkPredictionTrainConfig newConfig​(java.lang.String username,
                                                                          org.neo4j.gds.core.CypherMapWrapper config)
        Specified by:
        newConfig in class org.neo4j.gds.AlgoBaseProc<org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.ml.linkmodels.logisticregression.LinkLogisticRegressionData,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​org.neo4j.gds.ml.linkmodels.LinkPredictionModelInfo>,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​MLTrainResult>

      • modelType

        protected java.lang.String modelType()
        Specified by:
        modelType in class org.neo4j.gds.TrainProc<org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.ml.linkmodels.logisticregression.LinkLogisticRegressionData,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​org.neo4j.gds.ml.linkmodels.LinkPredictionModelInfo>,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​MLTrainResult>

      • constructProcResult

        protected MLTrainResult constructProcResult​(org.neo4j.gds.executor.ComputationResult<org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.ml.linkmodels.logisticregression.LinkLogisticRegressionData,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​org.neo4j.gds.ml.linkmodels.LinkPredictionModelInfo>,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig> computationResult)
        Specified by:
        constructProcResult in class org.neo4j.gds.TrainProc<org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.ml.linkmodels.logisticregression.LinkLogisticRegressionData,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​org.neo4j.gds.ml.linkmodels.LinkPredictionModelInfo>,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​MLTrainResult>

      • extractModel

        protected org.neo4j.gds.core.model.Model<?,​?,​?> extractModel​(org.neo4j.gds.core.model.Model<org.neo4j.gds.ml.linkmodels.logisticregression.LinkLogisticRegressionData,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​org.neo4j.gds.ml.linkmodels.LinkPredictionModelInfo> algoResult)
        Specified by:
        extractModel in class org.neo4j.gds.TrainProc<org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.ml.linkmodels.logisticregression.LinkLogisticRegressionData,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​org.neo4j.gds.ml.linkmodels.LinkPredictionModelInfo>,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​MLTrainResult>

      • validationConfig

        public org.neo4j.gds.executor.validation.ValidationConfiguration<org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig> validationConfig()
        Specified by:
        validationConfig in interface org.neo4j.gds.executor.AlgorithmSpec<org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.ml.linkmodels.logisticregression.LinkLogisticRegressionData,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​org.neo4j.gds.ml.linkmodels.LinkPredictionModelInfo>,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​java.util.stream.Stream<MLTrainResult>,​org.neo4j.gds.AlgorithmFactory<?,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig>>
        Overrides:
        validationConfig in class org.neo4j.gds.TrainProc<org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.ml.linkmodels.logisticregression.LinkLogisticRegressionData,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​org.neo4j.gds.ml.linkmodels.LinkPredictionModelInfo>,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​MLTrainResult>

      • algorithmFactory

        public org.neo4j.gds.GraphAlgorithmFactory<org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig> algorithmFactory()
        Specified by:
        algorithmFactory in interface org.neo4j.gds.executor.AlgorithmSpec<org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.ml.linkmodels.logisticregression.LinkLogisticRegressionData,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​org.neo4j.gds.ml.linkmodels.LinkPredictionModelInfo>,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​java.util.stream.Stream<MLTrainResult>,​org.neo4j.gds.AlgorithmFactory<?,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig>>
        Specified by:
        algorithmFactory in class org.neo4j.gds.AlgoBaseProc<org.neo4j.gds.ml.linkmodels.LinkPredictionTrain,​org.neo4j.gds.core.model.Model<org.neo4j.gds.ml.linkmodels.logisticregression.LinkLogisticRegressionData,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​org.neo4j.gds.ml.linkmodels.LinkPredictionModelInfo>,​org.neo4j.gds.ml.linkmodels.LinkPredictionTrainConfig,​MLTrainResult>