Merge pull request #903 from brs96/apsp-mem-est

Add APSP mem est in doc

Author: brs96

doc/sphinx/algorithms.json

@@ -119,6 +119,14 @@
     },
     "description": "The All Pairs Shortest Path (APSP) calculates the shortest (weighted) path\nbetween all pairs of nodes."
   },
+  {
+    "function": {
+      "name": "gds.allShortestPaths.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.alpha.allShortestPaths.stream",

doc/sphinx/source/algorithms.rst

@@ -74,6 +74,10 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
     The All Pairs Shortest Path (APSP) calculates the shortest (weighted) path
     between all pairs of nodes.
 
+.. py:function:: gds.allShortestPaths.stream.estimate(G: Graph, **config: Any) -> Series[Any]
+
+    Returns an estimation of the memory consumption for that procedure.
+
 .. py:function:: gds.alpha.allShortestPaths.stream(G: Graph, **config: Any) -> DataFrame
 
     The All Pairs Shortest Path (APSP) calculates the shortest (weighted) path