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

API Doc Namespace Edits + SimpleGraphImpl methods #2086

Merged

Conversation

betochimas
Copy link
Contributor

@betochimas betochimas commented Feb 19, 2022

Increases consistency between the API docs and the namespace in which the method can be called from, reducing potential confusion. Ex: cugraph.centrality.betweenness_centrality.betweenness_centrality can now be found as cugraph.betweenness_centrality. Note: both are valid ways of calling the same method.

Includes methods and attributes of a graph object once data is loaded (from SimpleGraphImpl), such as number_of_vertices, has_edge, get_two_hops_neighbors, etc.

Ready for review.

@betochimas betochimas requested review from a team as code owners February 19, 2022 00:51
@betochimas betochimas added this to the 22.04 milestone Feb 19, 2022
@betochimas betochimas added 3 - Ready for Review doc Documentation non-breaking Non-breaking change labels Feb 19, 2022
@betochimas betochimas self-assigned this Feb 19, 2022
@BradReesWork BradReesWork added improvement Improvement / enhancement to an existing function and removed improvement Improvement / enhancement to an existing function labels Feb 19, 2022
@BradReesWork
Copy link
Member

@gpucibot merge

@codecov-commenter
Copy link

codecov-commenter commented Feb 19, 2022

Codecov Report

Merging #2086 (ca7e30b) into branch-22.04 (d947fb9) will increase coverage by 0.09%.
The diff coverage is 100.00%.

Impacted file tree graph

@@               Coverage Diff                @@
##           branch-22.04    #2086      +/-   ##
================================================
+ Coverage         73.54%   73.64%   +0.09%     
================================================
  Files               156      156              
  Lines             10316    10332      +16     
================================================
+ Hits               7587     7609      +22     
+ Misses             2729     2723       -6     
Impacted Files Coverage Δ
...graph/cugraph/centrality/betweenness_centrality.py 89.65% <ø> (ø)
python/cugraph/cugraph/components/connectivity.py 95.00% <ø> (ø)
python/cugraph/cugraph/cores/core_number.py 100.00% <ø> (ø)
python/cugraph/cugraph/layout/force_atlas2.py 61.11% <ø> (+5.55%) ⬆️
python/cugraph/cugraph/linear_assignment/lap.py 71.42% <ø> (ø)
python/cugraph/cugraph/link_prediction/overlap.py 59.09% <ø> (ø)
python/cugraph/cugraph/link_prediction/sorensen.py 85.18% <ø> (ø)
...raph/structure/graph_implementation/simpleGraph.py 74.30% <ø> (ø)
python/cugraph/cugraph/structure/number_map.py 67.02% <ø> (ø)
python/cugraph/cugraph/utilities/utils.py 72.92% <100.00%> (+2.62%) ⬆️
... and 5 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d947fb9...ca7e30b. Read the comment docs.

@rapids-bot rapids-bot bot merged commit df49ad7 into rapidsai:branch-22.04 Feb 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants