Promote Steiner Tree to beta

IoannisPanagiotas · IoannisPanagiotas · commit ce8eb14a94bf · 2022-12-21T12:44:56.000+01:00
diff --git a/doc/modules/ROOT/pages/algorithms/directed-steiner-tree.adoc b/doc/modules/ROOT/pages/algorithms/directed-steiner-tree.adoc
@@ -1,12 +1,12 @@
-[[alpha-algorithms-directed-steiner-tree]]
-[.alpha]
+[[algorithms-directed-steiner-tree]]
+[.beta]
 = Minimum Directed Steiner Tree
 :description: This section describes the Minimum Directed Steiner Tree algorithm in the Neo4j Graph Data Science library.
 :entity: relationship
 :result: weight
 :algorithm: Steiner Tree heuristic
 
-include::partial$/operations-reference/alpha-note.adoc[]
+include::partial$/operations-reference/beta-note.adoc[]
 
 :undirected:
 :directed:
@@ -49,7 +49,7 @@ It is possible to use the GDS implementation to find a solution for Minimum Stei
 .Run the algorithm in stream mode on a named graph.
 [source, cypher, role=noplay]
 ----
-CALL gds.alpha.steinerTree.stream(
+CALL gds.beta.steinerTree.stream(
   graphName: String,
   configuration: Map
 )
@@ -84,7 +84,7 @@ include::partial$/algorithms/steiner-tree/specific-configuration.adoc[]
 .Run the algorithm in stats mode on a named graph.
 [source, cypher, role=noplay]
 ----
-CALL gds.alpha.steinerTree.stats(
+CALL gds.beta.steinerTree.stats(
   graphName: String,
   configuration: Map
 )
@@ -124,7 +124,7 @@ include::partial$/algorithms/steiner-tree/specific-configuration.adoc[]
 .Run the Spanning Tree algorithm in write mode on a named graph.
 [source, cypher, role=noplay]
 ----
-CALL gds.alpha.steinerTree.mutate(
+CALL gds.beta.steinerTree.mutate(
   graphName: String,
   configuration: Map
 )
@@ -168,7 +168,7 @@ include::partial$/algorithms/steiner-tree/specific-configuration.adoc[]
 .Run the Spanning Tree algorithm in write mode on a named graph.
 [source, cypher, role=noplay]
 ----
-CALL gds.alpha.steinerTree.write(
+CALL gds.beta.steinerTree.write(
   graphName: String,
   configuration: Map
 )
@@ -261,7 +261,7 @@ include::partial$/algorithms/shared/examples-stream-intro.adoc[]
 [source,cypher,role=noplay]
 ----
 MATCH (a:Place{id: 'A'}), (d:Place{id: 'D'}),(e:Place{id: 'E'}),(f:Place{id: 'F'})
-CALL gds.alpha.steinerTree.stream('graph', {
+CALL gds.beta.steinerTree.stream('graph', {
   sourceNode: id(a),
   targetNodes: [id(d), id(e), id(f)],
   relationshipWeightProperty: 'cost'
@@ -302,7 +302,7 @@ include::partial$/algorithms/shared/examples-stats-intro.adoc[]
 [source,cypher,role=noplay]
 ----
 MATCH (a:Place{id: 'A'}), (d:Place{id: 'D'}),(e:Place{id: 'E'}),(f:Place{id: 'F'})
-CALL gds.alpha.steinerTree.stats('graph', {
+CALL gds.beta.steinerTree.stats('graph', {
   sourceNode: id(a),
   targetNodes: [id(d), id(e), id(f)],
   relationshipWeightProperty: 'cost'
@@ -331,7 +331,7 @@ include::partial$/algorithms/shared/examples-write-intro.adoc[]
 [source, cypher, role=noplay]
 ----
 MATCH (a:Place{id: 'A'}), (d:Place{id: 'D'}),(e:Place{id: 'E'}),(f:Place{id: 'F'})
-CALL gds.alpha.steinerTree.write('graph', {
+CALL gds.beta.steinerTree.write('graph', {
   sourceNode: id(a),
   targetNodes: [id(d), id(e), id(f)],
   relationshipWeightProperty: 'cost',
@@ -383,7 +383,7 @@ include::partial$/algorithms/shared/examples-mutate-intro.adoc[]
 [source, cypher, role=noplay]
 ----
 MATCH (a:Place{id: 'A'}), (d:Place{id: 'D'}),(e:Place{id: 'E'}),(f:Place{id: 'F'})
-CALL gds.alpha.steinerTree.mutate('graph', {
+CALL gds.beta.steinerTree.mutate('graph', {
   sourceNode: id(a),
   targetNodes: [id(d), id(e), id(f)],
   relationshipWeightProperty: 'cost',
@@ -423,7 +423,7 @@ Note that there is no guarantee that enabling rerouting will always lead to an i
 [source,cypher,role=noplay]
 ----
 MATCH (a:Place{id: 'A'}), (d:Place{id: 'D'}),(e:Place{id: 'E'}),(f:Place{id: 'F'})
-CALL gds.alpha.steinerTree.stream('graph', {
+CALL gds.beta.steinerTree.stream('graph', {
   sourceNode: id(a),
   targetNodes: [id(d), id(e), id(f)],
   relationshipWeightProperty: 'cost',
diff --git a/doc/modules/ROOT/pages/algorithms/pathfinding.adoc b/doc/modules/ROOT/pages/algorithms/pathfinding.adoc
@@ -18,8 +18,8 @@ The Neo4j GDS library includes the following path finding algorithms, grouped by
 
 * Beta
 ** xref:algorithms/minimum-weight-spanning-tree.adoc[Minimum Weight Spanning Tree]
+** xref:algorithms/directed-steiner-tree.adoc[Minimum Directed Steiner Tree]
 
 * Alpha
 ** xref:alpha-algorithms/k-minimum-weight-spanning-tree.adoc[Minimum Weight k-Spanning Tree]
 ** xref:alpha-algorithms/all-pairs-shortest-path.adoc[All Pairs Shortest Path]
-** xref:algorithms/directed-steiner-tree.adoc[Minimum Directed Steiner Tree]
diff --git a/doc/modules/ROOT/pages/operations-reference/algorithm-references.adoc b/doc/modules/ROOT/pages/operations-reference/algorithm-references.adoc
@@ -360,9 +360,9 @@
 | `gds.alpha.modularity.stats`
 | `gds.alpha.modularity.stream`
 .4+<.^| xref:algorithms/directed-steiner-tree.adoc[Minimum Directed Steiner Tree]
-| `gds.alpha.steinerTree.mutate`
-| `gds.alpha.steinerTree.stats`
-| `gds.alpha.steinerTree.stream`
-| `gds.alpha.steinerTree.write`
+| `gds.beta.steinerTree.mutate`
+| `gds.beta.steinerTree.stats`
+| `gds.beta.steinerTree.stream`
+| `gds.beta.steinerTree.write`
 
 |===
diff --git a/open-packaging/src/test/java/org/neo4j/gds/OpenGdsProcedureSmokeTest.java b/open-packaging/src/test/java/org/neo4j/gds/OpenGdsProcedureSmokeTest.java
@@ -188,10 +188,10 @@ class OpenGdsProcedureSmokeTest extends BaseProcTest {
         "gds.beta.spanningTree.write.estimate",
         "gds.alpha.kSpanningTree.write",
 
-        "gds.alpha.steinerTree.mutate",
-        "gds.alpha.steinerTree.stats",
-        "gds.alpha.steinerTree.stream",
-        "gds.alpha.steinerTree.write",
+        "gds.beta.steinerTree.mutate",
+        "gds.beta.steinerTree.stats",
+        "gds.beta.steinerTree.stream",
+        "gds.beta.steinerTree.write",
 
         "gds.alpha.triangles",
         "gds.alpha.ml.splitRelationships.mutate",
diff --git a/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeMutateProc.java b/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeMutateProc.java
@@ -31,7 +31,7 @@
 import static org.neo4j.procedure.Mode.READ;
 
 public class SteinerTreeMutateProc extends BaseProc {
-    static final String procedure = "gds.alpha.steinerTree.mutate";
+    static final String procedure = "gds.beta.steinerTree.mutate";
     static final String DESCRIPTION = SteinerTreeStatsProc.DESCRIPTION;
 
 
diff --git a/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeMutateSpec.java b/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeMutateSpec.java
@@ -44,7 +44,7 @@
 
 import static org.neo4j.gds.executor.ExecutionMode.STREAM;
 
-@GdsCallable(name = "gds.alpha.SteinerTree.mutate", description = SteinerTreeStatsProc.DESCRIPTION, executionMode = STREAM)
+@GdsCallable(name = "gds.beta.SteinerTree.mutate", description = SteinerTreeStatsProc.DESCRIPTION, executionMode = STREAM)
 public class SteinerTreeMutateSpec implements AlgorithmSpec<ShortestPathsSteinerAlgorithm, SteinerTreeResult, SteinerTreeMutateConfig, Stream<MutateResult>, SteinerTreeAlgorithmFactory<SteinerTreeMutateConfig>> {
 
     @Override
diff --git a/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeStatsProc.java b/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeStatsProc.java
@@ -32,10 +32,10 @@
 
 public class SteinerTreeStatsProc extends BaseProc {
 
-    static final String procedure = "gds.alpha.steinerTree.stats";
+    static final String procedure = "gds.beta.steinerTree.stats";
     static final String DESCRIPTION =
         "The steiner tree algorithm accepts a source node, as well as a list of target nodes. " +
-        "It then attempts to find a spanning tree where there is a path from the source node to each target node, "+
+        "It then attempts to find a spanning tree where there is a path from the source node to each target node, " +
         "such that the total weight of the relationships is as low as possible.";
 
     @Procedure(value = procedure, mode = READ)
diff --git a/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeStatsSpec.java b/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeStatsSpec.java
@@ -33,7 +33,7 @@
 
 import static org.neo4j.gds.executor.ExecutionMode.STATS;
 
-@GdsCallable(name = "gds.alpha.steinerTree.stats", description = SteinerTreeStatsProc.DESCRIPTION, executionMode = STATS)
+@GdsCallable(name = "gds.beta.steinerTree.stats", description = SteinerTreeStatsProc.DESCRIPTION, executionMode = STATS)
 
 public class SteinerTreeStatsSpec implements AlgorithmSpec<ShortestPathsSteinerAlgorithm, SteinerTreeResult, SteinerTreeStatsConfig, Stream<StatsResult>, SteinerTreeAlgorithmFactory<SteinerTreeStatsConfig>> {
 
diff --git a/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeStreamProc.java b/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeStreamProc.java
@@ -31,7 +31,7 @@
 import static org.neo4j.procedure.Mode.READ;
 
 public class SteinerTreeStreamProc extends BaseProc {
-    static final String procedure = "gds.alpha.steinerTree.stream";
+    static final String procedure = "gds.beta.steinerTree.stream";
     static final String DESCRIPTION = SteinerTreeStatsProc.DESCRIPTION;
 
 
diff --git a/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeStreamSpec.java b/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeStreamSpec.java
@@ -34,7 +34,7 @@
 
 import static org.neo4j.gds.executor.ExecutionMode.STREAM;
 
-@GdsCallable(name = "gds.alpha.SteinerTree.stream", description = SteinerTreeStatsProc.DESCRIPTION, executionMode = STREAM)
+@GdsCallable(name = "gds.beta.SteinerTree.stream", description = SteinerTreeStatsProc.DESCRIPTION, executionMode = STREAM)
 public class SteinerTreeStreamSpec implements AlgorithmSpec<ShortestPathsSteinerAlgorithm, SteinerTreeResult, SteinerTreeStreamConfig, Stream<StreamResult>, SteinerTreeAlgorithmFactory<SteinerTreeStreamConfig>> {
 
     @Override
diff --git a/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeWriteProc.java b/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeWriteProc.java
@@ -40,7 +40,7 @@ public class SteinerTreeWriteProc extends BaseProc {
     @Context
     public RelationshipExporterBuilder<? extends RelationshipExporter> relationshipExporterBuilder;
 
-    @Procedure(value = "gds.alpha.steinerTree.write", mode = WRITE)
+    @Procedure(value = "gds.beta.steinerTree.write", mode = WRITE)
     @Description(SteinerTreeStatsProc.DESCRIPTION)
     public Stream<WriteResult> write(
         @Name(value = "graphName") String graphName,
diff --git a/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeWriteSpec.java b/proc/path-finding/src/main/java/org/neo4j/gds/paths/steiner/SteinerTreeWriteSpec.java
@@ -38,7 +38,7 @@
 
 import static org.neo4j.gds.executor.ExecutionMode.WRITE_RELATIONSHIP;
 
-@GdsCallable(name = "gds.alpha.SteinerTree.write", description = SteinerTreeStatsProc.DESCRIPTION, executionMode = WRITE_RELATIONSHIP)
+@GdsCallable(name = "gds.beta.SteinerTree.write", description = SteinerTreeStatsProc.DESCRIPTION, executionMode = WRITE_RELATIONSHIP)
 public class SteinerTreeWriteSpec implements AlgorithmSpec<ShortestPathsSteinerAlgorithm, SteinerTreeResult, SteinerTreeWriteConfig, Stream<WriteResult>, SteinerTreeAlgorithmFactory<SteinerTreeWriteConfig>> {
 
     @Override
diff --git a/proc/path-finding/src/test/java/org/neo4j/gds/paths/steiner/SteinerTreeMutateProcTest.java b/proc/path-finding/src/test/java/org/neo4j/gds/paths/steiner/SteinerTreeMutateProcTest.java
@@ -64,7 +64,7 @@ void testYields() {
         var terminalNode = idFunction.of("b");
 
         String query = GdsCypher.call(DEFAULT_GRAPH_NAME)
-            .algo("gds.alpha.steinerTree")
+            .algo("gds.beta.steinerTree")
             .mutateMode()
             .addParameter("sourceNode", sourceNode)
             .addParameter("targetNodes", List.of(terminalNode))
@@ -111,7 +111,7 @@ void testMutatedGraph() {
         var terminalNode = idFunction.of("b");
 
         String query = GdsCypher.call(DEFAULT_GRAPH_NAME)
-            .algo("gds.alpha.steinerTree")
+            .algo("gds.beta.steinerTree")
             .mutateMode()
             .addParameter("sourceNode", sourceNode)
             .addParameter("targetNodes", List.of(terminalNode))
diff --git a/proc/path-finding/src/test/java/org/neo4j/gds/paths/steiner/SteinerTreeStatsProcTest.java b/proc/path-finding/src/test/java/org/neo4j/gds/paths/steiner/SteinerTreeStatsProcTest.java
@@ -64,7 +64,7 @@ private long getTerminal() {
     @Test
     void testYields() {
         String query = GdsCypher.call(DEFAULT_GRAPH_NAME)
-            .algo("gds.alpha.steinerTree")
+            .algo("gds.beta.steinerTree")
             .statsMode()
             .addParameter("sourceNode", getSourceNode())
             .addParameter("targetNodes", List.of(getTerminal()))
diff --git a/proc/path-finding/src/test/java/org/neo4j/gds/paths/steiner/SteinerTreeStreamProcTest.java b/proc/path-finding/src/test/java/org/neo4j/gds/paths/steiner/SteinerTreeStreamProcTest.java
@@ -68,7 +68,7 @@ private long getUnreachableTerminal() {
     @Test
     void testYields() {
         String query = GdsCypher.call(DEFAULT_GRAPH_NAME)
-            .algo("gds.alpha.steinerTree")
+            .algo("gds.beta.steinerTree")
             .streamMode()
             .addParameter("sourceNode", getSourceNode())
             .addParameter("targetNodes", List.of(getTerminal()))
diff --git a/proc/path-finding/src/test/java/org/neo4j/gds/paths/steiner/SteinerTreeWriteProcTest.java b/proc/path-finding/src/test/java/org/neo4j/gds/paths/steiner/SteinerTreeWriteProcTest.java
@@ -60,7 +60,7 @@ void testYields() {
         var terminalNode = idFunction.of("b");
 
         String query = GdsCypher.call(DEFAULT_GRAPH_NAME)
-            .algo("gds.alpha.steinerTree")
+            .algo("gds.beta.steinerTree")
             .writeMode()
             .addParameter("sourceNode", sourceNode)
             .addParameter("targetNodes", List.of(terminalNode))
@@ -107,7 +107,7 @@ void testWrittenRelationships() {
         var terminalNode = idFunction.of("b");
 
         String query = GdsCypher.call(DEFAULT_GRAPH_NAME)
-            .algo("gds.alpha.steinerTree")
+            .algo("gds.beta.steinerTree")
             .writeMode()
             .addParameter("sourceNode", sourceNode)
             .addParameter("targetNodes", List.of(terminalNode))
