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

Updating docs #1448

Merged
merged 16 commits into from
Mar 17, 2021
Merged

Updating docs #1448

merged 16 commits into from
Mar 17, 2021

Conversation

BradReesWork
Copy link
Member

  • added Hungarian to api.rst
  • fixed missing examples
  • fixed syntax

@BradReesWork BradReesWork added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Mar 11, 2021
@BradReesWork BradReesWork added this to the 0.19 milestone Mar 11, 2021
@BradReesWork BradReesWork self-assigned this Mar 11, 2021
@BradReesWork BradReesWork requested review from a team as code owners March 11, 2021 19:56
@BradReesWork BradReesWork linked an issue Mar 11, 2021 that may be closed by this pull request
[FIX] Connected Components Documentation #1420
Closed
@BradReesWork BradReesWork linked an issue Mar 12, 2021 that may be closed by this pull request
[DOC] multi-GPU graph doc is lacking some lines #1363
Closed
@codecov-io
Copy link

codecov-io commented Mar 12, 2021 •
edited
Loading

Codecov Report

Merging #1448 (36ecfcd) into branch-0.19 (4535396) will decrease coverage by 1.68%.
The diff coverage is 62.50%.

Impacted file tree graph

@@               Coverage Diff               @@
##           branch-0.19    #1448      +/-   ##
===============================================
- Coverage        60.72%   59.04%   -1.69%     
===============================================
  Files               70       70              
  Lines             3132     3223      +91     
===============================================
+ Hits              1902     1903       +1     
- Misses            1230     1320      +90
Impacted Files Coverage Δ
python/cugraph/community/egonet.py 91.42% <ø> (ø)
python/cugraph/components/connectivity.py 95.65% <ø> (ø)
python/cugraph/dask/centrality/katz_centrality.py 34.78% <ø> (ø)
python/cugraph/dask/community/louvain.py 33.33% <ø> (ø)
python/cugraph/dask/link_analysis/pagerank.py 25.80% <ø> (ø)
python/cugraph/dask/traversal/bfs.py 32.14% <ø> (ø)
python/cugraph/dask/traversal/sssp.py 32.14% <ø> (ø)
python/cugraph/bsp/traversal/bfs_bsp.py 10.25% <50.00%> (+2.14%) ⬆️
python/cugraph/tree/minimum_spanning_tree.py 85.36% <66.66%> (ø)
python/cugraph/dask/common/part_utils.py 20.66% <0.00%> (-0.18%) ⬇️
... and 2 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 4535396...36ecfcd. Read the comment docs.

@BradReesWork
Copy link
Member Author

rerun tests

@BradReesWork
Copy link
Member Author

rerun tests

rlratzel
rlratzel approved these changes Mar 16, 2021
View reviewed changes
Copy link
Contributor

@rlratzel rlratzel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I had just one minor suggestion which need not hold up my approval.

python/cugraph/dask/centrality/katz_centrality.py
Comment on lines +118 to +119
>>> ... Init a DASK Cluster
>> see https://docs.rapids.ai/api/cugraph/stable/dask-cugraph.html
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor: since these are typically copy-and-pasteable snippets, you could use a comment char here:

>>> import cugraph.dask as dcg
>>> # ... Init a DASK Cluster
>>> #   see https://docs.rapids.ai/api/cugraph/stable/dask-cugraph.html
>>> chunksize = dcg.get_chunksize(input_data_path)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

true. but it is not executable code. There used to be a line initializing Comm, but that is not fully what is needed for DASK. I pulled that out so that there is one place to maintain what setting up dask looks like. If someone cut&pastes the above block, I would prefer it break on a non-executable line

@BradReesWork
Copy link
Member Author

rerun tests

@BradReesWork BradReesWork requested a review from Iroy30 March 17, 2021 16:07
afender
afender approved these changes Mar 17, 2021
View reviewed changes
Copy link
Member

@afender afender left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@BradReesWork
Copy link
Member Author

@gpucibot merge

@rapids-bot rapids-bot bot merged commit c5ce119 into rapidsai:branch-0.19 Mar 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@afender afender afender approved these changes

@rlratzel rlratzel rlratzel approved these changes

@Iroy30 Iroy30 Awaiting requested review from Iroy30

Assignees

@BradReesWork BradReesWork

Labels
improvement Improvement / enhancement to an existing function non-breaking Non-breaking change
Projects
None yet
Milestone
0.19
Development

Successfully merging this pull request may close these issues.

[FIX] Connected Components Documentation [DOC] multi-GPU graph doc is lacking some lines
4 participants
@BradReesWork @codecov-io @rlratzel @afender