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

README updates #2395

Merged
merged 5 commits into from
Jul 18, 2022
Merged

README updates #2395

merged 5 commits into from
Jul 18, 2022

Conversation

BradReesWork
Copy link
Member

@BradReesWork BradReesWork commented Jul 7, 2022

updated the README

closes #2376

@BradReesWork BradReesWork requested a review from a team as a code owner July 7, 2022 18:40
@BradReesWork BradReesWork added doc Documentation improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Jul 7, 2022
@BradReesWork BradReesWork added this to the 22.08 milestone Jul 7, 2022
@BradReesWork BradReesWork removed the improvement Improvement / enhancement to an existing function label Jul 7, 2022
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.

Looks good, I just had a few suggestions:

README.md Outdated Show resolved Hide resolved
@@ -2,7 +2,9 @@

[![Build Status](https://gpuci.gpuopenanalytics.com/job/rapidsai/job/gpuci/job/cugraph/job/branches/job/cugraph-branch-pipeline/badge/icon)](https://gpuci.gpuopenanalytics.com/job/rapidsai/job/gpuci/job/cugraph/job/branches/job/cugraph-branch-pipeline/)

The [RAPIDS](https://rapids.ai) cuGraph library is a collection of GPU accelerated graph algorithms that process data found in [GPU DataFrames](https://github.com/rapidsai/cudf). The vision of cuGraph is _to make graph analysis ubiquitous to the point that users just think in terms of analysis and not technologies or frameworks_. To realize that vision, cuGraph operates, at the Python layer, on GPU DataFrames, thereby allowing for seamless passing of data between ETL tasks in [cuDF](https://github.com/rapidsai/cudf) and machine learning tasks in [cuML](https://github.com/rapidsai/cuml). Data scientists familiar with Python will quickly pick up how cuGraph integrates with the Pandas-like API of cuDF. Likewise, users familiar with NetworkX will quickly recognize the NetworkX-like API provided in cuGraph, with the goal to allow existing code to be ported with minimal effort into RAPIDS. For users familiar with C++/CUDA and graph structures, a C++ API is also provided. However, there is less type and structure checking at the C++ layer.
The [RAPIDS](https://rapids.ai) cuGraph library is a collection of GPU accelerated graph algorithms that process data found in [GPU DataFrames](https://github.com/rapidsai/cudf). The vision of cuGraph is _to make graph analysis ubiquitous to the point that users just think in terms of analysis and not technologies or frameworks_. To realize that vision, cuGraph operates, at the Python layer, on GPU DataFrames, thereby allowing for seamless passing of data between ETL tasks in [cuDF](https://github.com/rapidsai/cudf) and machine learning tasks in [cuML](https://github.com/rapidsai/cuml). Data scientists familiar with Python will quickly pick up how cuGraph integrates with the Pandas-like API of cuDF. Likewise, users familiar with NetworkX will quickly recognize the NetworkX-like API provided in cuGraph, with the goal to allow existing code to be ported with minimal effort into RAPIDS.
Copy link
Contributor

@rlratzel rlratzel Jul 8, 2022

Choose a reason for hiding this comment

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

The sentence starting with "To realize that vision..." might read better with fewer commas, maybe like this:

To realize that vision, cuGraph operates at the Python layer on GPU DataFrames, thereby allowing for seamless passing of data between ETL...

README.md Outdated Show resolved Hide resolved
BradReesWork and others added 2 commits July 8, 2022 14:44
Co-authored-by: Rick Ratzel <[email protected]>
Co-authored-by: Rick Ratzel <[email protected]>
@codecov-commenter
Copy link

Codecov Report

Merging #2395 (da98b31) into branch-22.08 (fa701f5) will increase coverage by 0.01%.
The diff coverage is n/a.

@@               Coverage Diff                @@
##           branch-22.08    #2395      +/-   ##
================================================
+ Coverage         60.08%   60.09%   +0.01%     
================================================
  Files               102      102              
  Lines              5158     5155       -3     
================================================
- Hits               3099     3098       -1     
+ Misses             2059     2057       -2     
Impacted Files Coverage Δ
...raph/structure/graph_implementation/simpleGraph.py 74.17% <0.00%> (-0.31%) ⬇️
...n/cugraph/cugraph/dask/community/triangle_count.py 17.54% <0.00%> (ø)
...cugraph/cugraph/dask/centrality/katz_centrality.py 16.94% <0.00%> (ø)
...h/cugraph/dask/sampling/uniform_neighbor_sample.py 16.66% <0.00%> (ø)
.../cugraph/dask/centrality/eigenvector_centrality.py 23.25% <0.00%> (+1.51%) ⬆️

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 fa701f5...da98b31. Read the comment docs.

@BradReesWork
Copy link
Member Author

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 8b2aaee into rapidsai:branch-22.08 Jul 18, 2022
@BradReesWork BradReesWork deleted the doc_updates branch September 14, 2022 16:12
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.

[QST] ArangoDB - cuGraph
4 participants