Skip to content

Commit

Permalink
update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
jnke2016 committed Oct 2, 2024
1 parent ec7da8d commit 0e5a9ba
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions python/cugraph/cugraph/structure/graph_classes.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,11 @@ def from_cudf_edgelist(
symmetrize: bool, optional (default=None)
If True, symmetrize the edge list for an undirected graph. Setting
this flag to True for a directed graph returns an error. The default
behavior symmetrizes the edges if the graph is undirected. If the edges
are already symmetric, set this flag to False.
behavior symmetrizes the edges if the graph is undirected. This flag
cannot be set to True if the edgelist contains edge IDs or edge Types.
If the incoming edgelist is intended for an undirected graph and it is
known to be symmetric, this flag can be set to False to skip the
symmetrization step for better performance.
Examples
--------
Expand Down Expand Up @@ -259,8 +262,11 @@ def from_cudf_adjlist(
symmetrize: bool, optional (default=None)
If True, symmetrize the edge list for an undirected graph. Setting
this flag to True for a directed graph returns an error. The default
behavior symmetrizes the edges if the graph is undirected. If the edges
are already symmetric, set this flag to False.
behavior symmetrizes the edges if the graph is undirected. This flag
cannot be set to True if the edgelist contains edge IDs or edge Types.
If the incoming edgelist is intended for an undirected graph and it is
known to be symmetric, this flag can be set to False to skip the
symmetrization step for better performance.
Examples
--------
Expand Down

0 comments on commit 0e5a9ba

Please sign in to comment.