Skip to content

Commit 8724c06

Browse files
committed
Add gds.graph.filter to reference docs
1 parent ca3c549 commit 8724c06

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

doc/sphinx/source/graph.rst

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
5454
.. deprecated:: 2.5.0
5555
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.generate` instead.
5656

57-
.. py:function:: gds.beta.graph.project.subgraph(graph_name: str,from_G: Graph, node_filter: str,relationship_filter: str,**config: Any,) -> GraphCreateResult
57+
.. py:function:: gds.beta.graph.project.subgraph(graph_name: str, from_G: Graph, node_filter: str, relationship_filter: str, **config: Any,) -> GraphCreateResult
5858
59-
Creates a named graph in the catalog for use by algorithms.
59+
Filters down a graph projection to a named subgraph projection in the catalog for use by algorithms.
6060

6161
.. deprecated:: 2.5.0
6262
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.filter` instead.
@@ -159,9 +159,12 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
159159
160160
Returns an estimation of the memory consumption for that procedure.
161161

162-
.. py:function:: gds.graph.project.subgraph(graph_name: str,from_G: Graph,node_filter: str,relationship_filter: str,**config: Any,) -> GraphCreateResult
162+
.. py:function:: gds.graph.project.subgraph(graph_name: str, from_G: Graph, node_filter: str, relationship_filter: str, **config: Any,) -> GraphCreateResult
163163
164-
Creates a named graph in the catalog for use by algorithms.
164+
Filters down a graph projection to a named subgraph projection in the catalog for use by algorithms.
165+
166+
.. deprecated:: 2.5.0
167+
Since GDS server version 2.5.0 you should use the endpoint :func:`gds.graph.filter` instead.
165168

166169
.. py:function:: gds.graph.relationships.stream(G: Graph, relationship_types: List[str] = ["*"], **config: Any) -> TopologyDataFrame
167170
@@ -260,3 +263,7 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
260263

261264
.. py:function:: gds.graph.nodeLabel.write(G: Graph, node_label: str, **config: Any) -> Series[Any]
262265
Writes the given node Label to an online Neo4j database.
266+
267+
.. py:function:: gds.graph.filter(graph_name: str, from_G: Graph, node_filter: str, relationship_filter: str, **config: Any,) -> GraphCreateResult
268+
269+
Filters down a graph projection to a named subgraph projection in the catalog for use by algorithms.

0 commit comments

Comments
 (0)