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

[DOC] Fix/add examples/documentation from recent release #2227

Closed
19 tasks done
betochimas opened this issue Apr 14, 2022 · 0 comments · Fixed by #2194
Closed
19 tasks done

[DOC] Fix/add examples/documentation from recent release #2227

betochimas opened this issue Apr 14, 2022 · 0 comments · Fixed by #2194
Assignees
@betochimas
Labels
? - Needs Triage Need team to review and classify doc Documentation
Projects
Other Issues
Milestone
22.06

Comments

@betochimas
Copy link
Contributor

Missing examples

  • cugraph.comms.comms.initialize
  • cugraph.community.ktruss_subgraph.k_truss
  • cugraph.structure.hypergraph.hypergraph
  • cugraph.dask.components.connectivity.weakly_connected_components
  • cugraph.sampling.node2vec.node2vec
  • pylibcugraph.graphs.SGGraph

Broken examples / Examples to revisit

  • cugraph.community.egonet.batched_ego_graphs RETURNS does not match example (PR 2194)
  • cugraph.dask.centrality.katz_centrality.katz_centrality
  • cugraph.dask.common.read_utils.get_chunksize
  • cugraph.dask.community.louvain.louvain
  • cugraph.dask.link_analysis.pagerank
  • cugraph.dask.link_analysis.hits
  • cugraph.dask.traversal.bfs
  • cugraph.dask.traversal.sssp
  • cugraph.linear_assignment.lap.hungarian
  • cugraph.Graph.from_pandas_edgelist

Missing documentation

  • cugraph.comms.comms.is_initialized, get_comms, get_workers, get_session_id, get_2D_partition, get_default_handle can be added similar to Graph checks

MNMG Client Helper

  • Remove existing MNMG 'call' helpers, aka bfs, sssp, wcc, katz_centrality from docs

Methods missing from html docs

  • Methods from cugraph.structure.number_map.NumberMap (to_internal_vertex_id, add_internal_vertex_id, from_internal_vertex_id, renumber_and_segment, renumber)
@betochimas betochimas added ? - Needs Triage Need team to review and classify doc Documentation labels Apr 14, 2022
@github-actions github-actions bot added this to Needs prioritizing in Other Issues Apr 14, 2022
@betochimas betochimas mentioned this issue Apr 14, 2022
Merged
@betochimas betochimas self-assigned this Apr 15, 2022
@rlratzel rlratzel added this to the 22.06 milestone Apr 15, 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
@betochimas
Python code cleanup across docs, wrappers, testing (#2194)
34a40a7 
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
This was referenced May 2, 2022
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@betochimas betochimas

Labels
? - Needs Triage Need team to review and classify doc Documentation
Projects
No open projects
Other Issues
Closed
Milestone
22.06
Development

Successfully merging a pull request may close this issue.

Python code cleanup across docs, wrappers, testing betochimas/cugraph
2 participants
@rlratzel @betochimas