From 0e5a9bae1c21a1ffd67d68f6d5b375ae44a66157 Mon Sep 17 00:00:00 2001 From: jnke2016 Date: Wed, 2 Oct 2024 08:00:58 -0700 Subject: [PATCH] update docstrings --- python/cugraph/cugraph/structure/graph_classes.py | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/python/cugraph/cugraph/structure/graph_classes.py b/python/cugraph/cugraph/structure/graph_classes.py index 793ee968ef8..84234f7e904 100644 --- a/python/cugraph/cugraph/structure/graph_classes.py +++ b/python/cugraph/cugraph/structure/graph_classes.py @@ -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 -------- @@ -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 --------