Package org.neo4j.gds.ml.linkmodels.pipeline.predict

Interface LinkPredictionPredictPipelineBaseConfig

  • All Superinterfaces:
    org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.BaseConfig, org.neo4j.gds.config.ConcurrencyConfig, org.neo4j.gds.config.GraphNameConfig, org.neo4j.gds.config.JobIdConfig, org.neo4j.gds.model.ModelConfig, org.neo4j.gds.config.RandomSeedConfig, java.io.Serializable, org.neo4j.gds.config.SingleThreadedRandomSeedConfig, org.neo4j.gds.config.ToMapConvertible
    All Known Subinterfaces:
    LinkPredictionPredictPipelineMutateConfig, LinkPredictionPredictPipelineStreamConfig
    @Configuration
public interface LinkPredictionPredictPipelineBaseConfig
extends org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.GraphNameConfig, org.neo4j.gds.config.SingleThreadedRandomSeedConfig, org.neo4j.gds.model.ModelConfig

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static double DEFAULT_THRESHOLD  

      • 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, serialVersionUID

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default org.neo4j.gds.similarity.knn.KnnBaseConfig approximateConfig()  
      java.util.Optional<java.lang.Double> deltaThreshold()  
      default java.util.Optional<org.neo4j.gds.similarity.knn.KnnSampler.SamplerType> derivedInitialSampler()  
      java.util.Optional<java.lang.String> initialSampler()  
      default boolean isApproximateStrategy()  
      java.util.Optional<java.lang.Integer> maxIterations()  
      default java.util.List<java.lang.String> nodeLabels()  
      java.util.Optional<java.lang.Integer> randomJoins()  
      default java.util.List<java.lang.String> relationshipTypes()  
      default double sampleRate()  
      java.util.Optional<java.lang.String> sourceNodeLabel()  
      java.util.Optional<java.lang.String> targetNodeLabel()  
      java.util.Optional<java.lang.Double> threshold()  
      default double thresholdOrDefault()  
      java.util.Optional<java.lang.Integer> topK()  
      java.util.Optional<java.lang.Integer> topN()  
      default void validateParameterCombinations()  
      default void validateRelationshipTypes​(org.neo4j.gds.api.GraphStore graphStore, java.util.Collection<org.neo4j.gds.NodeLabel> selectedLabels, java.util.Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)  
      default void validateSourceNodeLabel​(org.neo4j.gds.api.GraphStore graphStore, java.util.Collection<org.neo4j.gds.NodeLabel> selectedLabels, java.util.Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)  
      default void validateStrategySpecificParameters​(java.util.Map<java.lang.String,​java.lang.Boolean> forbiddenParameters, java.lang.String errorMsg)  
      default void validateTargetNodeLabel​(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, validateNodeLabels

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

        configKeys, logProgress, sudo, toMap, usernameOverride

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

        concurrency, minBatchSize, validateConcurrency

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

        graphName

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

        validate

    • Method Detail

      • sampleRate

        @Default
@DoubleRange(min=0.0,
             max=1.0,
             minInclusive=false)
default double sampleRate()

      • sourceNodeLabel

        java.util.Optional<java.lang.String> sourceNodeLabel()

      • targetNodeLabel

        java.util.Optional<java.lang.String> targetNodeLabel()

      • relationshipTypes

        default java.util.List<java.lang.String> relationshipTypes()
        Specified by:
        relationshipTypes in interface org.neo4j.gds.config.AlgoBaseConfig

      • nodeLabels

        @Ignore
default java.util.List<java.lang.String> nodeLabels()
        Specified by:
        nodeLabels in interface org.neo4j.gds.config.AlgoBaseConfig

      • validateSourceNodeLabel

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

      • validateTargetNodeLabel

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

      • validateRelationshipTypes

        @GraphStoreValidationCheck
default void validateRelationshipTypes​(org.neo4j.gds.api.GraphStore graphStore,
                                       java.util.Collection<org.neo4j.gds.NodeLabel> selectedLabels,
                                       java.util.Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)
        Specified by:
        validateRelationshipTypes in interface org.neo4j.gds.config.AlgoBaseConfig

      • topN

        @IntegerRange(min=1)
java.util.Optional<java.lang.Integer> topN()

      • threshold

        @DoubleRange(min=0.0,
             max=1.0)
java.util.Optional<java.lang.Double> threshold()

      • topK

        @IntegerRange(min=1)
java.util.Optional<java.lang.Integer> topK()

      • deltaThreshold

        @DoubleRange(min=0.0,
             max=1.0)
java.util.Optional<java.lang.Double> deltaThreshold()

      • maxIterations

        @IntegerRange(min=1)
java.util.Optional<java.lang.Integer> maxIterations()

      • randomJoins

        @IntegerRange(min=0)
java.util.Optional<java.lang.Integer> randomJoins()

      • initialSampler

        java.util.Optional<java.lang.String> initialSampler()

      • derivedInitialSampler

        @Derived
@Ignore
default java.util.Optional<org.neo4j.gds.similarity.knn.KnnSampler.SamplerType> derivedInitialSampler()

      • validateParameterCombinations

        @Check
default void validateParameterCombinations()

      • validateStrategySpecificParameters

        @Ignore
default void validateStrategySpecificParameters​(java.util.Map<java.lang.String,​java.lang.Boolean> forbiddenParameters,
                                                java.lang.String errorMsg)

      • approximateConfig

        @Ignore
@Derived
default org.neo4j.gds.similarity.knn.KnnBaseConfig approximateConfig()

      • thresholdOrDefault

        @Ignore
@Derived
default double thresholdOrDefault()

      • isApproximateStrategy

        @Ignore
@Derived
default boolean isApproximateStrategy()