Skip to content

Changed docs to reflect need for undirected graph in wcc algo #3322

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
rapids-bot merged 4 commits into from
Mar 9, 2023
Merged

Changed docs to reflect need for undirected graph in wcc algo #3322

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
25baa05
changed docs to reflect need for undirected graph in wcc algo
acostadon Mar 8, 2023
6e827f2
fixed comment per style check issue
acostadon Mar 8, 2023
f725af8
took out space in blank line for style check
acostadon Mar 8, 2023
a7dead6
Merge branch 'branch-23.04' into issue-3133
BradReesWork Mar 9, 2023
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
9 changes: 6 additions & 3 deletions python/cugraph/cugraph/components/connectivity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,9 @@ def weakly_connected_components(G, directed=None, connection=None, return_labels

Graph or matrix object, which should contain the connectivity
information (edge weights are not used for this algorithm). If using a
graph object, the graph can be either directed or undirected where an
graph object, the graph must be undirected where an
undirected edge is represented by a directed edge in both directions.
The adjacency list will be computed if not already present. The number
The adjacency list will be computed if not already present. The number
of vertices should fit into a 32b int.

directed : bool, optional (default=None)
Expand Down Expand Up @@ -174,7 +174,6 @@ def weakly_connected_components(G, directed=None, connection=None, return_labels
>>> df = cugraph.weakly_connected_components(G)

"""

(directed, connection, return_labels) = _ensure_args(
"weakly_connected_components", G, directed, connection, return_labels
)
Expand Down Expand Up @@ -331,6 +330,10 @@ def connected_components(G, directed=None, connection="weak", return_labels=None

connection : str, optional (default='weak')

NOTE
For Graph-type values of G, weak components are only
supported for undirected graphs.

[‘weak’|’strong’]. Return either weakly or strongly connected
components.

Expand Down