repairing memory estimations for KNN after addition of instrumentation

Author: lassewesth

algo/src/main/java/org/neo4j/gds/similarity/knn/KnnFactory.java

@@ -97,6 +97,7 @@ public MemoryEstimation memoryEstimation(CONFIG configuration) {
                             sizeOfIntArray(sizeOfOpenHashContainer(sampledK)) * concurrency
                         )
                     )
+                    .add(MemoryEstimations.of("neighbour-consumers", MemoryRange.of(sizeOfInstance(NeighbourConsumers.class))))
                     .build();
             }
         );

doc/asciidoc/algorithms/knn/knn.adoc

@@ -464,7 +464,7 @@ YIELD nodeCount, bytesMin, bytesMax, requiredMemory
 [opts="header", cols="1,1,1,1"]
 |===
 | nodeCount | bytesMin | bytesMax | requiredMemory
-| 5         | 2040     | 3096     | "[2040 Bytes \... 3096 Bytes]"
+| 5         | 2096     | 3152     | "[2096 Bytes \... 3152 Bytes]"
 |===
 --
 

proc/machine-learning/src/test/java/org/neo4j/gds/ml/linkmodels/pipeline/predict/ApproximateLinkPredictionTest.java

@@ -261,7 +261,7 @@ void estimate() {
             .estimate(config)
             .estimate(GraphDimensions.of(100, 1000), config.concurrency());
 
-        assertThat(actualEstimate.memoryUsage().toString()).isEqualTo("[23 KiB ... 42 KiB]");
+        assertThat(actualEstimate.memoryUsage().toString()).isEqualTo("[24 KiB ... 43 KiB]");
     }
 
     static Comparator<PredictedLink> compareWithPrecision(double precision) {

proc/similarity/src/test/java/org/neo4j/gds/similarity/knn/KnnFactoryTest.java

@@ -110,9 +110,9 @@ private void assertEstimation(
         KnnSampler.SamplerType initialSampler,
         MemoryRange actual
     ) {
-        long knnAlgo = /* KNN */ 56;
+        long knnAlgo = /* KNN */ 64;
 
-        long topKNeighborList = /* NL */ 24 + sizeOfLongArray(boundedK * 2);
+        long topKNeighborList = /* NL */ 32 + sizeOfLongArray(boundedK * 2L);
         long topKNeighborsList = /* HOA */ sizeOfHugeArrayInstance + sizeOfHugeArray + nodeCount * topKNeighborList;
 
         long tempNeighborsListMin = /* HOA */ sizeOfHugeArrayInstance + sizeOfHugeArray;
@@ -121,8 +121,10 @@ private void assertEstimation(
         var randomList = KnnFactory.initialSamplerMemoryEstimation(initialSampler, boundedK);
         long sampledList = sizeOfIntArray(sizeOfOpenHashContainer(sampledK));
 
-        long expectedMin = knnAlgo + topKNeighborsList + 4 * tempNeighborsListMin + randomList.min + sampledList;
-        long expectedMax = knnAlgo + topKNeighborsList + 4 * tempNeighborsListMax + randomList.max + sampledList;
+        long neighbourConsumers = 8;
+
+        long expectedMin = knnAlgo + topKNeighborsList + 4 * tempNeighborsListMin + randomList.min + sampledList + neighbourConsumers;
+        long expectedMax = knnAlgo + topKNeighborsList + 4 * tempNeighborsListMax + randomList.max + sampledList + neighbourConsumers;
 
         assertEquals(expectedMin, actual.min);
         assertEquals(expectedMax, actual.max);