Merge pull request #968 from neo4j/max-flow-estimate

Max flow estimation  endpoints

Author: IoannisPanagiotas

doc/sphinx/algorithms.json

@@ -2686,6 +2686,14 @@
     },
     "description": "Computes the maximum flow between two nodes or sets of nodes in a graph."
   },
+  {
+    "function": {
+      "name": "gds.maxFlow.mutate.estimate",
+      "signature": "G: Graph, **config: Any",
+      "return_type": "Series[Any]"
+    },
+    "description": "Returns an estimation of the memory consumption for that procedure."
+  },
   {
     "function": {
       "name": "gds.maxFlow.stats",
@@ -2694,6 +2702,14 @@
     },
     "description": "Computes the maximum flow between two nodes or sets of nodes in a graph."
   },
+  {
+    "function": {
+      "name": "gds.maxFlow.stats.estimate",
+      "signature": "G: Graph, **config: Any",
+      "return_type": "Series[Any]"
+    },
+    "description": "Returns an estimation of the memory consumption for that procedure."
+  },
   {
     "function": {
       "name": "gds.maxFlow.stream",
@@ -2702,6 +2718,14 @@
     },
     "description": "Computes the maximum flow between two nodes or sets of nodes in a graph."
   },
+  {
+    "function": {
+      "name": "gds.maxFlow.stream.estimate",
+      "signature": "G: Graph, **config: Any",
+      "return_type": "Series[Any]"
+    },
+    "description": "Returns an estimation of the memory consumption for that procedure."
+  },
   {
     "function": {
       "name": "gds.maxFlow.write",
@@ -2710,6 +2734,14 @@
     },
     "description": "Computes the maximum flow between two nodes or sets of nodes in a graph."
   },
+  {
+    "function": {
+      "name": "gds.maxFlow.write.estimate",
+      "signature": "G: Graph, **config: Any",
+      "return_type": "Series[Any]"
+    },
+    "description": "Returns an estimation of the memory consumption for that procedure."
+  },
   {
     "function": {
       "name": "gds.maxkcut.mutate",

doc/sphinx/source/algorithms.rst

@@ -1448,18 +1448,34 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
 
     Computes the maximum flow between two nodes or sets of nodes in a graph.
 
+.. py:function:: gds.maxFlow.mutate.estimate(G: Graph, **config: Any) -> Series[Any]
+
+    Returns an estimation of the memory consumption for that procedure.
+
 .. py:function:: gds.maxFlow.stats(G: Graph, **config: Any) -> Series[Any]
 
     Computes the maximum flow between two nodes or sets of nodes in a graph.
 
+.. py:function:: gds.maxFlow.stats.estimate(G: Graph, **config: Any) -> Series[Any]
+
+    Returns an estimation of the memory consumption for that procedure.
+
 .. py:function:: gds.maxFlow.stream(G: Graph, **config: Any) -> DataFrame
 
     Computes the maximum flow between two nodes or sets of nodes in a graph.
 
+.. py:function:: gds.maxFlow.stream.estimate(G: Graph, **config: Any) -> Series[Any]
+
+    Returns an estimation of the memory consumption for that procedure.
+
 .. py:function:: gds.maxFlow.write(G: Graph, **config: Any) -> Series[Any]
 
     Computes the maximum flow between two nodes or sets of nodes in a graph.
 
+.. py:function:: gds.maxFlow.write.estimate(G: Graph, **config: Any) -> Series[Any]
+
+    Returns an estimation of the memory consumption for that procedure.
+
 .. py:function:: gds.maxkcut.mutate(G: Graph, **config: Any) -> Series[Any]
 
     Approximate Maximum k-cut maps each node into one of k disjoint communities