Hits mutate procedure facade

Author: IoannisPanagiotas

applications/algorithms/centrality/src/main/java/org/neo4j/gds/applications/algorithms/centrality/CentralityAlgorithmsMutateModeBusinessFacade.java

@@ -26,6 +26,7 @@
 import org.neo4j.gds.applications.algorithms.machinery.ResultBuilder;
 import org.neo4j.gds.applications.algorithms.metadata.NodePropertiesWritten;
 import org.neo4j.gds.articulationpoints.ArticulationPointsMutateConfig;
+import org.neo4j.gds.beta.pregel.PregelResult;
 import org.neo4j.gds.betweenness.BetweennessCentralityMutateConfig;
 import org.neo4j.gds.betweenness.BetwennessCentralityResult;
 import org.neo4j.gds.closeness.ClosenessCentralityMutateConfig;
@@ -34,6 +35,7 @@
 import org.neo4j.gds.degree.DegreeCentralityResult;
 import org.neo4j.gds.harmonic.HarmonicCentralityMutateConfig;
 import org.neo4j.gds.harmonic.HarmonicResult;
+import org.neo4j.gds.hits.HitsConfig;
 import org.neo4j.gds.indirectExposure.IndirectExposureMutateConfig;
 import org.neo4j.gds.indirectExposure.IndirectExposureResult;
 import org.neo4j.gds.influenceMaximization.CELFResult;
@@ -43,13 +45,17 @@
 import org.neo4j.gds.pagerank.PageRankMutateConfig;
 import org.neo4j.gds.pagerank.PageRankResult;
 
+import java.util.List;
+import java.util.Optional;
+
 import static org.neo4j.gds.applications.algorithms.machinery.AlgorithmLabel.ArticleRank;
 import static org.neo4j.gds.applications.algorithms.machinery.AlgorithmLabel.ArticulationPoints;
 import static org.neo4j.gds.applications.algorithms.machinery.AlgorithmLabel.BetweennessCentrality;
 import static org.neo4j.gds.applications.algorithms.machinery.AlgorithmLabel.CELF;
 import static org.neo4j.gds.applications.algorithms.machinery.AlgorithmLabel.ClosenessCentrality;
 import static org.neo4j.gds.applications.algorithms.machinery.AlgorithmLabel.DegreeCentrality;
 import static org.neo4j.gds.applications.algorithms.machinery.AlgorithmLabel.EigenVector;
+import static org.neo4j.gds.applications.algorithms.machinery.AlgorithmLabel.HITS;
 import static org.neo4j.gds.applications.algorithms.machinery.AlgorithmLabel.HarmonicCentrality;
 import static org.neo4j.gds.applications.algorithms.machinery.AlgorithmLabel.IndirectExposure;
 import static org.neo4j.gds.applications.algorithms.machinery.AlgorithmLabel.PageRank;
@@ -59,17 +65,21 @@ public class CentralityAlgorithmsMutateModeBusinessFacade {
     private final CentralityAlgorithms algorithms;
     private final AlgorithmProcessingTemplateConvenience algorithmProcessingTemplateConvenience;
     private final MutateNodeProperty mutateNodeProperty;
+    private final HitsHookGenerator hitsHookGenerator;
+
 
     public CentralityAlgorithmsMutateModeBusinessFacade(
         CentralityAlgorithmsEstimationModeBusinessFacade estimation,
         CentralityAlgorithms algorithms,
         AlgorithmProcessingTemplateConvenience algorithmProcessingTemplateConvenience,
-        MutateNodeProperty mutateNodeProperty
+        MutateNodeProperty mutateNodeProperty,
+        HitsHookGenerator hitsHookGenerator
     ) {
         this.estimation = estimation;
         this.algorithms = algorithms;
         this.algorithmProcessingTemplateConvenience = algorithmProcessingTemplateConvenience;
         this.mutateNodeProperty = mutateNodeProperty;
+        this.hitsHookGenerator = hitsHookGenerator;
     }
 
     public <RESULT> RESULT articleRank(
@@ -253,5 +263,26 @@ public <RESULT> RESULT indirectExposure(
         );
     }
 
+    public <RESULT> RESULT hits(
+        GraphName graphName,
+        HitsConfig configuration,
+        ResultBuilder<HitsConfig, PregelResult, RESULT, NodePropertiesWritten> resultBuilder
+    ) {
+        var mutateStep = new HitsMutateStep(mutateNodeProperty, configuration);
+        var hook = hitsHookGenerator.createETLHook(configuration);
+        return algorithmProcessingTemplateConvenience.processAlgorithmInMutateMode(
+            Optional.empty(),
+            graphName,
+            configuration,
+            Optional.empty(),
+            Optional.of(List.of(hook)),
+            HITS,
+            estimation::hits,
+            (graph, __) -> algorithms.hits(graph, configuration),
+            mutateStep,
+            resultBuilder
+        );
+    }
+
 
 }

