Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update nx-cugraph README with New Env Variable #4705

Merged
merged 5 commits into from
Oct 15, 2024
Merged

Update nx-cugraph README with New Env Variable #4705

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8ee18a0
Update README to use new env variable
nv-rliu Oct 8, 2024
343f1f9
Merge branch 'branch-24.12' into branch-24.12-update-nx-readme
nv-rliu Oct 8, 2024
824531f
Merge branch 'branch-24.12' into branch-24.12-update-nx-readme
nv-rliu Oct 9, 2024
0fc2e83
Merge branch 'branch-24.12' into branch-24.12-update-nx-readme
rlratzel Oct 15, 2024
ace57a1
Update based on feedback
nv-rliu Oct 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions python/nx-cugraph/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,18 @@ 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.
The `NX_CUGRAPH_AUTOCONFIG` environment variable can be used to have NetworkX automatically dispatch to specified backends if an API is called that the backend supports.
Set `NX_CUGRAPH_AUTOCONFIG=True` to use nx-cugraph to GPU accelerate supported APIs with zero code change.
nv-rliu marked this conversation as resolved.
Show resolved Hide resolved
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
Loading