migrate FastRP stats

Author: lassewesth

algo/src/main/java/org/neo4j/gds/algorithms/embeddings/NodeEmbeddingsAlgorithmStatsBusinessFacade.java

@@ -19,12 +19,30 @@
  */
 package org.neo4j.gds.applications.algorithms.embeddings;
 
+import org.neo4j.gds.applications.algorithms.machinery.AlgorithmEstimationTemplate;
+import org.neo4j.gds.applications.algorithms.machinery.MemoryEstimateResult;
 import org.neo4j.gds.embeddings.fastrp.FastRPBaseConfig;
 import org.neo4j.gds.embeddings.fastrp.FastRPMemoryEstimateDefinition;
 import org.neo4j.gds.mem.MemoryEstimation;
 
 public class NodeEmbeddingAlgorithmsEstimationModeBusinessFacade {
+    private final AlgorithmEstimationTemplate algorithmEstimationTemplate;
+
+    public NodeEmbeddingAlgorithmsEstimationModeBusinessFacade(AlgorithmEstimationTemplate algorithmEstimationTemplate) {
+        this.algorithmEstimationTemplate = algorithmEstimationTemplate;
+    }
+
     public MemoryEstimation fastRP(FastRPBaseConfig configuration) {
         return new FastRPMemoryEstimateDefinition(configuration.toParameters()).memoryEstimation();
     }
+
+    public MemoryEstimateResult fastRP(FastRPBaseConfig configuration, Object graphNameOrConfiguration) {
+        var memoryEstimation = fastRP(configuration);
+
+        return algorithmEstimationTemplate.estimate(
+            configuration,
+            graphNameOrConfiguration,
+            memoryEstimation
+        );
+    }
 }

applications/algorithms/node-embeddings/src/main/java/org/neo4j/gds/applications/algorithms/embeddings/NodeEmbeddingAlgorithmsEstimationModeBusinessFacade.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.applications.algorithms.embeddings;
+
+import org.neo4j.gds.api.GraphName;
+import org.neo4j.gds.applications.algorithms.machinery.AlgorithmProcessingTemplate;
+import org.neo4j.gds.applications.algorithms.machinery.ResultBuilder;
+import org.neo4j.gds.embeddings.fastrp.FastRPResult;
+import org.neo4j.gds.embeddings.fastrp.FastRPStatsConfig;
+
+import java.util.Optional;
+
+import static org.neo4j.gds.applications.algorithms.metadata.LabelForProgressTracking.FastRP;
+
+public class NodeEmbeddingAlgorithmsStatsModeBusinessFacade {
+    private final NodeEmbeddingAlgorithmsEstimationModeBusinessFacade estimationFacade;
+    private final NodeEmbeddingAlgorithms algorithms;
+    private final AlgorithmProcessingTemplate algorithmProcessingTemplate;
+
+    public NodeEmbeddingAlgorithmsStatsModeBusinessFacade(
+        NodeEmbeddingAlgorithmsEstimationModeBusinessFacade estimationFacade,
+        NodeEmbeddingAlgorithms algorithms,
+        AlgorithmProcessingTemplate algorithmProcessingTemplate
+    ) {
+        this.estimationFacade = estimationFacade;
+        this.algorithms = algorithms;
+        this.algorithmProcessingTemplate = algorithmProcessingTemplate;
+    }
+
+    public <RESULT> RESULT fastRP(
+        GraphName graphName,
+        FastRPStatsConfig configuration,
+        ResultBuilder<FastRPStatsConfig, FastRPResult, RESULT, Void> resultBuilder
+    ) {
+        return algorithmProcessingTemplate.processAlgorithm(
+            graphName,
+            configuration,
+            FastRP,
+            () -> estimationFacade.fastRP(configuration),
+            graph -> algorithms.fastRP(graph, configuration),
+            Optional.empty(),
+            resultBuilder
+        );
+    }
+}

applications/algorithms/node-embeddings/src/main/java/org/neo4j/gds/applications/algorithms/embeddings/NodeEmbeddingAlgorithmsStatsModeBusinessFacade.java

