Skip to content

Commit 4b3063b

Browse files
committed
Doc and changelog, promote apsp to prod
1 parent 8e028be commit 4b3063b

File tree

2 files changed

+43
-7
lines changed

2 files changed

+43
-7
lines changed

doc/modules/ROOT/pages/algorithms/all-pairs-shortest-path.adoc

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
:page-aliases: alpha-algorithms/all-pairs-shortest-path.adoc
1+
:page-aliases: algorithms/all-pairs-shortest-path.adoc
22

33
[[algorithm-all-pairs-shortest-path]]
4-
[.alpha]
54
= All Pairs Shortest Path
65
:description: This section describes the All Pairs Shortest Path algorithm in the Neo4j Graph Data Science library.
76

@@ -10,9 +9,6 @@ include::partial$/product-limitations/not-in-serverless.adoc[]
109
The All Pairs Shortest Path (APSP) calculates the shortest (weighted) path between all pairs of nodes.
1110
This algorithm has optimizations that make it quicker than calling the Single Source Shortest Path algorithm for every pair of nodes in the graph.
1211

13-
include::partial$/operations-reference/alpha-note.adoc[]
14-
15-
1612
:directed:
1713
:undirected:
1814
:weighted:
@@ -81,6 +77,45 @@ include::partial$/algorithms/common-configuration/common-stream-stats-configurat
8177
8278
======
8379

80+
[.include-with-estimate]
81+
======
82+
.The following will estimate the memory requirements for running the algorithm:
83+
[source, cypher, role=noplay]
84+
----
85+
CALL gds.allShortestPaths.stream.estimate(
86+
graphNameOrConfiguration: string or map,
87+
configuration: map
88+
)
89+
YIELD nodeCount, relationshipCount, bytesMin, bytesMax, requiredMemory
90+
----
91+
92+
include::partial$/algorithms/common-configuration/common-parameters.adoc[]
93+
94+
.Configuration
95+
[opts="header",cols="3,2,3m,2,8"]
96+
|===
97+
| Name | Type | Default | Optional | Description
98+
include::partial$/algorithms/common-configuration/common-estimate-configuration-entries.adoc[]
99+
| xref:common-usage/running-algos.adoc#common-configuration-relationship-weight-property[relationshipWeightProperty] | String | null | yes | Name of the relationship property to use as weights. If unspecified, the algorithm runs unweighted.
100+
|===
101+
102+
.Results
103+
[opts="header",cols="1,1,6"]
104+
|===
105+
| Name | Type | Description
106+
| nodeCount | Integer | The number of nodes in the graph.
107+
| relationshipCount | Integer | The number of relationships in the graph.
108+
| requiredMemory | String | An estimation of the required memory in a human readable format.
109+
| treeView | String | A more detailed representation of the required memory, including estimates of the different components in human readable format.
110+
| mapView | Map | A more detailed representation of the required memory, including estimates of the different components in structured format.
111+
| bytesMin | Integer | The minimum number of bytes required.
112+
| bytesMax | Integer | The maximum number of bytes required.
113+
| heapPercentageMin | Float | The minimum percentage of the configured maximum heap required.
114+
| heapPercentageMax | Float | The maximum percentage of the configured maximum heap required.
115+
|===
116+
117+
======
118+
84119
[[algorithm-all-pairs-shortest-path-sample]]
85120
== All Pairs Shortest Path algorithm sample
86121

doc/modules/ROOT/pages/operations-reference/algorithm-references.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727
| `gds.allShortestPaths.dijkstra.write.estimate` label:procedure[Procedure]
2828
| `gds.allShortestPaths.dijkstra.mutate` label:procedure[Procedure]
2929
| `gds.allShortestPaths.dijkstra.mutate.estimate` label:procedure[Procedure]
30+
.2+<.^| xref:algorithms/all-pairs-shortest-path.adoc[All Shortest Paths]
31+
| `gds.allShortestPaths.stream` label:procedure[Procedure]
32+
| `gds.allShortestPaths.stream.estimate` label:procedure[Procedure]
3033
.8+<.^|xref:algorithms/article-rank.adoc[ArticleRank]
3134
| `gds.articleRank.mutate` label:procedure[Procedure]
3235
| `gds.articleRank.mutate.estimate` label:procedure[Procedure]
@@ -405,8 +408,6 @@
405408
|===
406409
|Algorithm name | Operation
407410
| xref:alpha-algorithms/adamic-adar.adoc[Adamic Adar] | `gds.alpha.linkprediction.adamicAdar` label:function[Function]
408-
.1+<.^|xref:algorithms/all-pairs-shortest-path.adoc[All Shortest Paths]
409-
| `gds.allShortestPaths.stream` label:procedure[Procedure]
410411
| xref:alpha-algorithms/common-neighbors.adoc[Common Neighbors] | `gds.alpha.linkprediction.commonNeighbors` label:function[Function]
411412
.8+<.^|xref:algorithms/harmonic-centrality.adoc[Harmonic Centrality]
412413
| `gds.closeness.harmonic.mutate` label:procedure[Procedure]

0 commit comments

Comments
 (0)