Add PushbackNodeEmbeddingsStatsProcedureFacade

Author: vnickolov

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

@@ -20,6 +20,7 @@
 package org.neo4j.gds.procedures.algorithms.embeddings;
 
 import org.neo4j.gds.applications.algorithms.machinery.MemoryEstimateResult;
+import org.neo4j.gds.procedures.algorithms.embeddings.stats.PushbackNodeEmbeddingsStatsProcedureFacade;
 import org.neo4j.gds.procedures.algorithms.embeddings.stream.PushbackNodeEmbeddingsStreamProcedureFacade;
 import org.neo4j.gds.procedures.algorithms.embeddings.stubs.NodeEmbeddingsStubs;
 
@@ -29,11 +30,14 @@
 public class PushbackNodeEmbeddingsProcedureFacade implements NodeEmbeddingsProcedureFacade {
 
  private final PushbackNodeEmbeddingsStreamProcedureFacade streamProcedureFacade;
+ private final PushbackNodeEmbeddingsStatsProcedureFacade statsProcedureFacade;
 
  public PushbackNodeEmbeddingsProcedureFacade(
- PushbackNodeEmbeddingsStreamProcedureFacade streamProcedureFacade
+ PushbackNodeEmbeddingsStreamProcedureFacade streamProcedureFacade,
+ PushbackNodeEmbeddingsStatsProcedureFacade statsProcedureFacade
  ) {
  this.streamProcedureFacade = streamProcedureFacade;
+ this.statsProcedureFacade = statsProcedureFacade;
  }
 
  @Override
@@ -43,7 +47,7 @@ public NodeEmbeddingsStubs nodeEmbeddingStubs() {
 
  @Override
  public Stream<FastRPStatsResult> fastRPStats(String graphName, Map<String, Object> configuration) {
- return Stream.empty();
+ return statsProcedureFacade.fastRP(graphName, configuration);
  }
 
  @Override
@@ -202,6 +206,7 @@ public Stream<DefaultNodeEmbeddingsStreamResult> node2VecStream(
  Map<String, Object> configuration
  ) {
  return streamProcedureFacade.node2Vec(graphName, configuration);
+
  }
 
  @Override

procedures/pushback-procedures-facade/src/main/java/org/neo4j/gds/procedures/algorithms/embeddings/stats/FastRPStatsResultTransformer.java

@@ -0,0 +1,49 @@
+/*
+ * 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.stats;
+
+import org.neo4j.gds.api.Graph;
+import org.neo4j.gds.embeddings.fastrp.FastRPResult;
+import org.neo4j.gds.procedures.algorithms.embeddings.FastRPStatsResult;
+import org.neo4j.gds.result.TimedAlgorithmResult;
+import org.neo4j.gds.results.ResultTransformer;
+
+import java.util.Map;
+import java.util.stream.Stream;
+
+class FastRPStatsResultTransformer implements ResultTransformer<TimedAlgorithmResult<FastRPResult>, Stream<FastRPStatsResult>> {
+ private final Graph graph;
+ private final Map<String, Object> configuration;
+
+ FastRPStatsResultTransformer(Graph graph, Map<String, Object> configuration) {
+ this.graph = graph;
+ this.configuration = configuration;
+ }
+
+ @Override
+ public Stream<FastRPStatsResult> apply(TimedAlgorithmResult<FastRPResult> algorithmResult) {
+ return Stream.of(new FastRPStatsResult(
+ graph.nodeCount(),
+ -1, // TODO
+ algorithmResult.computeMillis(),
+ configuration
+ ));
+ }
+}

procedures/pushback-procedures-facade/src/main/java/org/neo4j/gds/procedures/algorithms/embeddings/stats/PushbackNodeEmbeddingsStatsProcedureFacade.java

@@ -0,0 +1,59 @@
+/*
+ * 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.stats;
+
+import org.neo4j.gds.api.GraphName;
+import org.neo4j.gds.embeddings.NodeEmbeddingComputeBusinessFacade;
+import org.neo4j.gds.embeddings.fastrp.FastRPConfigTransformer;
+import org.neo4j.gds.embeddings.fastrp.FastRPStatsConfig;
+import org.neo4j.gds.procedures.algorithms.configuration.UserSpecificConfigurationParser;
+import org.neo4j.gds.procedures.algorithms.embeddings.FastRPStatsResult;
+
+import java.util.Map;
+import java.util.stream.Stream;
+
+public class PushbackNodeEmbeddingsStatsProcedureFacade {
+ private final NodeEmbeddingComputeBusinessFacade businessFacade;
+ private final UserSpecificConfigurationParser configurationParser;
+
+ public PushbackNodeEmbeddingsStatsProcedureFacade(
+ NodeEmbeddingComputeBusinessFacade businessFacade,
+ UserSpecificConfigurationParser configurationParser
+ ) {
+ this.businessFacade = businessFacade;
+ this.configurationParser = configurationParser;
+ }
+
+ public Stream<FastRPStatsResult> fastRP(String graphName, Map<String, Object> configuration) {
+ var config = configurationParser.parseConfiguration(configuration, FastRPStatsConfig::of);
+
+ return businessFacade.fastRP(
+ GraphName.parse(graphName),
+ config.toGraphParameters(),
+ config.relationshipWeightProperty(),
+ FastRPConfigTransformer.toParameters(config),
+ config.jobId(),
+ config.logProgress(),
+ graphResources -> new FastRPStatsResultTransformer(graphResources.graph(), config.toMap())
+ ).join();
+ }
+
+
+}

procedures/pushback-procedures-facade/src/test/java/org/neo4j/gds/procedures/algorithms/embeddings/stats/FastRPStatsResultTransformerTest.java

@@ -0,0 +1,84 @@
+/*
+ * 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.stats;
+
+import org.junit.jupiter.api.Test;
+import org.neo4j.gds.api.Graph;
+import org.neo4j.gds.embeddings.fastrp.FastRPResult;
+import org.neo4j.gds.procedures.algorithms.embeddings.FastRPStatsResult;
+import org.neo4j.gds.result.TimedAlgorithmResult;
+
+import java.util.Map;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoMoreInteractions;
+import static org.mockito.Mockito.when;
+
+class FastRPStatsResultTransformerTest {
+
+ @Test
+ void shouldTransformFastRPResultToStatsResultStream() {
+ var graphMock = mock(Graph.class);
+ when(graphMock.nodeCount()).thenReturn(42L);
+
+ var fastRPResultMock = mock(FastRPResult.class);
+ var config = Map.<String, Object>of("dim", 128, "seed", 42);
+
+ var timedResult = new TimedAlgorithmResult<>(fastRPResultMock, 1234);
+
+ var transformer = new FastRPStatsResultTransformer(graphMock, config);
+
+ var resultStream = transformer.apply(timedResult);
+
+ assertThat(resultStream)
+ .hasSize(1)
+ .first()
+ .isEqualTo(new FastRPStatsResult(42L, -1, 1234L, config));
+
+ verify(graphMock, times(1)).nodeCount();
+ verifyNoMoreInteractions(graphMock);
+ }
+
+ @Test
+ void shouldReturnStatsResultWithZeroNodesWhenTimedAlgorithmResultIsEmpty() {
+ var graphMock = mock(Graph.class);
+ when(graphMock.nodeCount()).thenReturn(0L);
+
+ var config = Map.<String, Object>of("dim", 128, "seed", 42);
+
+ var timedResult = TimedAlgorithmResult.empty(FastRPResult.empty());
+
+ var transformer = new FastRPStatsResultTransformer(graphMock, config);
+
+ var resultStream = transformer.apply(timedResult);
+
+ assertThat(resultStream)
+ .hasSize(1)
+ .first()
+ .isEqualTo(new FastRPStatsResult(0L, -1, 0L, config));
+
+ verify(graphMock, times(1)).nodeCount();
+ verifyNoMoreInteractions(graphMock);
+ }
+}