Package org.neo4j.gds.graphsampling.config

Interface RandomWalkWithRestartsConfig

All Superinterfaces:

org.neo4j.gds.config.AlgoBaseConfig, org.neo4j.gds.config.BaseConfig, org.neo4j.gds.config.ConcurrencyConfig, org.neo4j.gds.config.GraphSampleAlgoConfig, org.neo4j.gds.config.JobIdConfig, org.neo4j.gds.config.RandomSeedConfig, org.neo4j.gds.config.RelationshipWeightConfig, org.neo4j.gds.config.SingleThreadedRandomSeedConfig, org.neo4j.gds.config.ToMapConvertible

All Known Subinterfaces:

CommonNeighbourAwareRandomWalkConfig

@Configuration
public interface RandomWalkWithRestartsConfig
extends org.neo4j.gds.config.GraphSampleAlgoConfig, 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

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
default boolean	nodeLabelStratification()
static RandomWalkWithRestartsConfig	of(org.neo4j.gds.core.CypherMapWrapper procedureConfig)
static List<Long>	parseStartNodes(Object input)
default double	restartProbability()
default double	samplingRatio()	The ratio of nodes that we wish to sample.
default List<Long>	startNodes()

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

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

outputFieldDenylist

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

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

validate

Method Details

startNodes

@Default
@ConvertWith(method="org.neo4j.gds.graphsampling.config.RandomWalkWithRestartsConfig#parseStartNodes")
default List<Long> startNodes()

restartProbability

@DoubleRange(min=0.0,
             max=1.0,
             minInclusive=false,
             maxInclusive=false)
default double restartProbability()

samplingRatio

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

The ratio of nodes that we wish to sample.

nodeLabelStratification

default boolean nodeLabelStratification()

parseStartNodes

static List<Long> parseStartNodes(Object input)

of

static RandomWalkWithRestartsConfig of(org.neo4j.gds.core.CypherMapWrapper procedureConfig)