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

Update the docstrings of the similarity algorithms #3817

Merged
merged 2 commits into from
Aug 25, 2023
Merged

Update the docstrings of the similarity algorithms #3817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09a2648
update docstrings with accurate column names
Aug 22, 2023
6bfbe0e
Merge remote-tracking branch 'upstream/branch-23.10' into branch-23.1…
Aug 22, 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
14 changes: 7 additions & 7 deletions python/cugraph/cugraph/link_prediction/jaccard.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,13 +96,13 @@ def jaccard(input_graph, vertex_pair=None, do_expensive_check=True):
relative to the adjacency list, or that given by the specified vertex
pairs.

df['source'] : cudf.Series
The source vertex ID (will be identical to first if specified).
df['destination'] : cudf.Series
The destination vertex ID (will be identical to second if
df['first'] : cudf.Series
The first vertex ID of each pair (will be identical to first if specified).
df['second'] : cudf.Series
the second vertex ID of each pair (will be identical to second if
specified).
df['jaccard_coeff'] : cudf.Series
The computed jaccard coefficient between the first and the second
The computed Jaccard coefficient between the first and the second
vertex ID.

Examples
Expand Down Expand Up @@ -182,8 +182,8 @@ def jaccard_coefficient(G, ebunch=None, do_expensive_check=True):
the second vertex ID of each pair (will be identical to second if
specified).
df['jaccard_coeff'] : cudf.Series
The computed Jaccard coefficient between the source and destination
vertices.
The computed Jaccard coefficient between the first and the second
vertex ID.

Examples
--------
Expand Down
14 changes: 7 additions & 7 deletions python/cugraph/cugraph/link_prediction/sorensen.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ def sorensen(input_graph, vertex_pair=None, do_expensive_check=True):
specified)

df['sorensen_coeff'] : cudf.Series
The computed Sorensen coefficient between the source and
destination vertices
The computed Sorensen coefficient between the first and the second
vertex ID.

Examples
--------
Expand Down Expand Up @@ -149,13 +149,13 @@ def sorensen_coefficient(G, ebunch=None, do_expensive_check=True):
relative to the adjacency list, or that given by the specified vertex
pairs.

df['source'] : cudf.Series
The source vertex ID (will be identical to first if specified).
df['destination'] : cudf.Series
The destination vertex ID (will be identical to second if
df['first'] : cudf.Series
The first vertex ID of each pair (will be identical to first if specified).
df['second'] : cudf.Series
the second vertex ID of each pair (will be identical to second if
specified).
df['sorensen_coeff'] : cudf.Series
The computed sorensen coefficient between the first and the second
The computed Sorensen coefficient between the first and the second
vertex ID.

Examples
Expand Down