diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index de020e78ed3..fdf1281fdc4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -124,6 +124,7 @@ Using VSCode, you can develop remotely from the hardware if you so wish. Alex F **Debug** * cuda-memcheck +* cuda-gdb A debug launch can also be enabled in VSCode with something like: https://github.com/harrism/cudf-vscode/blob/master/.vscode/launch.json @@ -145,10 +146,10 @@ implementation of the issue, ask them in the issue instead of the PR. ### Style Guild All Python code most pass flake8 style checking -All C++ code must pass clank style checking +All C++ code must pass clang style checking ### Tests -All code must have assocsiate test cases. Code without test will not be accepted +All code must have associate test cases. Code without test will not be accepted diff --git a/PRTAGS.md b/PRTAGS.md index 4d7a14cd3ae..91c47e035a4 100644 --- a/PRTAGS.md +++ b/PRTAGS.md @@ -1,5 +1,5 @@ # Pull Request Tags -If you look at the list of current [Pull Request](https://github.com/rapidsai/cugraph/pulls) you will notice a set of bracketed tags in the subject line. Those tags help developers focus attention and know what is being asked. +If you look at the list of current [Pull Request](https://github.com/rapidsai/cugraph/pulls) you will notice a set of bracketed tags in the subject line. Those tags help developers focus attention and know what is being asked. PR = Pull Request diff --git a/README.md b/README.md index a385e4c6193..daf36dba6e2 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ import cugraph # read data into a cuDF DataFrame using read_csv gdf = cudf.read_csv("graph_data.csv", names=["src", "dst"], dtype=["int32", "int32"] ) -# We now have data in a COO format (edge pairs) +# We now have data ias edge pairs # create a Graph using the source (src) and destination (dst) vertex pairs the GDF G = cugraph.Graph() G.from_cudf_edgelist(gdf, source='src', destination='dst') @@ -78,11 +78,11 @@ The current version of cuGraph has some limitations: - Vertex IDs need to be 32-bit integers. - Vertex IDs are expected to be contiguous integers starting from 0. --- If the starting index is not zero, cuGraph will add disconnected vertices to fill in the missing range +-- If the starting index is not zero, cuGraph will add disconnected vertices to fill in the missing range. (Auto-) Renumbering fixes this issue cuGraph provides the renumber function to mitigate this problem. Input vertex IDs for the renumber function can be any type, can be non-contiguous, and can start from an arbitrary number. The renumber function maps the provided input vertex IDs to 32-bit contiguous integers starting from 0. cuGraph still requires the renumbered vertex IDs to be representable in 32-bit integers. These limitations are being addressed and will be fixed soon. -cuGraph prvides an auto-renumbering feature, enabled by default, during Graph creating. Renumbered vertices are automaticaly un-renumbered. +cuGraph provides 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) if errors are encountered with newer versions diff --git a/SOURCEBUILD.md b/SOURCEBUILD.md index 15bcc843c1b..1640ba0a9f3 100644 --- a/SOURCEBUILD.md +++ b/SOURCEBUILD.md @@ -76,7 +76,7 @@ conda activate cugraph_dev 3) Build and install `libcugraph`. CMake depends on the `nvcc` executable being on your path or defined in `$CUDACXX`. - This project uses cmake for building the C/C++ library. CMake will also automatically build and install nvGraph library (`$CUGRAPH_HOME/cpp/nvgraph`) which may take a few minutes. To configure cmake, run: + This project uses cmake for building the C/C++ library. To configure cmake, run: ```bash # Set the localtion to cuGraph in an environment variable CUGRAPH_HOME