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.

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

[ENH] pylibcugraph should run doctests as part of its test suite #2193

Closed
rlratzel opened this issue Apr 5, 2022 · 0 comments · Fixed by #2194
Closed

[ENH] pylibcugraph should run doctests as part of its test suite #2193

rlratzel opened this issue Apr 5, 2022 · 0 comments · Fixed by #2194
Assignees
Labels
? - Needs Triage Need team to review and classify improvement Improvement / enhancement to an existing function non-breaking Non-breaking change
Milestone

Comments

@rlratzel
Copy link
Contributor

rlratzel commented Apr 5, 2022

Like #2014 did for cugraph, pylibcugraph should also have doctest runs as part of its test suite.

@rlratzel rlratzel added ? - Needs Triage Need team to review and classify improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Apr 5, 2022
@rlratzel rlratzel added this to the 22.06 milestone Apr 5, 2022
@github-actions github-actions bot added this to Needs prioritizing in Other Issues Apr 5, 2022
Other Issues automation moved this from Needs prioritizing to Closed Apr 30, 2022
rapids-bot bot pushed a commit that referenced this issue Apr 30, 2022
This PR incorporates suggested changes from issue #2037, opened back in 22.02, as well as cleaning up documentation and testing code from 22.04 work.

Specifically, this PR does the following:
- Removes worker helpers from MNMG algos in the online documentation (e.g. `call_katz_centrality`, `call_louvain`, `call_wcc`)
- Adds helpers from comms such as `get_comms`, `get_session_id`, `get_2D_partition`, is_initialized that were previously missing
- Adds helpers from NumberMap such as `from_internal_vertex_id`, `to_internal_vertex_id`, `renumber`, `set_renumbered_col_names`
- Add MNMG Hits and Node2vec to docs
- Added docstring descriptions and examples to methods that were missing them
- Fixed docstring examples in `egonet.py`, `node2vec.py`
- Adds `pylibcugraph` docstring examples to the list of examples tested in `cugraph/tests/test_doctests.py`
- Adds support for MG Dask docstring example testing, tested in newly created `cugraph/tests/dask/test_mg_doctests.py` 

This PR addresses the items from and closes #2227.
This PR also closes #2193.

Authors:
  - https://github.com/betochimas

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

URL: #2194
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
? - Needs Triage Need team to review and classify improvement Improvement / enhancement to an existing function non-breaking Non-breaking change
Projects
No open projects
22.06 Release
  
Awaiting triage
Development

Successfully merging a pull request may close this issue.

2 participants