Package org.neo4j.gds.ml.splitting

Interface SplitRelationshipsBaseConfig

All Superinterfaces:
org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.BaseConfig, org.neo4j.gds.config.ConcurrencyConfig, org.neo4j.gds.config.JobIdConfig, org.neo4j.gds.config.RandomSeedConfig, org.neo4j.gds.config.RelationshipWeightConfig, org.neo4j.gds.config.ToMapConvertible
All Known Subinterfaces:
SplitRelationshipsMutateConfig
@Configuration public interface SplitRelationshipsBaseConfig extends org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.RandomSeedConfig, org.neo4j.gds.config.RelationshipWeightConfig

  • 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.config.RelationshipWeightConfig

    RELATIONSHIP_WEIGHT_PROPERTY

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    holdoutFraction()
     
    org.neo4j.gds.RelationshipType
    holdoutRelationshipType()
     
    double
    negativeSamplingRatio()
     
    default List<String>
    nodeLabels()
     
    default List<String>
    nonNegativeRelationshipTypes()
     
    org.neo4j.gds.RelationshipType
    remainingRelationshipType()
     
    default List<String>
    sourceNodeLabels()
     
    default List<String>
    superRelationshipTypes()
     
    default List<String>
    targetNodeLabels()
     
    default void
    validateHoldOutRelType(org.neo4j.gds.api.GraphStore graphStore, Collection<org.neo4j.gds.NodeLabel> selectedLabels, Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)
     
    default void
    validateNonNegativeRelTypesExist(org.neo4j.gds.api.GraphStore graphStore, Collection<org.neo4j.gds.NodeLabel> selectedLabels, Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)
     
    default void
    validateRemainingRelType(org.neo4j.gds.api.GraphStore graphStore, Collection<org.neo4j.gds.NodeLabel> selectedLabels, Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)
     
    default void
    validateTypeDoesNotExist(org.neo4j.gds.api.GraphStore graphStore, org.neo4j.gds.RelationshipType type, String name)
     

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

    graphStoreValidation, internalRelationshipTypes, nodeLabelIdentifiers, nodeLabelsFilter, projectAllRelationshipTypes, relationshipTypes, relationshipTypesFilter, 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, validateConcurrency

    Methods inherited from interface org.neo4j.gds.config.JobIdConfig

    jobId

    Methods inherited from interface org.neo4j.gds.config.RandomSeedConfig

    randomSeed

    Methods inherited from interface org.neo4j.gds.config.RelationshipWeightConfig

    hasRelationshipWeightProperty, relationshipWeightProperty, relationshipWeightValidation, validateRelationshipWeightProperty

  • Method Details

    • holdoutFraction

      @DoubleRange(min=0.0, minInclusive=false) double holdoutFraction()

    • negativeSamplingRatio

      @DoubleRange(min=0.0) double negativeSamplingRatio()

    • sourceNodeLabels

      default List<String> sourceNodeLabels()

    • targetNodeLabels

      default List<String> targetNodeLabels()

    • nodeLabels

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

    • holdoutRelationshipType

      @ConvertWith(method="org.neo4j.gds.RelationshipType#of", inverse="__USE_TO_MAP_METHOD__") @ToMapValue("org.neo4j.gds.RelationshipType#toString") org.neo4j.gds.RelationshipType holdoutRelationshipType()

    • remainingRelationshipType

      @ConvertWith(method="org.neo4j.gds.RelationshipType#of", inverse="__USE_TO_MAP_METHOD__") @ToMapValue("org.neo4j.gds.RelationshipType#toString") org.neo4j.gds.RelationshipType remainingRelationshipType()

    • nonNegativeRelationshipTypes

      @Default default List<String> nonNegativeRelationshipTypes()

    • superRelationshipTypes

      @Ignore @Derived default List<String> superRelationshipTypes()

    • validateRemainingRelType

      @GraphStoreValidationCheck @Default default void validateRemainingRelType(org.neo4j.gds.api.GraphStore graphStore, Collection<org.neo4j.gds.NodeLabel> selectedLabels, Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)

    • validateHoldOutRelType

      @GraphStoreValidationCheck @Default default void validateHoldOutRelType(org.neo4j.gds.api.GraphStore graphStore, Collection<org.neo4j.gds.NodeLabel> selectedLabels, Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)

    • validateNonNegativeRelTypesExist

      @GraphStoreValidationCheck @Default default void validateNonNegativeRelTypesExist(org.neo4j.gds.api.GraphStore graphStore, Collection<org.neo4j.gds.NodeLabel> selectedLabels, Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)

    • validateTypeDoesNotExist

      @Ignore default void validateTypeDoesNotExist(org.neo4j.gds.api.GraphStore graphStore, org.neo4j.gds.RelationshipType type, String name)