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

[ENH] datasets API: Update docstrings #2361

Closed
betochimas opened this issue Jun 16, 2022 · 1 comment · Fixed by #2441
Closed

[ENH] datasets API: Update docstrings #2361

betochimas opened this issue Jun 16, 2022 · 1 comment · Fixed by #2441
Assignees
@betochimas
Milestone
22.08

Comments

@betochimas
Copy link
Contributor

Milestone for #1348

Update all Python docstrings to use the updated import pattern. This also includes updating test_docstrings.
@betochimas betochimas added the ? - Needs Triage Need team to review and classify label Jun 16, 2022
@betochimas betochimas self-assigned this Jun 16, 2022
@github-actions
Copy link

This issue has been labeled inactive-30d due to no recent activity in the past 30 days. Please close this issue if no further response or action is needed. Otherwise, please respond with a comment indicating any updates or changes to the original issue and/or confirm this issue still needs to be addressed. This issue will be labeled inactive-90d if there is no activity in the next 60 days.

@oorliu oorliu mentioned this issue Jul 25, 2022
Merged
@rapids-bot rapids-bot bot closed this as completed in #2441 Aug 3, 2022
rapids-bot bot pushed a commit that referenced this issue Aug 3, 2022
@oorliu
Use Datasets API to Update Docstring Examples (#2441)
4dc286e 
closes #2361

Docstring examples now use the new method of creating graphs by using the `datasets` API. This change cleans up the code by eliminating the usage of `cuDF`.

Old docstring example:
```
>>> M = cudf.read_csv(datasets_path / 'karate.csv', delimiter=' ',
...                   dtype=['int32', 'int32', 'float32'], header=None)
>>> G = cugraph.Graph()
>>> G.from_cudf_edgelist(M, source='0', destination='1')
```

Updated docstring example:
```
>>> from cugraph.experimental.datasets import karate
>>> G = karate.get_graph()
```

Authors:
  - Ralph Liu (https://github.com/oorliu)
  - Dylan Chima-Sanchez (https://github.com/betochimas)

Approvers:
  - Rick Ratzel (https://github.com/rlratzel)

URL: #2441
@kingmesal kingmesal removed the ? - Needs Triage Need team to review and classify label Feb 10, 2023
@kingmesal kingmesal added this to the 22.08 milestone Feb 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@betochimas betochimas

Labels
None yet
Projects
None yet
Milestone
22.08
Development

Successfully merging a pull request may close this issue.

Use Datasets API to Update Docstring Examples betochimas/cugraph
2 participants
@kingmesal @betochimas