Package org.neo4j.gds.ml.pipeline

Class Pipeline<FEATURE_STEP extends FeatureStep>

java.lang.Object

org.neo4j.gds.ml.pipeline.Pipeline<FEATURE_STEP>

All Implemented Interfaces:

org.neo4j.gds.config.ToMapConvertible

Direct Known Subclasses:

LinkPredictionPipeline, NodeClassificationPipeline

public abstract class Pipeline<FEATURE_STEP extends FeatureStep>
extends java.lang.Object
implements org.neo4j.gds.config.ToMapConvertible

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<FEATURE_STEP>	featureSteps
protected java.util.List<ExecutableNodePropertyStep>	nodePropertySteps
protected java.util.Map<org.neo4j.gds.models.TrainingMethod,java.util.List<org.neo4j.gds.models.TrainerConfig>>	trainingParameterSpace

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Pipeline()

Method Summary

Modifier and Type	Method	Description
void	addFeatureStep(FEATURE_STEP featureStep)
protected abstract java.util.Map<java.lang.String,java.lang.Object>	additionalEntries()
void	addNodePropertyStep(NodePropertyStep step)
void	addTrainerConfig(org.neo4j.gds.models.TrainingMethod method, org.neo4j.gds.models.TrainerConfig trainingConfigs)
java.time.ZonedDateTime	creationTime()
protected abstract java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>>	featurePipelineDescription()
java.util.List<FEATURE_STEP>	featureSteps()
java.util.List<ExecutableNodePropertyStep>	nodePropertySteps()
int	numberOfModelCandidates()
void	setTrainingParameterSpace(org.neo4j.gds.models.TrainingMethod method, java.util.List<org.neo4j.gds.models.TrainerConfig> trainingConfigs)
java.util.Map<java.lang.String,java.lang.Object>	toMap()
static java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>>	toMapParameterSpace(java.util.Map<org.neo4j.gds.models.TrainingMethod,java.util.List<org.neo4j.gds.models.TrainerConfig>> parameterSpace)
java.util.Map<org.neo4j.gds.models.TrainingMethod,java.util.List<org.neo4j.gds.models.TrainerConfig>>	trainingParameterSpace()
abstract java.lang.String	type()
void	validateBeforeExecution(org.neo4j.gds.api.GraphStore graphStore, org.neo4j.gds.config.AlgoBaseConfig config)
void	validateFeatureProperties(org.neo4j.gds.api.GraphStore graphStore, org.neo4j.gds.config.AlgoBaseConfig config)

Methods inherited from class java.lang.Object

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

Field Detail

nodePropertySteps

protected final java.util.List<ExecutableNodePropertyStep> nodePropertySteps

featureSteps

protected final java.util.List<FEATURE_STEP extends FeatureStep> featureSteps

trainingParameterSpace

protected java.util.Map<org.neo4j.gds.models.TrainingMethod,java.util.List<org.neo4j.gds.models.TrainerConfig>> trainingParameterSpace

Constructor Detail

Pipeline

protected Pipeline()

Method Detail

toMapParameterSpace

public static java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>> toMapParameterSpace(java.util.Map<org.neo4j.gds.models.TrainingMethod,java.util.List<org.neo4j.gds.models.TrainerConfig>> parameterSpace)

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

Specified by:

toMap in interface org.neo4j.gds.config.ToMapConvertible

type

public abstract java.lang.String type()

featurePipelineDescription

protected abstract java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>> featurePipelineDescription()

additionalEntries

protected abstract java.util.Map<java.lang.String,java.lang.Object> additionalEntries()

validateFeatureProperties

public void validateFeatureProperties(org.neo4j.gds.api.GraphStore graphStore,
                                      org.neo4j.gds.config.AlgoBaseConfig config)

validateBeforeExecution

public void validateBeforeExecution(org.neo4j.gds.api.GraphStore graphStore,
                                    org.neo4j.gds.config.AlgoBaseConfig config)

numberOfModelCandidates

public int numberOfModelCandidates()

addNodePropertyStep

public void addNodePropertyStep(NodePropertyStep step)

addFeatureStep

public void addFeatureStep(FEATURE_STEP featureStep)

nodePropertySteps

public java.util.List<ExecutableNodePropertyStep> nodePropertySteps()

featureSteps

public java.util.List<FEATURE_STEP> featureSteps()

trainingParameterSpace

public java.util.Map<org.neo4j.gds.models.TrainingMethod,java.util.List<org.neo4j.gds.models.TrainerConfig>> trainingParameterSpace()

setTrainingParameterSpace

public void setTrainingParameterSpace(org.neo4j.gds.models.TrainingMethod method,
                                      java.util.List<org.neo4j.gds.models.TrainerConfig> trainingConfigs)

addTrainerConfig

public void addTrainerConfig(org.neo4j.gds.models.TrainingMethod method,
                             org.neo4j.gds.models.TrainerConfig trainingConfigs)

creationTime

public java.time.ZonedDateTime creationTime()