Use WalkPArameters param object in Node2Vec

Author: jjaderberg

algo/src/main/java/org/neo4j/gds/embeddings/node2vec/Node2Vec.java

@@ -31,6 +31,7 @@
 import org.neo4j.gds.mem.MemoryUsage;
 import org.neo4j.gds.ml.core.EmbeddingUtils;
 import org.neo4j.gds.traversal.RandomWalkCompanion;
+import org.neo4j.gds.traversal.WalkParameters;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -45,10 +46,7 @@ public class Node2Vec extends Algorithm<Node2VecModel.Result> {
     private final double positiveSamplingFactor;
     private final double negativeSamplingExponent;
     private final int concurrency;
-    private final int walksPerNode;
-    private final int walkLength;
-    private final double inOutFactor;
-    private final double returnFactor;
+    private final WalkParameters walkParameters;
     private final List<Long> sourceNodes;
     private final Optional<Long> maybeRandomSeed;
     private final double initialLearningRate;
@@ -78,10 +76,7 @@ static Node2Vec create(Graph graph, Node2VecBaseConfig config, ProgressTracker p
             config.concurrency(),
             config.positiveSamplingFactor(),
             config.negativeSamplingExponent(),
-            config.walksPerNode(),
-            config.walkLength(),
-            config.inOutFactor(),
-            config.returnFactor(),
+            config.walkParameters(),
             config.sourceNodes(),
             config.randomSeed(),
             progressTracker,
@@ -100,10 +95,7 @@ public Node2Vec(
         int concurrency,
         double positiveSamplingFactor,
         double negativeSamplingExponent,
-        int walksPerNode,
-        int walkLength,
-        double inOutFactor,
-        double returnFactor,
+        WalkParameters walkParameters,
         List<Long> sourceNodes,
         Optional<Long> maybeRandomSeed,
         ProgressTracker progressTracker,
@@ -122,10 +114,7 @@ public Node2Vec(
         this.positiveSamplingFactor = positiveSamplingFactor;
         this.negativeSamplingExponent = negativeSamplingExponent;
         this.concurrency = concurrency;
-        this.walksPerNode = walksPerNode;
-        this.walkLength = walkLength;
-        this.inOutFactor = inOutFactor;
-        this.returnFactor = returnFactor;
+        this.walkParameters = walkParameters;
         this.sourceNodes = sourceNodes;
         this.maybeRandomSeed = maybeRandomSeed;
         this.initialLearningRate = initialLearningRate;
@@ -157,7 +146,7 @@ public Node2VecModel.Result compute() {
             negativeSamplingExponent,
             concurrency
         );
-        var walks = new CompressedRandomWalks(graph.nodeCount() * walksPerNode);
+        var walks = new CompressedRandomWalks(graph.nodeCount() * walkParameters.walksPerNode);
 
         progressTracker.beginSubTask("RandomWalk");
 
@@ -168,10 +157,7 @@ public Node2VecModel.Result compute() {
             maybeRandomSeed,
             concurrency,
             sourceNodes,
-            walksPerNode,
-            walkLength,
-            inOutFactor,
-            returnFactor,
+            walkParameters,
             DefaultPool.INSTANCE,
             progressTracker,
             terminationFlag
@@ -222,10 +208,7 @@ private List<Node2VecRandomWalkTask> tasks(
         Optional<Long> maybeRandomSeed,
         int concurrency,
         List<Long> sourceNodes,
-        int walksPerNode,
-        int walkLength,
-        double inOutFactor,
-        double returnFactor,
+        WalkParameters walkParameters,
         ExecutorService executorService,
         ProgressTracker progressTracker,
         TerminationFlag terminationFlag
@@ -245,17 +228,17 @@ private List<Node2VecRandomWalkTask> tasks(
             tasks.add(new Node2VecRandomWalkTask(
                 graph.concurrentCopy(),
                 nextNodeSupplier,
-                walksPerNode,
+                walkParameters.walksPerNode,
                 cumulativeWeightsSupplier,
                 progressTracker,
                 terminationFlag,
                 index,
                 compressedRandomWalks,
                 randomWalkPropabilitiesBuilder,
                 randomSeed,
-                walkLength,
-                returnFactor,
-                inOutFactor
+                walkParameters.walkLength,
+                walkParameters.returnFactor,
+                walkParameters.inOutFactor
             ));
         }
         return tasks;

algo/src/main/java/org/neo4j/gds/traversal/WalkParameters.java

@@ -23,10 +23,10 @@
  * Parameter object holding Random Walk parameters.
  */
 public class WalkParameters {
-    final int walksPerNode;
-    final int walkLength;
-    final double returnFactor;
-    final double inOutFactor;
+    public final int walksPerNode;
+    public final int walkLength;
+    public final double returnFactor;
+    public final double inOutFactor;
 
     public WalkParameters(int walksPerNode, int walkLength, double returnFactor, double inOutFactor) {
         this.walksPerNode = walksPerNode;