Skip to content

Max flow estimation endpoints #968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 6, 2025
Merged

Max flow estimation endpoints #968

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions doc/sphinx/algorithms.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand Down
16 changes: 16 additions & 0 deletions doc/sphinx/source/algorithms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down