Package org.neo4j.gds.ml.pipeline

Class PipelineExecutor<PIPELINE_CONFIG extends org.neo4j.gds.config.AlgoBaseConfig,PIPELINE extends Pipeline<?>,RESULT>

java.lang.Object

org.neo4j.gds.Algorithm<RESULT>

org.neo4j.gds.ml.pipeline.PipelineExecutor<PIPELINE_CONFIG,PIPELINE,RESULT>

public abstract class PipelineExecutor<PIPELINE_CONFIG extends org.neo4j.gds.config.AlgoBaseConfig,PIPELINE extends Pipeline<?>,RESULT>
extends org.neo4j.gds.Algorithm<RESULT>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PipelineExecutor.DatasetSplits
static interface	PipelineExecutor.GraphFilter

Field Summary

Fields

Modifier and Type	Field	Description
protected PIPELINE_CONFIG	config
protected org.neo4j.gds.executor.ExecutionContext	executionContext
protected java.lang.String	graphName
protected org.neo4j.gds.api.GraphStore	graphStore
protected PIPELINE	pipeline

Fields inherited from class org.neo4j.gds.Algorithm

progressTracker, terminationFlag

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PipelineExecutor(PIPELINE pipeline, PIPELINE_CONFIG config, org.neo4j.gds.executor.ExecutionContext executionContext, org.neo4j.gds.api.GraphStore graphStore, java.lang.String graphName, org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker)

Method Summary

Modifier and Type	Method	Description
protected void	cleanUpGraphStore(java.util.Map<PipelineExecutor.DatasetSplits,PipelineExecutor.GraphFilter> datasets)
RESULT	compute()
static org.neo4j.gds.core.utils.mem.MemoryEstimation	estimateNodePropertySteps(org.neo4j.gds.core.model.ModelCatalog modelCatalog, java.util.List<ExecutableNodePropertyStep> nodePropertySteps, java.util.List<java.lang.String> nodeLabels, java.util.List<java.lang.String> relationshipTypes)
protected abstract RESULT	execute(java.util.Map<PipelineExecutor.DatasetSplits,PipelineExecutor.GraphFilter> dataSplits)
void	release()
abstract java.util.Map<PipelineExecutor.DatasetSplits,PipelineExecutor.GraphFilter>	splitDataset()
protected void	validate(org.neo4j.gds.api.GraphStore graphStore, PIPELINE_CONFIG config)
static void	validateTrainingParameterSpace(Pipeline pipeline)

Methods inherited from class org.neo4j.gds.Algorithm

getProgressTracker, getTerminationFlag, setTerminationFlag

Methods inherited from class java.lang.Object

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

Field Detail

pipeline

protected final PIPELINE extends Pipeline<?> pipeline

config

protected final PIPELINE_CONFIG extends org.neo4j.gds.config.AlgoBaseConfig config

executionContext

protected final org.neo4j.gds.executor.ExecutionContext executionContext

graphStore

protected final org.neo4j.gds.api.GraphStore graphStore

graphName

protected final java.lang.String graphName

Constructor Detail

PipelineExecutor

protected PipelineExecutor(PIPELINE pipeline,
                           PIPELINE_CONFIG config,
                           org.neo4j.gds.executor.ExecutionContext executionContext,
                           org.neo4j.gds.api.GraphStore graphStore,
                           java.lang.String graphName,
                           org.neo4j.gds.core.utils.progress.tasks.ProgressTracker progressTracker)

Method Detail

estimateNodePropertySteps

public static org.neo4j.gds.core.utils.mem.MemoryEstimation estimateNodePropertySteps(org.neo4j.gds.core.model.ModelCatalog modelCatalog,
                                                                                      java.util.List<ExecutableNodePropertyStep> nodePropertySteps,
                                                                                      java.util.List<java.lang.String> nodeLabels,
                                                                                      java.util.List<java.lang.String> relationshipTypes)

validateTrainingParameterSpace

public static void validateTrainingParameterSpace(Pipeline pipeline)

splitDataset

public abstract java.util.Map<PipelineExecutor.DatasetSplits,PipelineExecutor.GraphFilter> splitDataset()

execute

protected abstract RESULT execute(java.util.Map<PipelineExecutor.DatasetSplits,PipelineExecutor.GraphFilter> dataSplits)

compute

public RESULT compute()

Specified by:

compute in class org.neo4j.gds.Algorithm<RESULT>

validate

protected void validate(org.neo4j.gds.api.GraphStore graphStore,
                        PIPELINE_CONFIG config)

release

public void release()

Specified by:

release in class org.neo4j.gds.Algorithm<RESULT>

cleanUpGraphStore

protected void cleanUpGraphStore(java.util.Map<PipelineExecutor.DatasetSplits,PipelineExecutor.GraphFilter> datasets)