Package org.neo4j.gds.ml.pipeline.linkPipeline.train

Interface LinkPredictionTrainConfig

  • 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.ToMapConvertible
    @Configuration
public interface LinkPredictionTrainConfig
extends org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.GraphNameConfig, org.neo4j.gds.model.ModelConfig, org.neo4j.gds.config.RandomSeedConfig

    • Field Summary

      • 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 Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default org.neo4j.gds.RelationshipType internalTargetRelationshipType()  
      default java.util.List<org.neo4j.gds.ml.metrics.LinkMetric> linkMetrics()  
      default org.neo4j.gds.ml.metrics.Metric mainMetric()  
      default java.util.List<org.neo4j.gds.ml.metrics.Metric> metrics()  
      static java.util.List<java.lang.String> metricsToNames​(java.util.List<org.neo4j.gds.ml.metrics.Metric> metrics)  
      static java.util.List<org.neo4j.gds.ml.metrics.Metric> namesToMetrics​(java.util.List<?> names)  
      default double negativeClassWeight()  
      default java.util.List<java.lang.String> nodeLabels()  
      static LinkPredictionTrainConfig of​(java.lang.String username, org.neo4j.gds.core.CypherMapWrapper config)  
      java.lang.String pipeline()  
      default java.util.List<java.lang.String> relationshipTypes()  
      default java.lang.String sourceNodeLabel()  
      default java.lang.String targetNodeLabel()  
      java.lang.String targetRelationshipType()  
      default void validate()  
      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 validateTargetNodeLabel​(org.neo4j.gds.api.GraphStore graphStore, java.util.Collection<org.neo4j.gds.NodeLabel> selectedLabels, java.util.Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)  
      default void validateTargetRelIsUndirected​(org.neo4j.gds.api.GraphStore graphStore, java.util.Collection<org.neo4j.gds.NodeLabel> ignoredNL, java.util.Collection<org.neo4j.gds.RelationshipType> ignoredRT)  

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

        graphStoreValidation, internalRelationshipTypes, nodeLabelIdentifiers, validateNodeLabels, validateRelationshipTypes

      • 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

    • Method Detail

      • negativeClassWeight

        @Default
@DoubleRange(min=0.0,
             minInclusive=false)
default double negativeClassWeight()

      • pipeline

        java.lang.String pipeline()

      • targetRelationshipType

        java.lang.String targetRelationshipType()

      • sourceNodeLabel

        default java.lang.String sourceNodeLabel()

      • targetNodeLabel

        default java.lang.String targetNodeLabel()

      • relationshipTypes

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

      • validate

        @Check
default void validate()

      • internalTargetRelationshipType

        @Ignore
default org.neo4j.gds.RelationshipType internalTargetRelationshipType()

      • nodeLabels

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

      • metrics

        @ConvertWith(method="org.neo4j.gds.ml.pipeline.linkPipeline.train.LinkPredictionTrainConfig#namesToMetrics")
@ToMapValue("org.neo4j.gds.ml.pipeline.linkPipeline.train.LinkPredictionTrainConfig#metricsToNames")
default java.util.List<org.neo4j.gds.ml.metrics.Metric> metrics()

      • mainMetric

        @Ignore
default org.neo4j.gds.ml.metrics.Metric mainMetric()

      • linkMetrics

        @Ignore
default java.util.List<org.neo4j.gds.ml.metrics.LinkMetric> linkMetrics()

      • 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)

      • validateTargetRelIsUndirected

        @GraphStoreValidationCheck
default void validateTargetRelIsUndirected​(org.neo4j.gds.api.GraphStore graphStore,
                                           java.util.Collection<org.neo4j.gds.NodeLabel> ignoredNL,
                                           java.util.Collection<org.neo4j.gds.RelationshipType> ignoredRT)

      • namesToMetrics

        static java.util.List<org.neo4j.gds.ml.metrics.Metric> namesToMetrics​(java.util.List<?> names)

      • metricsToNames

        static java.util.List<java.lang.String> metricsToNames​(java.util.List<org.neo4j.gds.ml.metrics.Metric> metrics)