Skip to content
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

Jump to bottom

Fix BFS Docstring #2318

Merged
merged 11 commits into from
Jun 1, 2022
Merged

Fix BFS Docstring #2318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
fb2d21c
Merge pull request #1 from rapidsai/branch-22.06
alexbarghi-nv May 16, 2022
cfdb13b
Merge branch 'rapidsai:branch-22.06' into branch-22.06
alexbarghi-nv May 17, 2022
a151b63
Merge pull request #2 from rapidsai/branch-22.06
alexbarghi-nv May 17, 2022
3b9914f
Add Alex B's mg_bfs_test, add mg_sssp_test, fix support for MG in bfs…
ChuckHastings May 19, 2022
0dbe0b5
Merge pull request #3 from ChuckHastings/fix_add_shuffle_to_capi_algo…
alexbarghi-nv May 19, 2022
8660b86
fix merge conflict
alexbarghi-nv May 31, 2022
9068016
update docstring for bfs and dask bfs
alexbarghi-nv May 31, 2022
a3dc3cf
fix file
alexbarghi-nv May 31, 2022
ca4bf84
fix typo
alexbarghi-nv May 31, 2022
fab8929
fix style
alexbarghi-nv May 31, 2022
9261d30
remove mention of undefined behavior
alexbarghi-nv May 31, 2022
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
10 changes: 6 additions & 4 deletions python/cugraph/cugraph/dask/traversal/bfs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,14 @@ def bfs(input_graph,
----------
input_graph : cugraph.Graph
cuGraph graph instance, should contain the connectivity information
as dask cudf edge list dataframe(edge weights are not used for this
as dask cudf edge list dataframe (edge weights are not used for this
algorithm).

start : Integer
Specify starting vertex for breadth-first search; this function
iterates over edges in the component reachable from this node.
start : Integer or list
The id of the graph vertex from which the traversal begins, or
if a list, the vertex from which the traversal begins in each
component of the graph. Only one vertex per connected
component of the graph is allowed.

depth_limit : Integer or None, optional (default=None)
Limit the depth of the search
Expand Down
7 changes: 5 additions & 2 deletions python/cugraph/cugraph/traversal/bfs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,11 @@ def bfs(G,
information. Edge weights, if present, should be single or double
precision floating point values.

start : Integer, optional (default=None)
The index of the graph vertex from which the traversal begins
start : Integer or list, optional (default=None)
The id of the graph vertex from which the traversal begins, or
if a list, the vertex from which the traversal begins in each
component of the graph. Only one vertex per connected
component of the graph is allowed.

depth_limit : Integer or None, optional (default=None)
Limit the depth of the search
Expand Down