Betafy hashgnn and add beta note

breakanalysis · breakanalysis · commit e9cdddea8c33 · 2022-12-15T14:38:53.000+01:00
diff --git a/doc/modules/ROOT/pages/machine-learning/node-embeddings/hashgnn.adoc b/doc/modules/ROOT/pages/machine-learning/node-embeddings/hashgnn.adoc
@@ -4,7 +4,7 @@
 :entity: node
 :result: embedding
 :algorithm: HashGNN
-
+include::partial$/operations-reference/beta-note.adoc[]
 
 :directed:
 :undirected:
@@ -253,7 +253,7 @@ include::partial$/algorithms/shared/syntax-intro-named-graph.adoc[]
 .Run HashGNN in stream mode on a named graph.
 [source, cypher, role=noplay]
 ----
-CALL gds.alpha.hashgnn.stream(
+CALL gds.beta.hashgnn.stream(
   graphName: String,
   configuration: Map
 ) YIELD
@@ -286,7 +286,7 @@ include::partial$/machine-learning/node-embeddings/hashgnn/specific-configuratio
 .Run HashGNN in mutate mode on a named graph.
 [source, cypher, role=noplay]
 ----
-CALL gds.alpha.hashgnn.mutate(
+CALL gds.beta.hashgnn.mutate(
   graphName: String,
   configuration: Map
 ) YIELD
@@ -425,7 +425,7 @@ include::partial$/algorithms/shared/examples-estimate-intro.adoc[]
 .The following will estimate the memory requirements for running the algorithm:
 [source, cypher, role=noplay]
 ----
-CALL gds.alpha.hashgnn.stream.estimate('persons', {nodeLabels: ['Person'], iterations: 3, embeddingDensity: 2, binarizeFeatures: {dimension: 4, threshold: 0}, featureProperties: ['age', 'experience']})
+CALL gds.beta.hashgnn.stream.estimate('persons', {nodeLabels: ['Person'], iterations: 3, embeddingDensity: 2, binarizeFeatures: {dimension: 4, threshold: 0}, featureProperties: ['age', 'experience']})
 YIELD nodeCount, relationshipCount, bytesMin, bytesMax, requiredMemory
 ----
 
@@ -449,7 +449,7 @@ include::partial$/algorithms/shared/examples-stream-intro.adoc[]
 .The following will run the algorithm on Person nodes with binarization, and stream results:
 [source, cypher, role=noplay]
 ----
-CALL gds.alpha.hashgnn.stream('persons',
+CALL gds.beta.hashgnn.stream('persons',
   {
     nodeLabels: ['Person'],
     iterations: 1,
@@ -489,7 +489,7 @@ Due to the random nature of the algorithm the results will vary between the runs
 .The following will run the algorithm on Person nodes on binary properties, and stream results:
 [source, cypher, role=noplay]
 ----
-CALL gds.alpha.hashgnn.stream('persons',
+CALL gds.beta.hashgnn.stream('persons',
   {
     nodeLabels: ['Person'],
     iterations: 1,
@@ -522,7 +522,7 @@ In this example the embedding dimension becomes `1` because without binarization
 .The following will run the algorithm on Person nodes on generated features, and stream results:
 [source, cypher, role=noplay]
 ----
-CALL gds.alpha.hashgnn.stream('persons',
+CALL gds.beta.hashgnn.stream('persons',
   {
     nodeLabels: ['Person'],
     iterations: 1,
@@ -556,7 +556,7 @@ And as we can see, each node has at least one feature active. The density is abo
 .The following will run the algorithm in heterogeneous mode, and stream results:
 [source, cypher, role=noplay]
 ----
-CALL gds.alpha.hashgnn.stream('persons',
+CALL gds.beta.hashgnn.stream('persons',
   {
     heterogeneous: true,
     iterations: 2,
@@ -592,7 +592,7 @@ YIELD nodeId, embedding
 .The following will run the algorithm as in the previous example but with output densification, and stream results:
 [source, cypher, role=noplay]
 ----
-CALL gds.alpha.hashgnn.stream('persons',
+CALL gds.beta.hashgnn.stream('persons',
   {
     heterogeneous: true,
     iterations: 2,
@@ -635,7 +635,7 @@ include::partial$/algorithms/shared/examples-mutate-intro.adoc[]
 .The following will run the algorithm in `mutate` mode:
 [source, cypher, role=noplay]
 ----
-CALL gds.alpha.hashgnn.mutate(
+CALL gds.beta.hashgnn.mutate(
   'persons',
   {
     mutateProperty: 'hashgnn-embedding',
diff --git a/doc/modules/ROOT/pages/operations-reference/algorithm-references.adoc b/doc/modules/ROOT/pages/operations-reference/algorithm-references.adoc
@@ -270,11 +270,6 @@
 .2+<.^|xref:algorithms/harmonic-centrality.adoc[Harmonic Centrality]
 | `gds.alpha.closeness.harmonic.stream`
 | `gds.alpha.closeness.harmonic.write`
-.4+<.^|xref:machine-learning/node-embeddings/hashgnn.adoc[HashGNN]
-| `gds.alpha.hashgnn.mutate`
-| `gds.alpha.hashgnn.mutate.estimate`
-| `gds.alpha.hashgnn.stream`
-| `gds.alpha.hashgnn.stream.estimate`
 .8+<.^|xref:algorithms/hits.adoc[HITS]
 | `gds.alpha.hits.mutate`
 | `gds.alpha.hits.mutate.estimate`
@@ -324,6 +319,11 @@
 | `gds.alpha.influenceMaximization.greedy.stream`
 .1+<.^| xref:algorithms/alpha/conductance.adoc[Conductance]
 | `gds.alpha.conductance.stream`
+.4+<.^|xref:machine-learning/node-embeddings/hashgnn.adoc[HashGNN]
+| `gds.beta.hashgnn.mutate`
+| `gds.beta.hashgnn.mutate.estimate`
+| `gds.beta.hashgnn.stream`
+| `gds.beta.hashgnn.stream.estimate`
 .8+<.^| xref:algorithms/kmeans.adoc[Kmeans]
 | `gds.beta.kmeans.mutate`
 | `gds.beta.kmeans.mutate.estimate`
diff --git a/doc/modules/ROOT/pages/operations-reference/machine-learning-references.adoc b/doc/modules/ROOT/pages/operations-reference/machine-learning-references.adoc
@@ -118,6 +118,11 @@ include::partial$/operations-reference/model-operation-references.adoc[]
 | `gds.beta.graphSage.write.estimate`
 | `gds.beta.graphSage.train`
 | `gds.beta.graphSage.train.estimate`
+.4+<.^|xref:machine-learning/node-embeddings/hashgnn.adoc[HashGNN]
+| `gds.beta.hashgnn.mutate`
+| `gds.beta.hashgnn.mutate.estimate`
+| `gds.beta.hashgnn.stream`
+| `gds.beta.hashgnn.stream.estimate`
 .6+<.^|xref:machine-learning/node-embeddings/node2vec.adoc[Node2Vec]
 | `gds.beta.node2vec.mutate`
 | `gds.beta.node2vec.mutate.estimate`
@@ -126,19 +131,3 @@ include::partial$/operations-reference/model-operation-references.adoc[]
 | `gds.beta.node2vec.write`
 | `gds.beta.node2vec.write`.estimate
 |===
-
-[[embeddings-alpha-tier]]
-=== Alpha tier
-
-.List of all beta node embedding algorithms in the GDS library. Functions are written in _italic_.
-[[embeddings-table-alpha]]
-[role=procedure-listing]
-[opts=header,cols="1, 2"]
-|===
-|Algorithm name | Operation
-.4+<.^|xref:machine-learning/node-embeddings/hashgnn.adoc[HashGNN]
-| `gds.alpha.hashgnn.mutate`
-| `gds.alpha.hashgnn.mutate.estimate`
-| `gds.alpha.hashgnn.stream`
-| `gds.alpha.hashgnn.stream.estimate`
-|===
diff --git a/open-packaging/src/test/java/org/neo4j/gds/OpenGdsProcedureSmokeTest.java b/open-packaging/src/test/java/org/neo4j/gds/OpenGdsProcedureSmokeTest.java
@@ -97,11 +97,6 @@ class OpenGdsProcedureSmokeTest extends BaseProcTest {
         "gds.alpha.modularity.stats",
         "gds.alpha.modularity.stream",
 
-        "gds.alpha.hashgnn.mutate",
-        "gds.alpha.hashgnn.mutate.estimate",
-        "gds.alpha.hashgnn.stream",
-        "gds.alpha.hashgnn.stream.estimate",
-
         "gds.alpha.hits.mutate",
         "gds.alpha.hits.mutate.estimate",
         "gds.alpha.hits.stats",
@@ -120,6 +115,11 @@ class OpenGdsProcedureSmokeTest extends BaseProcTest {
         "gds.alpha.nodeSimilarity.filtered.write",
         "gds.alpha.nodeSimilarity.filtered.write.estimate",
 
+        "gds.beta.hashgnn.mutate",
+        "gds.beta.hashgnn.mutate.estimate",
+        "gds.beta.hashgnn.stream",
+        "gds.beta.hashgnn.stream.estimate",
+
         "gds.beta.pipeline.linkPrediction.addFeature",
         "gds.beta.pipeline.linkPrediction.addNodeProperty",
         "gds.beta.pipeline.linkPrediction.addLogisticRegression",
diff --git a/proc/embeddings/src/main/java/org/neo4j/gds/embeddings/hashgnn/HashGNNMutateProc.java b/proc/embeddings/src/main/java/org/neo4j/gds/embeddings/hashgnn/HashGNNMutateProc.java
@@ -39,10 +39,10 @@
 import static org.neo4j.gds.executor.ExecutionMode.MUTATE_NODE_PROPERTY;
 import static org.neo4j.procedure.Mode.READ;
 
-@GdsCallable(name = "gds.alpha.hashgnn.mutate", description = DESCRIPTION, executionMode = MUTATE_NODE_PROPERTY)
+@GdsCallable(name = "gds.beta.hashgnn.mutate", description = DESCRIPTION, executionMode = MUTATE_NODE_PROPERTY)
 public class HashGNNMutateProc extends MutatePropertyProc<HashGNN, HashGNN.HashGNNResult, HashGNNMutateProc.MutateResult, HashGNNMutateConfig> {
 
-    @Procedure(value = "gds.alpha.hashgnn.mutate", mode = READ)
+    @Procedure(value = "gds.beta.hashgnn.mutate", mode = READ)
     @Description(DESCRIPTION)
     public Stream<MutateResult> mutate(
         @Name(value = "graphName") String graphName,
@@ -55,7 +55,7 @@ public Stream<MutateResult> mutate(
         return mutate(computationResult);
     }
 
-    @Procedure(value = "gds.alpha.hashgnn.mutate.estimate", mode = READ)
+    @Procedure(value = "gds.beta.hashgnn.mutate.estimate", mode = READ)
     @Description(DESCRIPTION)
     public Stream<MemoryEstimateResult> estimate(
         @Name(value = "graphNameOrConfiguration") Object graphNameOrConfiguration,
diff --git a/proc/embeddings/src/main/java/org/neo4j/gds/embeddings/hashgnn/HashGNNStreamProc.java b/proc/embeddings/src/main/java/org/neo4j/gds/embeddings/hashgnn/HashGNNStreamProc.java
@@ -41,10 +41,10 @@
 import static org.neo4j.gds.executor.ExecutionMode.STREAM;
 import static org.neo4j.procedure.Mode.READ;
 
-@GdsCallable(name = "gds.alpha.hashgnn.stream", description = DESCRIPTION, executionMode = STREAM)
+@GdsCallable(name = "gds.beta.hashgnn.stream", description = DESCRIPTION, executionMode = STREAM)
 public class HashGNNStreamProc extends StreamProc<HashGNN, HashGNN.HashGNNResult, HashGNNStreamProc.StreamResult, HashGNNStreamConfig> {
 
-    @Procedure(value = "gds.alpha.hashgnn.stream", mode = READ)
+    @Procedure(value = "gds.beta.hashgnn.stream", mode = READ)
     @Description(DESCRIPTION)
     public Stream<StreamResult> stream(
         @Name(value = "graphName") String graphName,
@@ -57,7 +57,7 @@ public Stream<StreamResult> stream(
         return stream(computationResult);
     }
 
-    @Procedure(value = "gds.alpha.hashgnn.stream.estimate", mode = READ)
+    @Procedure(value = "gds.beta.hashgnn.stream.estimate", mode = READ)
     @Description(DESCRIPTION)
     public Stream<MemoryEstimateResult> estimate(
         @Name(value = "graphNameOrConfiguration") Object graphNameOrConfiguration,
diff --git a/proc/embeddings/src/test/java/org/neo4j/gds/embeddings/hashgnn/HashGNNStreamProcTest.java b/proc/embeddings/src/test/java/org/neo4j/gds/embeddings/hashgnn/HashGNNStreamProcTest.java
@@ -55,7 +55,7 @@ void shouldComputeNonZeroEmbeddings() {
         runQuery(graphCreateQuery);
 
         GdsCypher.ParametersBuildStage queryBuilder = GdsCypher.call(GRAPH_NAME)
-            .algo("gds.alpha.hashgnn")
+            .algo("gds.beta.hashgnn")
             .streamMode()
             .addParameter("featureProperties", List.of("f1", "f2"))
             .addParameter("embeddingDensity", 2)
