Package org.neo4j.gds.kmeans

Interface KmeansBaseConfig

  • All Superinterfaces:
    org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.BaseConfig, org.neo4j.gds.config.ConcurrencyConfig, org.neo4j.gds.config.IterationsConfig, org.neo4j.gds.config.JobIdConfig, org.neo4j.gds.config.RandomSeedConfig, org.neo4j.gds.config.ToMapConvertible
    All Known Subinterfaces:
    KmeansMutateConfig, KmeansStatsConfig, KmeansStreamConfig, KmeansWriteConfig
    public interface KmeansBaseConfig
extends org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.IterationsConfig, 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

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default boolean computeSilhouette()  
      default double deltaThreshold()  
      default KmeansSampler.SamplerType initialSampler()  
      default boolean isSeeded()  
      default int k()  
      default int maxIterations()  
      java.lang.String nodeProperty()  
      default void nodePropertyTypeValidation​(org.neo4j.gds.api.GraphStore graphStore, java.util.Collection<org.neo4j.gds.NodeLabel> selectedLabels, java.util.Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)  
      default int numberOfRestarts()  
      default java.util.List<java.util.List<java.lang.Double>> seedCentroids()  

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

        graphStoreValidation, internalRelationshipTypes, nodeLabelIdentifiers, nodeLabels, relationshipTypes, 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.JobIdConfig

        jobId

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

        randomSeed

    • Method Detail

      • maxIterations

        @IntegerRange(min=1)
@Default
default int maxIterations()
        Specified by:
        maxIterations in interface org.neo4j.gds.config.IterationsConfig

      • k

        @Default
@IntegerRange(min=1)
default int k()

      • deltaThreshold

        @Default
@DoubleRange(min=0.0,
             max=1.0)
default double deltaThreshold()

      • numberOfRestarts

        @IntegerRange(min=1)
@Default
default int numberOfRestarts()

      • computeSilhouette

        @Default
default boolean computeSilhouette()

      • nodeProperty

        java.lang.String nodeProperty()

      • nodePropertyTypeValidation

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

      • initialSampler

        @Default
@ConvertWith(method="org.neo4j.gds.kmeans.KmeansSampler.SamplerType#parse")
@ToMapValue("org.neo4j.gds.kmeans.KmeansSampler.SamplerType#toString")
default KmeansSampler.SamplerType initialSampler()

      • seedCentroids

        @Default
default java.util.List<java.util.List<java.lang.Double>> seedCentroids()

      • isSeeded

        @Ignore
@Derived
default boolean isSeeded()