applications/algorithms/centrality/src/main/java/org/neo4j/gds/applications/algorithms/centrality/CentralityApplications.java

@@ -69,7 +69,8 @@ public static CentralityApplications create(
             estimation,
             algorithms,
             algorithmProcessingTemplateConvenience,
-            mutateNodeProperty
+            mutateNodeProperty,
+            hitsHookGenerator
         );
         var stats = new CentralityAlgorithmsStatsModeBusinessFacade(
             estimation,

applications/algorithms/centrality/src/main/java/org/neo4j/gds/applications/algorithms/centrality/HitsHookGenerator.java

@@ -23,12 +23,12 @@
 import org.neo4j.gds.hits.HitsConfig;
 import org.neo4j.gds.termination.TerminationFlag;
 
-class HitsHookGenerator {
+public class HitsHookGenerator {
 
     private final ProgressTrackerCreator progressTrackerCreator;
     private final TerminationFlag terminationFlag;
 
-    HitsHookGenerator(ProgressTrackerCreator progressTrackerCreator, TerminationFlag terminationFlag) {
+    public HitsHookGenerator(ProgressTrackerCreator progressTrackerCreator, TerminationFlag terminationFlag) {
         this.progressTrackerCreator = progressTrackerCreator;
         this.terminationFlag = terminationFlag;
     }

applications/algorithms/centrality/src/main/java/org/neo4j/gds/applications/algorithms/centrality/HitsMutateStep.java

@@ -0,0 +1,76 @@
+/*
+ * 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.centrality;
+
+import org.neo4j.gds.api.Graph;
+import org.neo4j.gds.api.GraphStore;
+import org.neo4j.gds.api.properties.nodes.NodePropertyValues;
+import org.neo4j.gds.api.properties.nodes.NodePropertyValuesAdapter;
+import org.neo4j.gds.applications.algorithms.machinery.MutateNodeProperty;
+import org.neo4j.gds.applications.algorithms.machinery.MutateStep;
+import org.neo4j.gds.applications.algorithms.metadata.NodePropertiesWritten;
+import org.neo4j.gds.beta.pregel.PregelResult;
+import org.neo4j.gds.hits.HitsConfig;
+
+class HitsMutateStep implements MutateStep<PregelResult, NodePropertiesWritten> {
+    private final MutateNodeProperty mutateNodeProperty;
+    private final HitsConfig configuration;
+
+    HitsMutateStep(
+        MutateNodeProperty mutateNodeProperty,
+        HitsConfig configuration) {
+        this.mutateNodeProperty = mutateNodeProperty;
+        this.configuration = configuration;
+    }
+
+    @Override
+    public NodePropertiesWritten execute(
+        Graph graph,
+        GraphStore graphStore,
+        PregelResult result
+    ) {
+        var authValues = NodePropertyValuesAdapter.adapt(result.nodeValues().doubleProperties(configuration.authProperty()));
+        var hubValues = NodePropertyValuesAdapter.adapt(result.nodeValues().doubleProperties(configuration.authProperty()));
+        var authProperty = configuration.authProperty().concat(configuration.mutateProperty());
+        var hubProperty = configuration.hubProperty().concat(configuration.mutateProperty());
+
+        var authWritten = mutate(graph, graphStore, authProperty,authValues);
+        var hubWritten = mutate(graph, graphStore, hubProperty,hubValues);
+
+        return new NodePropertiesWritten(
+            authWritten.value() + hubWritten.value()
+        );
+    }
+
+    private NodePropertiesWritten mutate(
+        Graph graph,
+        GraphStore graphStore,
+        String mutateProperty,
+        NodePropertyValues values
+    ) {
+        return mutateNodeProperty.mutateNodeProperties(
+            graph,
+            graphStore,
+            configuration.nodeLabelIdentifiers(graphStore),
+            mutateProperty,
+            values
+        );
+    }
+}

applications/algorithms/machinery/src/main/java/org/neo4j/gds/applications/algorithms/machinery/AlgorithmLabel.java

@@ -117,6 +117,7 @@ public static Label from(Algorithm algorithm) {
             case FilteredNodeSimilarity -> FilteredNodeSimilarity;
             case GraphSage -> GraphSage;
             case GraphSageTrain -> GraphSageTrain;
+            case HITS -> HITS;
             case HarmonicCentrality -> HarmonicCentrality;
             case HashGNN -> HashGNN;
             case IndexInverse -> IndexInverse;

applications/algorithms/machinery/src/main/java/org/neo4j/gds/applications/algorithms/metadata/Algorithm.java

@@ -51,6 +51,7 @@ public enum Algorithm {
     FilteredNodeSimilarity,
     GraphSage,
     GraphSageTrain,
+    HITS,
     HarmonicCentrality,
     HashGNN,
     IndexInverse,

pipeline/src/main/java/org/neo4j/gds/ml/pipeline/ConfigurationParsersForMutateMode.java

@@ -34,6 +34,7 @@
 import org.neo4j.gds.embeddings.hashgnn.HashGNNMutateConfig;
 import org.neo4j.gds.embeddings.node2vec.Node2VecMutateConfig;
 import org.neo4j.gds.harmonic.HarmonicCentralityMutateConfig;
+import org.neo4j.gds.hits.HitsConfig;
 import org.neo4j.gds.indexInverse.InverseRelationshipsConfig;
 import org.neo4j.gds.influenceMaximization.InfluenceMaximizationMutateConfig;
 import org.neo4j.gds.k1coloring.K1ColoringMutateConfig;
@@ -105,6 +106,7 @@ public Function<CypherMapWrapper, AlgoBaseConfig> lookup(Algorithm algorithm) {
             case FilteredNodeSimilarity -> FilteredNodeSimilarityMutateConfig::of;
             case GraphSage -> graphSageParser();
             case GraphSageTrain -> null;
+            case HITS -> HitsConfig::of;
             case HarmonicCentrality -> HarmonicCentralityMutateConfig::of;
             case HashGNN -> HashGNNMutateConfig::of;
             case IndexInverse -> InverseRelationshipsConfig::of;

pipeline/src/main/java/org/neo4j/gds/ml/pipeline/MutateModeAlgorithmLibrary.java

@@ -81,6 +81,7 @@ static CanonicalProcedureName algorithmToName(Algorithm algorithm) {
             case FilteredNodeSimilarity -> CanonicalProcedureName.parse("gds.nodeSimilarity.filtered");
             case GraphSage -> CanonicalProcedureName.parse("gds.beta.graphSage");
             case GraphSageTrain -> null;
+            case HITS -> CanonicalProcedureName.parse("gds.hits");
             case HarmonicCentrality -> CanonicalProcedureName.parse("gds.closeness.harmonic");
             case HashGNN -> CanonicalProcedureName.parse("gds.hashgnn");
             case IndexInverse -> CanonicalProcedureName.parse("gds.graph.relationships.indexInverse");

pipeline/src/main/java/org/neo4j/gds/ml/pipeline/StubbyHolder.java

@@ -39,6 +39,7 @@
 import org.neo4j.gds.ml.pipeline.stubs.GraphSageStub;
 import org.neo4j.gds.ml.pipeline.stubs.HarmonicCentralityStub;
 import org.neo4j.gds.ml.pipeline.stubs.HashGnnStub;
+import org.neo4j.gds.ml.pipeline.stubs.HitsStub;
 import org.neo4j.gds.ml.pipeline.stubs.IndexInverseStub;
 import org.neo4j.gds.ml.pipeline.stubs.K1ColoringStub;
 import org.neo4j.gds.ml.pipeline.stubs.KCoreStub;
@@ -104,6 +105,7 @@ Stub get(Algorithm algorithm) {
             case FilteredNodeSimilarity -> new FilteredNodeSimilarityStub();
             case GraphSage -> new GraphSageStub();
             case GraphSageTrain -> null;
+            case HITS -> new HitsStub();
             case HarmonicCentrality -> new HarmonicCentralityStub();
             case HashGNN -> new HashGnnStub();
             case IndexInverse -> new IndexInverseStub();

pipeline/src/main/java/org/neo4j/gds/ml/pipeline/stubs/HitsStub.java

@@ -0,0 +1,31 @@
+/*
+ * 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.ml.pipeline.stubs;
+
+import org.neo4j.gds.hits.HitsConfig;
+import org.neo4j.gds.procedures.algorithms.AlgorithmsProcedureFacade;
+import org.neo4j.gds.procedures.algorithms.centrality.HitsMutateResult;
+import org.neo4j.gds.procedures.algorithms.stubs.MutateStub;
+
+public class HitsStub extends AbstractStub<HitsConfig, HitsMutateResult> {
+    protected MutateStub<HitsConfig, HitsMutateResult> stub(AlgorithmsProcedureFacade facade) {
+        return facade.centrality().hitsMutateStub();
+    }
+}