Package org.neo4j.gds.similarity.knn

Interface KnnBaseConfig

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.RandomSeedConfig, org.neo4j.gds.config.SingleThreadedRandomSeedConfig, org.neo4j.gds.config.ToMapConvertible

All Known Subinterfaces:

KnnMutateConfig, KnnStatsConfig, KnnStreamConfig, KnnWriteConfig

@Configuration
public interface KnnBaseConfig
extends org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.IterationsConfig, org.neo4j.gds.config.SingleThreadedRandomSeedConfig

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

SUDO_KEY

Fields inherited from interface org.neo4j.gds.config.ConcurrencyConfig

CONCURRENCY_KEY, CONCURRENCY_LIMITATION, DEFAULT_CONCURRENCY

Method Summary

Modifier and Type	Method	Description
default int	boundedK(long nodeCount)
default double	deltaThreshold()
default KnnSampler.SamplerType	initialSampler()
default int	maxIterations()
default int	minBatchSize()
java.util.List<KnnNodePropertySpec>	nodeProperties()
default double	perturbationRate()
default int	randomJoins()
default int	sampledK(long nodeCount)
default double	sampleRate()
default double	similarityCutoff()
default int	topK()
static @Nullable java.util.List<java.lang.String>	validatePropertyNames(java.util.List<java.lang.String> input)

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

graphStoreValidation, internalRelationshipTypes, nodeLabelIdentifiers, nodeLabels, relationshipTypes

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

configKeys, sudo, toMap, usernameOverride

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

concurrency, validateConcurrency

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

randomSeed

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

validate

Method Detail

nodeProperties

@ConvertWith("org.neo4j.gds.similarity.knn.KnnNodePropertySpecParser#parse")
@ToMapValue("org.neo4j.gds.similarity.knn.KnnNodePropertySpecParser#render")
java.util.List<KnnNodePropertySpec> nodeProperties()

topK

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

sampleRate

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

perturbationRate

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

deltaThreshold

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

similarityCutoff

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

maxIterations

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

Specified by:

maxIterations in interface org.neo4j.gds.config.IterationsConfig

minBatchSize

@Default
@Ignore
default int minBatchSize()

Specified by:

minBatchSize in interface org.neo4j.gds.config.ConcurrencyConfig

randomJoins

@Default
@IntegerRange(min=0)
default int randomJoins()

sampledK

@Ignore
default int sampledK(long nodeCount)

boundedK

@Ignore
default int boundedK(long nodeCount)

initialSampler

@Default
@ConvertWith("org.neo4j.gds.similarity.knn.KnnSampler.SamplerType#parse")
@ToMapValue("org.neo4j.gds.similarity.knn.KnnSampler.SamplerType#toString")
default KnnSampler.SamplerType initialSampler()

validatePropertyNames

@Nullable
static @Nullable java.util.List<java.lang.String> validatePropertyNames(java.util.List<java.lang.String> input)