diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45a01bb2bd9..5de9e0a93c5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ cuGraph, and all of RAPIDS in general, is an open-source project where we encour * [File an Issue](#issue) * [Implement a New Feature](#implement) -* [Wok on an Existing Issue](#bugfix) +* [Work on an Existing Issue](#bugfix) If you are ready to contribute, jump right to the [Contribute Code](#code) section. @@ -73,7 +73,7 @@ and ask for clarifications! ## Fork a private copy of cuGraph -The RAPIDS cuGraph repo cannot directly be modified. Contributions must come in the form of a *Pull Request* from a folked version of cugraph. GitHub as a nice write up ion the process: https://help.github.com/en/github/getting-started-with-github/fork-a-repo +The RAPIDS cuGraph repo cannot directly be modified. Contributions must come in the form of a *Pull Request* from a forked version of cugraph. GitHub as a nice write up ion the process: https://help.github.com/en/github/getting-started-with-github/fork-a-repo 1. Fork the cugraph repo to your GitHub account 2. clone your version @@ -102,7 +102,7 @@ There is no recommended or preferred development environment. There are a few * **Hardware** -* You need to have accesses to an NVIDAI GPU that is Pascal or later. +* You need to have accesses to an NVIDIA GPU that is Pascal or later. **IDEs** diff --git a/README.md b/README.md index f19b897671a..a385e4c6193 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,7 @@ [![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 - see [cuDF](https://github.com/rapidsai/cudf). The vision of RAPIDS 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 operators, at the Python layer, on GPU DataFrames, allowing for seamless passing of data between ETL tasks in cuDF and machine learning tasks in cuML. Data scientist familiar with Python will quickly pick up how cuGraph integrates with the Pandas-like API of cuDF. For user familiar with NetworkX, cuGraph provides a NetworkX-like API. The goal being to allow existing code to be ported with minimal effort into RAPIDS. - -For users familar with C/CUDA and graph structures, we also provide a C++ API. 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 operators, at the Python layer, on GPU DataFrames, 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 scientist familiar with Python will quickly pick up how cuGraph integrates with the Pandas-like API of cuDF. Likewise, user familiar with NetworkX will quickly reconnize the NetworkX-like API provided in cuGraph, with the goal being to allow existing code to be ported with minimal effort into RAPIDS. For users familar with C/CUDA and graph structures, a C++ API is also provided. However, there is less type and structure checking at the C layer. For more project details, see [rapids.ai](https://rapids.ai/). @@ -21,7 +19,7 @@ gdf = cudf.read_csv("graph_data.csv", names=["src", "dst"], dtype=["int32", "int # We now have data in a COO format (edge pairs) # create a Graph using the source (src) and destination (dst) vertex pairs the GDF G = cugraph.Graph() -G.add_edge_list(gdf, source='src', destination='dst') +G.from_cudf_edgelist(gdf, source='src', destination='dst') # Let's now get the PageRank score of each vertex by calling cugraph.pagerank gdf_page = cugraph.pagerank(G) @@ -86,7 +84,7 @@ cuGraph provides the renumber function to mitigate this problem. Input vertex ID cuGraph prvides an auto-renumbering feature, enabled by default, during Graph creating. Renumbered vertices are automaticaly un-renumbered. -cuGraph is constantly being updatred and improved. Please see the [Transition Guide](TRANSITIONGUIDE.md) is errors are encountered with newer versions +cuGraph is constantly being updatred and improved. Please see the [Transition Guide](TRANSITIONGUIDE.md) if errors are encountered with newer versions