Skip to content

Commit

Permalink
Merge branch 'branch-24.12' into branch-24.12-remove-deprecation-warn…
Browse files Browse the repository at this point in the history
…ings
  • Loading branch information
jakirkham authored Oct 15, 2024
2 parents 6ddfd45 + 88b841f commit afaf820
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions python/nx-cugraph/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# nx-cugraph

## Description
[RAPIDS](https://rapids.ai) nx-cugraph is a [backend to NetworkX](https://networkx.org/documentation/stable/reference/utils.html#backends)
[RAPIDS](https://rapids.ai) nx-cugraph is a [backend to NetworkX](https://networkx.org/documentation/stable/backends.html)
to run supported algorithms with GPU acceleration.

## System Requirements
Expand All @@ -10,7 +10,7 @@ nx-cugraph requires the following:
* NVIDIA GPU, Volta architecture or later, with [compute capability](https://developer.nvidia.com/cuda-gpus) 7.0+
* CUDA 11.2, 11.4, 11.5, 11.8, 12.0, 12.2, or 12.5
* Python version 3.10, 3.11, or 3.12
* NetworkX >= version 3.0 (version 3.2 or higher recommended)
* NetworkX >= version 3.0 (version 3.4 or higher recommended)

More details about system requirements can be found in the [RAPIDS System Requirements documentation](https://docs.rapids.ai/install#system-req).

Expand Down Expand Up @@ -45,18 +45,20 @@ Notes:
NetworkX will use nx-cugraph as the graph analytics backend if any of the
following are used:

### `NETWORKX_AUTOMATIC_BACKENDS` environment variable.
The `NETWORKX_AUTOMATIC_BACKENDS` environment variable can be used to have NetworkX automatically dispatch to specified backends an API is called that the backend supports.
Set `NETWORKX_AUTOMATIC_BACKENDS=cugraph` to use nx-cugraph to GPU accelerate supported APIs with no code changes.
### `NX_CUGRAPH_AUTOCONFIG` environment variable.
By setting `NX_CUGRAPH_AUTOCONFIG=True`, NetworkX will automatically dispatch algorithm calls to nx-cugraph (if the backend is supported). This allows users to GPU accelerate their code with zero code change.

Read more on [Networkx Backends and How They Work](https://networkx.org/documentation/stable/reference/backends.html).

Example:
```
bash> NETWORKX_AUTOMATIC_BACKENDS=cugraph python my_networkx_script.py
bash> NX_CUGRAPH_AUTOCONFIG=True python my_networkx_script.py
```

### `backend=` keyword argument
To explicitly specify a particular backend for an API, use the `backend=`
keyword argument. This argument takes precedence over the
`NETWORKX_AUTOMATIC_BACKENDS` environment variable. This requires anyone
`NX_CUGRAPH_AUTOCONFIG` environment variable. This requires anyone
running code that uses the `backend=` keyword argument to have the specified
backend installed.

Expand Down

0 comments on commit afaf820

Please sign in to comment.