@@ -134,6 +134,7 @@ public static ApplicationsFacade create(
 
         var nodeEmbeddingApplications = NodeEmbeddingApplications.create(
             requestScopedDependencies,
+            algorithmEstimationTemplate,
             algorithmProcessingTemplate,
             progressTrackerCreator,
             mutateNodeProperty
@@ -142,8 +143,8 @@ public static ApplicationsFacade create(
         var pathFindingApplications = PathFindingApplications.create(
             log,
             requestScopedDependencies,
-            algorithmProcessingTemplate,
             algorithmEstimationTemplate,
+            algorithmProcessingTemplate,
             progressTrackerCreator
         );
 

applications/facade/src/main/java/org/neo4j/gds/applications/ApplicationsFacade.java

@@ -22,6 +22,8 @@
 import org.neo4j.gds.applications.algorithms.embeddings.NodeEmbeddingAlgorithms;
 import org.neo4j.gds.applications.algorithms.embeddings.NodeEmbeddingAlgorithmsEstimationModeBusinessFacade;
 import org.neo4j.gds.applications.algorithms.embeddings.NodeEmbeddingAlgorithmsMutateModeBusinessFacade;
+import org.neo4j.gds.applications.algorithms.embeddings.NodeEmbeddingAlgorithmsStatsModeBusinessFacade;
+import org.neo4j.gds.applications.algorithms.machinery.AlgorithmEstimationTemplate;
 import org.neo4j.gds.applications.algorithms.machinery.AlgorithmProcessingTemplate;
 import org.neo4j.gds.applications.algorithms.machinery.MutateNodeProperty;
 import org.neo4j.gds.applications.algorithms.machinery.ProgressTrackerCreator;
@@ -30,17 +32,22 @@
 public final class NodeEmbeddingApplications {
     private final NodeEmbeddingAlgorithmsEstimationModeBusinessFacade estimationMode;
     private final NodeEmbeddingAlgorithmsMutateModeBusinessFacade mutateMode;
+    private final NodeEmbeddingAlgorithmsStatsModeBusinessFacade statsMode;
 
     private NodeEmbeddingApplications(
         NodeEmbeddingAlgorithmsEstimationModeBusinessFacade estimationMode,
-        NodeEmbeddingAlgorithmsMutateModeBusinessFacade mutateMode
+        NodeEmbeddingAlgorithmsMutateModeBusinessFacade mutateMode,
+        NodeEmbeddingAlgorithmsStatsModeBusinessFacade statsMode
     ) {
         this.estimationMode = estimationMode;
         this.mutateMode = mutateMode;
+        this.statsMode = statsMode;
     }
 
     static NodeEmbeddingApplications create(
-        RequestScopedDependencies requestScopedDependencies, AlgorithmProcessingTemplate algorithmProcessingTemplate,
+        RequestScopedDependencies requestScopedDependencies,
+        AlgorithmEstimationTemplate algorithmEstimationTemplate,
+        AlgorithmProcessingTemplate algorithmProcessingTemplate,
         ProgressTrackerCreator progressTrackerCreator,
         MutateNodeProperty mutateNodeProperty
     ) {
@@ -49,22 +56,31 @@ static NodeEmbeddingApplications create(
             requestScopedDependencies.getTerminationFlag()
         );
 
-        var estimationMode = new NodeEmbeddingAlgorithmsEstimationModeBusinessFacade();
+        var estimationMode = new NodeEmbeddingAlgorithmsEstimationModeBusinessFacade(algorithmEstimationTemplate);
         var mutateMode = new NodeEmbeddingAlgorithmsMutateModeBusinessFacade(
             estimationMode,
             algorithms,
             algorithmProcessingTemplate,
             mutateNodeProperty
         );
+        var statsMode = new NodeEmbeddingAlgorithmsStatsModeBusinessFacade(
+            estimationMode,
+            algorithms,
+            algorithmProcessingTemplate
+        );
 
-        return new NodeEmbeddingApplications(estimationMode, mutateMode);
+        return new NodeEmbeddingApplications(estimationMode, mutateMode, statsMode);
+    }
+
+    public NodeEmbeddingAlgorithmsEstimationModeBusinessFacade estimate() {
+        return estimationMode;
     }
 
     public NodeEmbeddingAlgorithmsMutateModeBusinessFacade mutate() {
         return mutateMode;
     }
 
-    public NodeEmbeddingAlgorithmsEstimationModeBusinessFacade estimate() {
-        return estimationMode;
+    public NodeEmbeddingAlgorithmsStatsModeBusinessFacade stats() {
+        return statsMode;
     }
 }

applications/facade/src/main/java/org/neo4j/gds/applications/NodeEmbeddingApplications.java

@@ -61,8 +61,8 @@ private PathFindingApplications(
     public static PathFindingApplications create(
         Log log,
         RequestScopedDependencies requestScopedDependencies,
-        AlgorithmProcessingTemplate algorithmProcessingTemplate,
         AlgorithmEstimationTemplate algorithmEstimationTemplate,
+        AlgorithmProcessingTemplate algorithmProcessingTemplate,
         ProgressTrackerCreator progressTrackerCreator
     ) {
         var pathFindingAlgorithms = new PathFindingAlgorithms(requestScopedDependencies, progressTrackerCreator);

applications/facade/src/main/java/org/neo4j/gds/applications/PathFindingApplications.java

@@ -21,7 +21,7 @@
 
 import org.neo4j.gds.applications.algorithms.machinery.MemoryEstimateResult;
 import org.neo4j.gds.procedures.GraphDataScienceProcedures;
-import org.neo4j.gds.procedures.embeddings.fastrp.FastRPStatsResult;
+import org.neo4j.gds.procedures.algorithms.embeddings.FastRPStatsResult;
 import org.neo4j.procedure.Context;
 import org.neo4j.procedure.Description;
 import org.neo4j.procedure.Name;
@@ -44,7 +44,7 @@ public Stream<FastRPStatsResult> stats(
         @Name(value = "graphName") String graphName,
         @Name(value = "configuration", defaultValue = "{}") Map<String, Object> configuration
     ) {
-        return facade.oldNodeEmbeddings().fastRP().stats(graphName, configuration);
+        return facade.algorithms().nodeEmbeddings().fastRPStats(graphName, configuration);
     }
 
     @Procedure(value = "gds.fastRP.stats.estimate", mode = READ)
@@ -53,6 +53,6 @@ public Stream<MemoryEstimateResult> estimate(
         @Name(value = "graphNameOrConfiguration") Object graphNameOrConfiguration,
         @Name(value = "algoConfiguration") Map<String, Object> algoConfiguration
     ) {
-        return facade.oldNodeEmbeddings().fastRP().statsEstimate(graphNameOrConfiguration, algoConfiguration);
+        return facade.algorithms().nodeEmbeddings().fastRPStatsEstimate(graphNameOrConfiguration, algoConfiguration);
     }
 }

proc/embeddings/src/main/java/org/neo4j/gds/embeddings/fastrp/FastRPStatsProc.java

@@ -25,7 +25,7 @@
 import org.neo4j.gds.executor.ExecutionContext;
 import org.neo4j.gds.executor.GdsCallable;
 import org.neo4j.gds.procedures.algorithms.configuration.NewConfigFunction;
-import org.neo4j.gds.procedures.embeddings.fastrp.FastRPStatsResult;
+import org.neo4j.gds.procedures.algorithms.embeddings.FastRPStatsResult;
 
 import java.util.stream.Stream;
 

proc/embeddings/src/main/java/org/neo4j/gds/embeddings/fastrp/FastRPStatsSpec.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.procedures.algorithms.embeddings;
+
+import org.neo4j.gds.api.Graph;
+import org.neo4j.gds.api.GraphStore;
+import org.neo4j.gds.applications.algorithms.machinery.AlgorithmProcessingTimings;
+import org.neo4j.gds.applications.algorithms.machinery.ResultBuilder;
+import org.neo4j.gds.embeddings.fastrp.FastRPResult;
+import org.neo4j.gds.embeddings.fastrp.FastRPStatsConfig;
+
+import java.util.Optional;
+import java.util.stream.Stream;
+
+class FastRPResultBuilderForStatsMode implements ResultBuilder<FastRPStatsConfig, FastRPResult, Stream<FastRPStatsResult>, Void> {
+    @Override
+    public Stream<FastRPStatsResult> build(
+        Graph graph,
+        GraphStore graphStore,
+        FastRPStatsConfig configuration,
+        Optional<FastRPResult> result,
+        AlgorithmProcessingTimings timings,
+        Optional<Void> unused
+    ) {
+        if (result.isEmpty()) return Stream.of(FastRPStatsResult.emptyFrom(timings, configuration.toMap()));
+
+        var fastRPStatsResult = new FastRPStatsResult(
+            graph.nodeCount(),
+            timings.preProcessingMillis,
+            timings.computeMillis,
+            configuration.toMap()
+        );
+
+        return Stream.of(fastRPStatsResult);
+    }
+}

procedures/algorithms-facade/src/main/java/org/neo4j/gds/procedures/algorithms/embeddings/FastRPResultBuilderForStatsMode.java

@@ -17,14 +17,14 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-package org.neo4j.gds.procedures.embeddings.fastrp;
+package org.neo4j.gds.procedures.algorithms.embeddings;
 
+import org.neo4j.gds.applications.algorithms.machinery.AlgorithmProcessingTimings;
 import org.neo4j.gds.result.AbstractResultBuilder;
 
 import java.util.Map;
 
 public final class FastRPStatsResult {
-
     public final long nodeCount;
     public final long preProcessingMillis;
     public final long computeMillis;
@@ -42,8 +42,11 @@ public FastRPStatsResult(
         this.configuration = config;
     }
 
-    public static final class Builder extends AbstractResultBuilder<FastRPStatsResult> {
+    static FastRPStatsResult emptyFrom(AlgorithmProcessingTimings timings, Map<String, Object> configurationMap) {
+        return new FastRPStatsResult(0, timings.preProcessingMillis, timings.computeMillis, configurationMap);
+    }
 
+    public static final class Builder extends AbstractResultBuilder<FastRPStatsResult> {
         @Override
         public FastRPStatsResult build() {
             return new FastRPStatsResult(