From 946b033b9a0993e4237e7a5e0027d0a0342d384a Mon Sep 17 00:00:00 2001 From: jnke2016 Date: Sun, 10 Nov 2024 21:34:20 -0800 Subject: [PATCH] update docstrings --- .../cugraph/structure/decompress_to_edgelist.py | 15 ++++----------- .../pylibcugraph/decompress_to_edgelist.pyx | 2 +- 2 files changed, 5 insertions(+), 12 deletions(-) diff --git a/python/cugraph/cugraph/structure/decompress_to_edgelist.py b/python/cugraph/cugraph/structure/decompress_to_edgelist.py index d8f64ca780..3d60fcf773 100644 --- a/python/cugraph/cugraph/structure/decompress_to_edgelist.py +++ b/python/cugraph/cugraph/structure/decompress_to_edgelist.py @@ -23,19 +23,13 @@ def decompress_to_edgelist( do_expensive_check: bool ) -> cudf.DataFrame: """ - Compute a subgraph of the existing graph including only the specified - vertices. This algorithm works with both directed and undirected graphs - and does not actually traverse the edges, but instead simply pulls out any - edges that are incident on vertices that are both contained in the vertices - list. - - If no subgraph can be extracted from the vertices provided, a 'None' value - will be returned. + Extract a the edgelist from a graph. Parameters ---------- - G : cugraph.Graph or networkx.Graph - The current implementation only supports weighted graphs. + G : cugraph.Graph + cuGraph graph descriptor, should contain the connectivity information + as an edge list. do_expensive_check: bool @@ -54,7 +48,6 @@ def decompress_to_edgelist( >>> verts[0] = 0 >>> verts[1] = 1 >>> verts[2] = 2 - >>> sverts = cudf.Series(verts) >>> edgelist = cugraph.decompress_to_edgelist(G, False) """ diff --git a/python/pylibcugraph/pylibcugraph/decompress_to_edgelist.pyx b/python/pylibcugraph/pylibcugraph/decompress_to_edgelist.pyx index 7fd769babf..a2fc561c76 100644 --- a/python/pylibcugraph/pylibcugraph/decompress_to_edgelist.pyx +++ b/python/pylibcugraph/pylibcugraph/decompress_to_edgelist.pyx @@ -60,7 +60,7 @@ def decompress_to_edgelist(ResourceHandle resource_handle, _GPUGraph graph, bool_t do_expensive_check): """ - extract a the edgelist from a graph + Extract a the edgelist from a graph Parameters ----------