migrate modopt write

neo4j · Jun 19, 2024 · e385875 · e385875
1 parent bd2416f
commit e385875
Show file tree

Hide file tree

Showing 20 changed files with 268 additions and 247 deletions.
diff --git a/...in/java/org/neo4j/gds/algorithms/community/CommunityAlgorithmsEstimateBusinessFacade.java b/...in/java/org/neo4j/gds/algorithms/community/CommunityAlgorithmsEstimateBusinessFacade.java
@@ -21,8 +21,6 @@
 
 import org.neo4j.gds.algorithms.estimation.AlgorithmEstimator;
 import org.neo4j.gds.applications.algorithms.machinery.MemoryEstimateResult;
-import org.neo4j.gds.modularityoptimization.ModularityOptimizationBaseConfig;
-import org.neo4j.gds.modularityoptimization.ModularityOptimizationMemoryEstimateDefinition;
 import org.neo4j.gds.scc.SccBaseConfig;
 import org.neo4j.gds.scc.SccMemoryEstimateDefinition;
 import org.neo4j.gds.triangle.IntersectingTriangleCountMemoryEstimateDefinition;
@@ -77,16 +75,4 @@ public <C extends LocalClusteringCoefficientBaseConfig> MemoryEstimateResult loc
             new LocalClusteringCoefficientMemoryEstimateDefinition(configuration.seedProperty())
         );
     }
-
-    public <C extends ModularityOptimizationBaseConfig> MemoryEstimateResult modularityOptimization(
-        Object graphNameOrConfiguration,
-        C configuration
-    ) {
-        return algorithmEstimator.estimate(
-            graphNameOrConfiguration,
-            configuration,
-            configuration.relationshipWeightProperty(),
-            new ModularityOptimizationMemoryEstimateDefinition()
-        );
-    }
 }
diff --git a/algo/src/main/java/org/neo4j/gds/algorithms/community/CommunityAlgorithmsFacade.java b/algo/src/main/java/org/neo4j/gds/algorithms/community/CommunityAlgorithmsFacade.java
@@ -22,9 +22,6 @@
 import org.neo4j.gds.algorithms.AlgorithmComputationResult;
 import org.neo4j.gds.algorithms.runner.AlgorithmRunner;
 import org.neo4j.gds.collections.ha.HugeLongArray;
-import org.neo4j.gds.modularityoptimization.ModularityOptimizationBaseConfig;
-import org.neo4j.gds.modularityoptimization.ModularityOptimizationFactory;
-import org.neo4j.gds.modularityoptimization.ModularityOptimizationResult;
 import org.neo4j.gds.scc.SccAlgorithmFactory;
 import org.neo4j.gds.scc.SccCommonBaseConfig;
 import org.neo4j.gds.triangle.IntersectingTriangleCountFactory;
@@ -81,16 +78,4 @@ public AlgorithmComputationResult<LocalClusteringCoefficientResult> localCluster
             new LocalClusteringCoefficientFactory<>()
         );
     }
-
-    public AlgorithmComputationResult<ModularityOptimizationResult> modularityOptimization(
-        String graphName,
-        ModularityOptimizationBaseConfig config
-    ) {
-        return algorithmRunner.run(
-            graphName,
-            config,
-            config.relationshipWeightProperty(),
-            new ModularityOptimizationFactory<>()
-        );
-    }
 }
diff --git a/.../main/java/org/neo4j/gds/algorithms/community/CommunityAlgorithmsWriteBusinessFacade.java b/.../main/java/org/neo4j/gds/algorithms/community/CommunityAlgorithmsWriteBusinessFacade.java
@@ -24,7 +24,6 @@
 import org.neo4j.gds.algorithms.community.specificfields.AlphaSccSpecificFields;
 import org.neo4j.gds.algorithms.community.specificfields.CommunityStatisticsSpecificFields;
 import org.neo4j.gds.algorithms.community.specificfields.LocalClusteringCoefficientSpecificFields;
-import org.neo4j.gds.algorithms.community.specificfields.ModularityOptimizationSpecificFields;
 import org.neo4j.gds.algorithms.community.specificfields.StandardCommunityStatisticsSpecificFields;
 import org.neo4j.gds.algorithms.community.specificfields.TriangleCountSpecificFields;
 import org.neo4j.gds.algorithms.runner.AlgorithmRunner;
@@ -35,7 +34,6 @@
 import org.neo4j.gds.config.ArrowConnectionInfo;
 import org.neo4j.gds.core.concurrency.Concurrency;
 import org.neo4j.gds.core.concurrency.DefaultPool;
-import org.neo4j.gds.modularityoptimization.ModularityOptimizationWriteConfig;
 import org.neo4j.gds.result.CommunityStatistics;
 import org.neo4j.gds.result.StatisticsComputationInstructions;
 import org.neo4j.gds.scc.SccAlphaWriteConfig;
@@ -133,52 +131,6 @@ public NodePropertyWriteResult<AlphaSccSpecificFields> alphaScc(
 
     }
 
