diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e44d1ccb9c0..de0b561e44f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ If you are ready to contribute, jump right to the [Contribute Code](#code) secti __Style Formating Tools:__ * `clang-format` version 8.01+ -* `flake8` version 3.5.0 +* `flake8` version 3.5.0+ @@ -160,4 +160,3 @@ All code must have associate test cases. Code without test will not be accepted - diff --git a/README.md b/README.md index 9ccba417363..a3f371ad6ec 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,8 @@ cuGraph provides an auto-renumbering feature, enabled by default, during Graph c cuGraph is constantly being updatred and improved. Please see the [Transition Guide](TRANSITIONGUIDE.md) if errors are encountered with newer versions ## Graph Sizes and GPU Memory Size -The amount of memory required is dependent on the graph structure and the analytic being executed. As a simple rule of thumb, the amount of GPU memory should be about twice the size of the data size. That gives overhead for the CSV reader and other transform functions. There are ways around the rule but using smaller data chunks. +The amount of memory required is dependent on the graph structure and the analytics being executed. As a simple rule of thumb, the amount of GPU memory should be about twice the size of the data size. That gives overhead for the CSV reader and other transform functions. There are ways around the rule but using smaller data chunks. + | Size | Recomended GPU Memory | |-------------------|-----------------------| diff --git a/SOURCEBUILD.md b/SOURCEBUILD.md index 1cefe87f611..23beee55f07 100644 --- a/SOURCEBUILD.md +++ b/SOURCEBUILD.md @@ -9,7 +9,7 @@ The cuGraph package include both a C/C++ CUDA portion and a python portion. Bot __Compiler__: * `gcc` version 5.4+ * `nvcc` version 10.0+ -* `cmake` version 3.12 +* `cmake` version 3.12+ __CUDA:__ * CUDA 10.0+ @@ -112,7 +112,7 @@ $ ./build.sh libcugraph -v # compile and install libcugraph with $ ./build.sh libcugraph -g # compile and install libcugraph for debug $ ./build.sh libcugraph -n # compile libcugraph but do not install -# make parallelism options can also be defined: Example build jobs to 4 (make -j4) +# make parallelism options can also be defined: Example build jobs using 4 threads (make -j4) $ PARALLEL_LEVEL=4 ./build.sh libcugraph Note that the libraries will be installed to the location set in `$PREFIX` if set (i.e. `export PREFIX=/install/path`), otherwise to `$CONDA_PREFIX`. @@ -260,4 +260,4 @@ cmake .. -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX -DCMAKE_CXX11_ABI=OFF ``` ## Attribution -Portions adopted from https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md \ No newline at end of file +Portions adopted from https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md