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

cuGraph Readme pages and Documentation API structure refactoring #2894

Merged
merged 56 commits into from Nov 29, 2022
Merged

cuGraph Readme pages and Documentation API structure refactoring #2894

merged 56 commits into from Nov 29, 2022

Conversation

acostadon
Copy link
Contributor

@acostadon acostadon commented Nov 7, 2022 •
edited by BradReesWork

Refactoring the API and adding new landing pages for each cuGraph component

Please just go to: https://github.com/acostadon/cugraph/tree/README_issue_2663 to visualize the changes

closes #2663

@acostadon acostadon self-assigned this Nov 7, 2022
@acostadon acostadon added the non-breaking Non-breaking change label Nov 7, 2022
@acostadon acostadon added this to the 22.12 milestone Nov 7, 2022
@acostadon acostadon assigned acostadon and unassigned acostadon Nov 7, 2022
@acostadon acostadon added the doc Documentation label Nov 7, 2022
@acostadon acostadon changed the title Readme issue 2877 [skip-ci] Readme refactoring Nov 7, 2022
@acostadon acostadon changed the title [skip-ci] Readme refactoring [skip-ci] cuGraph Readme refactoring Nov 7, 2022
@BradReesWork BradReesWork changed the title [skip-ci] cuGraph Readme refactoring [skip-ci] cuGraph Readme pages and Documentationb API structure refactoring Nov 8, 2022
@BradReesWork BradReesWork self-requested a review November 22, 2022 17:53
BradReesWork
BradReesWork requested changes Nov 22, 2022
View reviewed changes
readme_pages/algorithms.md Outdated Show resolved Hide resolved
readme_pages/algorithms.md Outdated Show resolved Hide resolved
@acostadon
Copy link
Contributor Author

rerun tests

@acostadon
Copy link
Contributor Author

rerun tests

@codecov-commenter
Copy link

codecov-commenter commented Nov 23, 2022 •
edited

Codecov Report

Base: 60.81% // Head: 59.61% // Decreases project coverage by -1.20% ⚠️

Coverage data is based on head (d3b0860) compared to base (435e1c3).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@               Coverage Diff                @@
##           branch-22.12    #2894      +/-   ##
================================================
- Coverage         60.81%   59.61%   -1.21%     
================================================
  Files               122      129       +7     
  Lines              6891     7656     +765     
================================================
+ Hits               4191     4564     +373     
- Misses             2700     3092     +392
Impacted Files Coverage Δ
python/cugraph/cugraph/community/egonet.py 88.57% <0.00%> (-6.17%) ⬇️
...n/cugraph/cugraph/community/subgraph_extraction.py 95.83% <0.00%> (-4.17%) ⬇️
...raph/gnn/pyg_extensions/sampler/cugraph_sampler.py 75.75% <0.00%> (-2.43%) ⬇️
...h/cugraph/gnn/pyg_extensions/data/cugraph_store.py 79.55% <0.00%> (-2.23%) ⬇️
...ure/graph_implementation/simpleDistributedGraph.py 14.64% <0.00%> (-1.56%) ⬇️
...ugraph/cugraph/dask/structure/mg_property_graph.py 12.09% <0.00%> (-1.18%) ⬇️
python/cugraph/cugraph/structure/property_graph.py 95.23% <0.00%> (-0.95%) ⬇️
...raph/structure/graph_implementation/simpleGraph.py 78.28% <0.00%> (-0.63%) ⬇️
python/cugraph/cugraph/dask/__init__.py 100.00% <0.00%> (ø)
python/cugraph/cugraph/community/leiden.py 100.00% <0.00%> (ø)
... and 15 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

taureandyernv
taureandyernv suggested changes Nov 23, 2022
View reviewed changes
Copy link

@taureandyernv taureandyernv left a comment

Choose a reason for hiding this comment

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

Quick small verbiage changes and what not. Should be good to go after :)

readme_pages/getting_cugraph.md Outdated Show resolved Hide resolved
taureandyernv
taureandyernv approved these changes Nov 23, 2022
View reviewed changes
Copy link

@taureandyernv taureandyernv left a comment

Choose a reason for hiding this comment

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

Yay, we did it! Great job @acostadon !

@BradReesWork
Copy link
Member

rerun tests

@BradReesWork BradReesWork changed the title cuGraph Readme pages and Documentation API structure refactoring [skip ci] cuGraph Readme pages and Documentation API structure refactoring Nov 25, 2022
@BradReesWork
Copy link
Member

rerun tests

1 similar comment
@BradReesWork
Copy link
Member

rerun tests

@BradReesWork BradReesWork changed the title [skip ci] cuGraph Readme pages and Documentation API structure refactoring cuGraph Readme pages and Documentation API structure refactoring Nov 28, 2022
@BradReesWork
Copy link
Member

rerun tests

2 similar comments
@acostadon
Copy link
Contributor Author

rerun tests

@BradReesWork
Copy link
Member

rerun tests

@BradReesWork
Copy link
Member

@gpucibot merge

@BradReesWork BradReesWork changed the title cuGraph Readme pages and Documentation API structure refactoring [skip gpuci] cuGraph Readme pages and Documentation API structure refactoring Nov 28, 2022
@BradReesWork
Copy link
Member

@gpucibot merge

@BradReesWork
Copy link
Member

rerun tests

@BradReesWork
Copy link
Member

@gpucibot merge

@BradReesWork BradReesWork changed the title [skip gpuci] cuGraph Readme pages and Documentation API structure refactoring cuGraph Readme pages and Documentation API structure refactoring Nov 28, 2022
@BradReesWork
Copy link
Member

rerun tests

@rapids-bot rapids-bot bot merged commit a6d85c0 into rapidsai:branch-22.12 Nov 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BradReesWork BradReesWork BradReesWork approved these changes

@taureandyernv taureandyernv taureandyernv approved these changes

@ChuckHastings ChuckHastings Awaiting requested review from ChuckHastings

Assignees

@acostadon acostadon

Labels
doc Documentation non-breaking Non-breaking change
Projects
None yet
Milestone
22.12
Development

Successfully merging this pull request may close these issues.

[DOC] Refactor and improve the README and support documents
6 participants
@acostadon @codecov-commenter @BradReesWork @taureandyernv @VibhuJawa @alexbarghi-nv