Skip to content

Commit 22b41b7

Browse files
committed
Update random walk docs to beta
1 parent 3691c47 commit 22b41b7

File tree

7 files changed

+22
-14
lines changed

7 files changed

+22
-14
lines changed

doc/antora/content-nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
*** xref:alpha-algorithms/minimum-weight-spanning-tree/index.adoc[]
8181
*** xref:alpha-algorithms/single-source-shortest-path/index.adoc[]
8282
*** xref:alpha-algorithms/all-pairs-shortest-path/index.adoc[]
83-
*** xref:alpha-algorithms/random-walk/index.adoc[]
83+
*** xref:beta-algorithms/random-walk/index.adoc[]
8484
*** xref:algorithms/bfs/index.adoc[]
8585
*** xref:algorithms/dfs/index.adoc[]
8686
** xref:algorithms/linkprediction/index.adoc[]

doc/asciidoc/algorithms/algorithms-path-finding.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ The Neo4j GDS library includes the following path finding algorithms, grouped by
1414
** <<algorithms-dijkstra-single-source, Dijkstra Single-Source>>
1515
** <<algorithms-astar, A*>>
1616
** <<algorithms-yens, Yen's algorithm>>
17+
* Beta
18+
** <<beta-algorithms-random-walk, Random Walk>>
1719
* Alpha
1820
** <<alpha-algorithms-minimum-weight-spanning-tree, Minimum Weight Spanning Tree>>
1921
** <<alpha-algorithms-single-source-shortest-path, Single Source Shortest Path>>
2022
** <<alpha-algorithm-all-pairs-shortest-path, All Pairs Shortest Path>>
21-
** <<alpha-algorithms-random-walk, Random Walk>>
2223
** <<algorithms-bfs, Breadth First Search>>
2324
** <<algorithms-dfs, Depth First Search>>
2425

@@ -30,14 +31,14 @@ include::shortest-path/astar.adoc[leveloffset=+1]
3031

3132
include::shortest-path/yens.adoc[leveloffset=+1]
3233

34+
include::beta/randomWalk/beta-random-walk.adoc[leveloffset=+1]
35+
3336
include::alpha/alpha-minimum-weight-spanning-tree.adoc[leveloffset=+1]
3437

3538
include::alpha/alpha-single-shortest-path.adoc[leveloffset=+1]
3639

3740
include::alpha/alpha-all-pairs-shortest-path.adoc[leveloffset=+1]
3841

39-
include::alpha/randomWalk/alpha-random-walk.adoc[leveloffset=+1]
40-
4142
include::alpha/alpha-bfs.adoc[leveloffset=+1]
4243

4344
include::alpha/alpha-dfs.adoc[leveloffset=+1]

doc/asciidoc/algorithms/alpha/randomWalk/alpha-random-walk.adoc renamed to doc/asciidoc/algorithms/beta/randomWalk/beta-random-walk.adoc

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
[[alpha-algorithms-random-walk]]
2-
[.alpha]
1+
[[beta-algorithms-random-walk]]
2+
[.beta]
33
= Random Walk
44

55
[abstract]
@@ -27,6 +27,12 @@ A relationship property value greater than 1 will increase the likelihood of a r
2727
[NOTE]
2828
To obtain a random walk where the transition probability is independent of the previously visited nodes both the `returnFactor` and the `inOutFactor` can be set to 1.0.
2929

30+
[NOTE]
31+
====
32+
Running this algorithm requires sufficient memory availability.
33+
Before running this algorithm, we recommend that you read <<memory-estimation>>.
34+
====
35+
3036
[[algorithms-random-walk-syntax]]
3137
== Syntax
3238

@@ -39,7 +45,7 @@ To obtain a random walk where the transition probability is independent of the p
3945
.Run RandomWalk in stream mode on a named graph.
4046
[source, cypher, role=noplay]
4147
----
42-
CALL gds.alpha.randomWalk.stream(
48+
CALL gds.beta.randomWalk.stream(
4349
graphName: String,
4450
configuration: Map
4551
) YIELD
@@ -111,7 +117,7 @@ CALL gds.graph.create(
111117
.Run the RandomWalk algorithm on `myGraph`
112118
[source, cypher, role=noplay]
113119
----
114-
CALL gds.alpha.randomWalk.stream(
120+
CALL gds.beta.randomWalk.stream(
115121
'myGraph',
116122
{
117123
walkLength: 3,
@@ -147,7 +153,7 @@ RETURN nodeIds, [node IN nodes(path) | node.name ] AS pages
147153
MATCH (page:Page)
148154
WHERE page.name IN ['Home', 'About']
149155
WITH COLLECT(page) as sourceNodes
150-
CALL gds.alpha.randomWalk.stream(
156+
CALL gds.beta.randomWalk.stream(
151157
'myGraph',
152158
{
153159
sourceNodes: sourceNodes,

doc/asciidoc/operations-reference/appendix-a-graph-algos.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,9 @@ include::../algorithms/algorithm-tiers.adoc[]
201201
| `gds.beta.node2vec.stream.estimate`
202202
| `gds.beta.node2vec.write`
203203
| `gds.beta.node2vec.write`.estimate
204+
.2+<.^|<<beta-algorithms-random-walk, Random Walk>>
205+
| `gds.beta.randomWalk.stream`
206+
| `gds.beta.randomWalk.stream.estimate`
204207
|===
205208

206209
[[alpha-tier]]
@@ -239,8 +242,6 @@ include::../algorithms/algorithm-tiers.adoc[]
239242
| `gds.alpha.hits.stream.estimate`
240243
| `gds.alpha.hits.write`
241244
| `gds.alpha.hits.write.estimate`
242-
.1+<.^|<<alpha-algorithms-random-walk, Random Walk>>
243-
| `gds.alpha.randomWalk.stream`
244245
.2+<.^|<<algorithms-strongly-connected-components, Strongly Connected Components>>
245246
| `gds.alpha.scc.stream`
246247
| `gds.alpha.scc.write`

doc/docbook/content-map.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -239,8 +239,8 @@
239239
<d:tocentry linkend="alpha-algorithm-all-pairs-shortest-path">
240240
<?dbhtml filename="alpha-algorithms/all-pairs-shortest-path/index.html"?>
241241
</d:tocentry>
242-
<d:tocentry linkend="alpha-algorithms-random-walk">
243-
<?dbhtml filename="alpha-algorithms/random-walk/index.html"?>
242+
<d:tocentry linkend="beta-algorithms-random-walk">
243+
<?dbhtml filename="beta-algorithms/random-walk/index.html"?>
244244
</d:tocentry>
245245
<d:tocentry linkend="algorithms-bfs">
246246
<?dbhtml filename="algorithms/bfs/index.html"?>

doc/src/test/java/org/neo4j/gds/doc/RandomWalkDocTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
*/
2020
package org.neo4j.gds.doc;
2121

22+
import org.neo4j.gds.beta.randomwalk.RandomWalkStreamProc;
2223
import org.neo4j.gds.catalog.GraphCreateProc;
23-
import org.neo4j.gds.walking.RandomWalkStreamProc;
2424

2525
import java.util.List;
2626

0 commit comments

Comments
 (0)