Skip to content

Commit ed7126e

Browse files
committed
Merge branch 'branch-25.04' into branch-25.06-merge-25.04
2 parents 7e17680 + afd1545 commit ed7126e

File tree

4 files changed

+50
-18
lines changed

4 files changed

+50
-18
lines changed

README.md

Lines changed: 36 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,62 @@
1-
# nx-cugraph
1+
# <div align="left"><img src="img/rapids_logo.png" width="90px"/>&nbsp;nx-cugraph - GPU Backend for NetworkX</div>
22

33
## 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+
---
612

713
## System Requirements
814

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.
1424

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

1726
## Installation
1827

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.
2029

2130
### 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.
2333
```
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
2535
```
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.
2738
```
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
2940
```
41+
3042
### 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
3249
```
3350
python -m pip install nx-cugraph-cu11 --extra-index-url https://pypi.anaconda.org/rapidsai-wheels-nightly/simple
3451
```
35-
#### latest stable version
52+
53+
Latest stable version
3654
```
3755
python -m pip install nx-cugraph-cu11 --extra-index-url https://pypi.nvidia.com
3856
```
3957
Notes:
4058
* 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.
4260

4361
## Enabling nx-cugraph
4462

@@ -281,4 +299,4 @@ Below is the list of algorithms that are currently supported in nx-cugraph.
281299
</pre>
282300

283301
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).

benchmarks/pytest-based/bench_algos.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -982,6 +982,20 @@ def bench_jaccard(benchmark, graph_obj, backend_wrapper):
982982
assert type(result) is list
983983

984984

985+
def bench_forceatlas2(benchmark, graph_obj, backend_wrapper):
986+
G = get_graph_obj_for_benchmark(graph_obj, backend_wrapper)
987+
988+
result = benchmark.pedantic(
989+
target=backend_wrapper(nx.forceatlas2_layout),
990+
args=(G,),
991+
rounds=rounds,
992+
iterations=iterations,
993+
warmup_rounds=warmup_rounds,
994+
)
995+
996+
assert type(result) is dict
997+
998+
985999
@pytest.mark.skip(reason="benchmark not implemented")
9861000
def bench_complete_bipartite_graph(benchmark, graph_obj, backend_wrapper):
9871001
pass

img/banner.png

91.8 KB
Loading

img/rapids_logo.png

111 KB
Loading

0 commit comments

Comments
 (0)