|
1 | | -# nx-cugraph |
| 1 | +# <div align="left"><img src="img/rapids_logo.png" width="90px"/> nx-cugraph - GPU Backend for NetworkX</div> |
2 | 2 |
|
3 | 3 | ## Description |
4 | | -[RAPIDS](https://rapids.ai) nx-cugraph is a [backend to NetworkX](https://networkx.org/documentation/stable/backends.html) |
5 | | -to run supported algorithms with GPU acceleration. |
| 4 | +[nx-cugraph](https://rapids.ai/nx-cugraph) is a [backend to NetworkX](https://networkx.org/documentation/stable/backends.html) to run algorithms with zero code change GPU acceleration. |
| 5 | + |
| 6 | +- [System Requirements](#system-requirements) |
| 7 | +- [Installation](#installation) |
| 8 | +- [Enabling nx-cugraph](#enabling-nx-cugraph) |
| 9 | +- [Supported Algorithms](#supported-algorithms) |
| 10 | + |
| 11 | +--- |
6 | 12 |
|
7 | 13 | ## System Requirements |
8 | 14 |
|
9 | | -nx-cugraph requires the following: |
10 | | - * NVIDIA GPU, Volta architecture or later, with [compute capability](https://developer.nvidia.com/cuda-gpus) 7.0+ |
11 | | - * CUDA 11.4-11.8 or 12.0-12.5 |
12 | | - * Python version 3.10, 3.11, or 3.12 |
13 | | - * NetworkX >= version 3.2 (version 3.4 or higher recommended) |
| 15 | + * **GPU:** NVIDIA Volta architecture or later, with [compute capability](https://developer.nvidia.com/cuda-gpus) 7.0+ |
| 16 | + * Pascal GPU support was [removed in 24.02](https://docs.rapids.ai/notices/rsn0034/). Compute capability 7.0+ is required for RAPIDS 24.02 and later. |
| 17 | + * **CUDA Version:** 11.4 - 11.8 or 12.0 - 12.5 |
| 18 | + * **Python Version:** 3.10, 3.11, or 3.12 |
| 19 | + * **NetworkX Version:** minimum 3.2 (version 3.4 or higher recommended) |
| 20 | + |
| 21 | +Note: nx-cugraph is supported only on Linux, and with Python versions 3.10 and later. |
| 22 | + |
| 23 | +See [RAPIDS System Requirements](https://docs.rapids.ai/install#system-req) for detailed information on OS and Versions. |
14 | 24 |
|
15 | | -More details about system requirements can be found in the [RAPIDS System Requirements documentation](https://docs.rapids.ai/install#system-req). |
16 | 25 |
|
17 | 26 | ## Installation |
18 | 27 |
|
19 | | -nx-cugraph can be installed using either conda or pip. |
| 28 | +nx-cugraph can be installed using either conda or pip with the following commands. |
20 | 29 |
|
21 | 30 | ### conda |
22 | | -#### latest nightly version |
| 31 | + |
| 32 | +nx-cugraph can be installed with conda (via [Miniforge](https://github.com/conda-forge/miniforge)) from the `rapidsai` channel. |
23 | 33 | ``` |
24 | | -conda install -c rapidsai-nightly -c conda-forge -c nvidia nx-cugraph |
| 34 | +conda install -c rapidsai -c conda-forge -c nvidia nx-cugraph |
25 | 35 | ``` |
26 | | -#### latest stable version |
| 36 | + |
| 37 | +We also provide [nightly Conda packages](https://anaconda.org/rapidsai-nightly/nx-cugraph) built from the HEAD of our latest development branch. |
27 | 38 | ``` |
28 | | -conda install -c rapidsai -c conda-forge -c nvidia nx-cugraph |
| 39 | +conda install -c rapidsai-nightly -c conda-forge -c nvidia nx-cugraph |
29 | 40 | ``` |
| 41 | + |
30 | 42 | ### pip |
31 | | -#### latest nightly version |
| 43 | + |
| 44 | +nx-cugraph can be installed via `pip` from the NVIDIA Python Package Index. |
| 45 | + |
| 46 | +#### For CUDA 11.x: |
| 47 | + |
| 48 | +Latest nightly version |
32 | 49 | ``` |
33 | 50 | python -m pip install nx-cugraph-cu11 --extra-index-url https://pypi.anaconda.org/rapidsai-wheels-nightly/simple |
34 | 51 | ``` |
35 | | -#### latest stable version |
| 52 | + |
| 53 | +Latest stable version |
36 | 54 | ``` |
37 | 55 | python -m pip install nx-cugraph-cu11 --extra-index-url https://pypi.nvidia.com |
38 | 56 | ``` |
39 | 57 | Notes: |
40 | 58 | * The pip example above installs for CUDA 11. To install for CUDA 12, replace `-cu11` with `-cu12` |
41 | | - * Additional information relevant to installing any RAPIDS package can be found [here](https://rapids.ai/#quick-start). |
| 59 | + * Try out the [RAPIDS Install Selector Tool](https://docs.rapids.ai/install/#install-rapids) to install other RAPIDS packages. |
42 | 60 |
|
43 | 61 | ## Enabling nx-cugraph |
44 | 62 |
|
@@ -281,4 +299,4 @@ Below is the list of algorithms that are currently supported in nx-cugraph. |
281 | 299 | </pre> |
282 | 300 |
|
283 | 301 | To request nx-cugraph backend support for a NetworkX API that is not listed |
284 | | -above, visit the [nx-cugraph GitHub repo](https://github.com/rapidsai/nx-cugraph). |
| 302 | +above, [file an issue](https://github.com/rapidsai/nx-cugraph/issues/new/choose). |
0 commit comments