Package org.neo4j.gds.similarity.filteredknn

Interface FilteredKnnBaseConfig

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

All Known Subinterfaces:

FilteredKnnMutateConfig, FilteredKnnStatsConfig, FilteredKnnStreamConfig, FilteredKnnWriteConfig

@Configuration
public interface FilteredKnnBaseConfig
extends KnnBaseConfig

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

Modifier and Type	Method	Description
default boolean	seedTargetNodes()
default NodeFilterSpec	sourceNodeFilter()
default NodeFilterSpec	targetNodeFilter()
default void	validateSourceNodeFilter(org.neo4j.gds.api.GraphStore graphStore, java.util.Collection<org.neo4j.gds.NodeLabel> selectedLabels, java.util.Collection<org.neo4j.gds.RelationshipType> selectedRelationshipTypes)
default void	validateTargetNodeFilter(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, 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, validateConcurrency

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

jobId

Methods inherited from interface org.neo4j.gds.similarity.knn.KnnBaseConfig

boundedK, deltaThreshold, initialSampler, maxIterations, minBatchSize, nodeProperties, perturbationRate, randomJoins, sampledK, sampleRate, similarityCutoff, topK

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

randomSeed

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

validate

Method Detail

sourceNodeFilter

@Default
@ConvertWith(method="org.neo4j.gds.similarity.filtering.NodeFilterSpecFactory#create")
@ToMapValue("org.neo4j.gds.similarity.filtering.NodeFilterSpecFactory#render")
default NodeFilterSpec sourceNodeFilter()

targetNodeFilter

@Default
@ConvertWith(method="org.neo4j.gds.similarity.filtering.NodeFilterSpecFactory#create")
@ToMapValue("org.neo4j.gds.similarity.filtering.NodeFilterSpecFactory#render")
default NodeFilterSpec targetNodeFilter()

seedTargetNodes

@Default
default boolean seedTargetNodes()

validateSourceNodeFilter

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

validateTargetNodeFilter

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