-    public NodePropertyWriteResult<ModularityOptimizationSpecificFields> modularityOptimization(
-        String graphName,
-        ModularityOptimizationWriteConfig configuration,
-        StatisticsComputationInstructions statisticsComputationInstructions
-    ) {
-        // 1. Run the algorithm and time the execution
-        var intermediateResult = runWithTiming(
-            () -> communityAlgorithmsFacade.modularityOptimization(graphName, configuration)
-        );
-        var algorithmResult = intermediateResult.algorithmResult;
-
-        Supplier<ModularityOptimizationSpecificFields> emptySupplier = () -> ModularityOptimizationSpecificFields.EMPTY;
-
-        return writeToDatabase(
-            algorithmResult,
-            configuration,
-            (result, config) -> CommunityCompanion.nodePropertyValues(
-                config.isIncremental(),
-                config.writeProperty(),
-                config.seedProperty(),
-                config.consecutiveIds(),
-                result.asNodeProperties(),
-                config.minCommunitySize(),
-                config.concurrency(),
-                () -> algorithmResult.graphStore().nodeProperty(config.seedProperty())
-            ),
-            result -> result::communityId,
-            (result, componentCount, communitySummary) -> new ModularityOptimizationSpecificFields(
-                result.modularity(),
-                result.ranIterations(),
-                result.didConverge(),
-                result.asNodeProperties().nodeCount(),
-                componentCount,
-                communitySummary
-            ),
-            statisticsComputationInstructions,
-            intermediateResult.computeMilliseconds,
-            emptySupplier,
-            "ModularityOptimizationWrite",
-            configuration.writeConcurrency(),
-            configuration.writeProperty(),
-            configuration.arrowConnectionInfo(),
-            configuration.resolveResultStore(algorithmResult.resultStore())
-        );
-    }
-
     public NodePropertyWriteResult<TriangleCountSpecificFields> triangleCount(
         String graphName,
         TriangleCountWriteConfig config

diff --git a/...g/neo4j/gds/algorithms/community/specificfields/ModularityOptimizationSpecificFields.java b/...g/neo4j/gds/algorithms/community/specificfields/ModularityOptimizationSpecificFields.java
diff --git a/algo/src/main/java/org/neo4j/gds/louvain/Louvain.java b/algo/src/main/java/org/neo4j/gds/louvain/Louvain.java
@@ -205,9 +205,9 @@ private ModularityOptimizationResult runModularityOptimization(Graph louvainGrap
             concurrency,
             DEFAULT_BATCH_SIZE,
             DefaultPool.INSTANCE,
-            progressTracker
+            progressTracker,
+            terminationFlag
         );
-        modularityOptimization.setTerminationFlag(terminationFlag);
 
         return modularityOptimization.compute();
     }

diff --git a/algo/src/main/java/org/neo4j/gds/modularityoptimization/ModularityOptimization.java b/algo/src/main/java/org/neo4j/gds/modularityoptimization/ModularityOptimization.java
@@ -94,7 +94,8 @@ public ModularityOptimization(
         Concurrency concurrency,
         int minBatchSize,
         ExecutorService executor,
-        ProgressTracker progressTracker
+        ProgressTracker progressTracker,
+        TerminationFlag terminationFlag
     ) {
         super(progressTracker);
         this.graph = graph;
@@ -113,6 +114,8 @@ public ModularityOptimization(
         }
 
         this.modularityManager = ModularityManager.create(graph, concurrency);
+
+        this.terminationFlag = terminationFlag;
     }
 
     @Override

diff --git a/algo/src/main/java/org/neo4j/gds/modularityoptimization/ModularityOptimizationFactory.java b/algo/src/main/java/org/neo4j/gds/modularityoptimization/ModularityOptimizationFactory.java
@@ -31,6 +31,7 @@
 import org.neo4j.gds.k1coloring.K1ColoringAlgorithmFactory;
 import org.neo4j.gds.k1coloring.K1ColoringBaseConfig;
 import org.neo4j.gds.k1coloring.K1ColoringStreamConfigImpl;
+import org.neo4j.gds.termination.TerminationFlag;
 
 import java.util.List;
 
@@ -82,7 +83,8 @@ public ModularityOptimization build(
             parameters.concurrency(),
             parameters.batchSize(),
             DefaultPool.INSTANCE,
-            progressTracker
+            progressTracker,
+            TerminationFlag.RUNNING_TRUE
         );
     }
 

diff --git a/algo/src/test/java/org/neo4j/gds/modularityoptimization/FootballTest.java b/algo/src/test/java/org/neo4j/gds/modularityoptimization/FootballTest.java
@@ -38,6 +38,7 @@
 import org.neo4j.gds.extension.Inject;
 import org.neo4j.gds.extension.TestGraph;
 import org.neo4j.gds.modularity.TestGraphs;
+import org.neo4j.gds.termination.TerminationFlag;
 import org.neo4j.logging.Log;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -123,7 +124,8 @@ private ModularityOptimizationResult compute(
             concurrency,
             minBatchSize,
             DefaultPool.INSTANCE,
-            progressTracker
+            progressTracker,
+            TerminationFlag.RUNNING_TRUE
         ).compute();
     }
 

diff --git a/algo/src/test/java/org/neo4j/gds/modularityoptimization/ModularityOptimizationTest.java b/algo/src/test/java/org/neo4j/gds/modularityoptimization/ModularityOptimizationTest.java
@@ -39,6 +39,7 @@
 import org.neo4j.gds.extension.IdFunction;
 import org.neo4j.gds.extension.Inject;
 import org.neo4j.gds.extension.TestGraph;
+import org.neo4j.gds.termination.TerminationFlag;
 import org.neo4j.logging.Log;
 
 import java.util.Optional;
@@ -212,7 +213,8 @@ private ModularityOptimizationResult compute(
             concurrency,
             minBatchSize,
             DefaultPool.INSTANCE,
-            progressTracker
+            progressTracker,
+            TerminationFlag.RUNNING_TRUE
         ).compute();
     }
 

diff --git a/...va/org/neo4j/gds/modularityoptimization/ModularityOptimizationWithoutOrientationTest.java b/...va/org/neo4j/gds/modularityoptimization/ModularityOptimizationWithoutOrientationTest.java
@@ -50,6 +50,7 @@
 import org.neo4j.gds.extension.Inject;
 import org.neo4j.gds.extension.TestGraph;
 import org.neo4j.gds.mem.Estimate;
+import org.neo4j.gds.termination.TerminationFlag;
 import org.neo4j.logging.Log;
 
 import java.util.Optional;
@@ -283,7 +284,8 @@ private ModularityOptimizationResult compute(
             concurrency,
             minBatchSize,
             DefaultPool.INSTANCE,
-            progressTracker
+            progressTracker,
+            TerminationFlag.RUNNING_TRUE
         ).compute();
     }
 

diff --git a/...ty/src/main/java/org/neo4j/gds/applications/algorithms/community/CommunityAlgorithms.java b/...ty/src/main/java/org/neo4j/gds/applications/algorithms/community/CommunityAlgorithms.java
@@ -317,7 +317,8 @@ ModularityOptimizationResult modularityOptimization(Graph graph, ModularityOptim
             parameters.concurrency(),
             parameters.batchSize(),
             DefaultPool.INSTANCE,
-            progressTracker
+            progressTracker,
+            terminationFlag
         );
 
         return algorithmMachinery.runAlgorithmsAndManageProgressTracker(algorithm, progressTracker, true);

diff --git a/...o4j/gds/applications/algorithms/community/CommunityAlgorithmsWriteModeBusinessFacade.java b/...o4j/gds/applications/algorithms/community/CommunityAlgorithmsWriteModeBusinessFacade.java
@@ -42,6 +42,8 @@
 import org.neo4j.gds.logging.Log;
 import org.neo4j.gds.louvain.LouvainResult;
 import org.neo4j.gds.louvain.LouvainWriteConfig;
+import org.neo4j.gds.modularityoptimization.ModularityOptimizationResult;
+import org.neo4j.gds.modularityoptimization.ModularityOptimizationWriteConfig;
 import org.neo4j.gds.wcc.WccWriteConfig;
 
 import java.util.Optional;
@@ -52,6 +54,7 @@
 import static org.neo4j.gds.applications.algorithms.metadata.LabelForProgressTracking.LabelPropagation;
 import static org.neo4j.gds.applications.algorithms.metadata.LabelForProgressTracking.Leiden;
 import static org.neo4j.gds.applications.algorithms.metadata.LabelForProgressTracking.Louvain;
+import static org.neo4j.gds.applications.algorithms.metadata.LabelForProgressTracking.ModularityOptimization;
 import static org.neo4j.gds.applications.algorithms.metadata.LabelForProgressTracking.WCC;
 
 public final class CommunityAlgorithmsWriteModeBusinessFacade {
@@ -198,6 +201,24 @@ public <RESULT> RESULT louvain(
         );
     }
 
+    public <RESULT> RESULT modularityOptimization(
+        GraphName graphName,
+        ModularityOptimizationWriteConfig configuration,
+        ResultBuilder<ModularityOptimizationWriteConfig, ModularityOptimizationResult, RESULT, NodePropertiesWritten> resultBuilder
+    ) {
+        var writeStep = new ModularityOptimizationWriteStep(writeToDatabase, configuration);
+
+        return algorithmProcessingTemplate.processAlgorithm(
+            graphName,
+            configuration,
+            ModularityOptimization,
+            estimationFacade::modularityOptimization,
+            graph -> algorithms.modularityOptimization(graph, configuration),
+            Optional.of(writeStep),
+            resultBuilder
+        );
+    }
+
     public <RESULT> RESULT wcc(
         GraphName graphName,
         WccWriteConfig configuration,