Skip to content

Commit d8b1735

Browse files
committed
Restructure cuGraph documentation overview
1 parent 76dbf69 commit d8b1735

1 file changed

Lines changed: 44 additions & 24 deletions

File tree

docs/cugraph-docs/source/index.rst

Lines changed: 44 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,54 @@
11
NVIDIA cuGraph Documentation
22
============================
33

4-
.. note::
5-
6-
**cuGraph-DGL has been removed from cuGraph GNN as of release 25.06.** We recommend migrating to
7-
cuGraph-PyG, which offers the same functionality along with additional features like support for heterogeneous sampling and a unified API.
8-
The cuGraph team is not planning any further work in the DGL ecosystem going forward.
9-
10-
The cuGraph repository has been refactored to make it more efficient to build, maintain and use.
11-
12-
Libraries supporting GNNs are now located in the `cugraph-gnn repository <https://github.com/rapidsai/cugraph-gnn>`_.
13-
14-
* `pylibwholegraph <https://github.com/rapidsai/cugraph-gnn/tree/main/python/>`_ - the `Wholegraph <https://docs.rapids.ai/api/cugraph/nightly/wholegraph/>`_ library for client memory management supporting cuGraph-PyG for even greater scalability
15-
* `cugraph_pyg <https://github.com/rapidsai/cugraph-gnn/blob/main/readme_pages/cugraph_pyg.md>`_ provides native implementations of Pytorch Geometric's (PyG's) `GraphStore`, `FeatureStore`, and `Loader` interfaces, unlocking powerful GPU-accelerated graph analytics—including neighborhood sampling, centrality metrics, and community detection—directly within PyG workflows.
16-
17-
`RAPIDS nx-cugraph <https://rapids.ai/nx-cugraph/>`_ is now located in the `nx-cugraph repository <https://github.com/rapidsai/nx-cugraph>`_ containing a backend to NetworkX for running supported algorithms with GPU acceleration.
18-
19-
The `cugraph-docs repository <https://github.com/rapidsai/cugraph-docs>`_ contains code to generate NVIDIA cuGraph documentation.
20-
214
.. image:: images/cugraph_logo_2.png
225
:width: 600
236

24-
~~~~~~~~~~~~
25-
Introduction
26-
~~~~~~~~~~~~
27-
NVIDIA cuGraph is a library of graph algorithms that seamlessly integrates into the
28-
RAPIDS data science ecosystem and allows data scientists to easily call
29-
graph algorithms using data stored in cuDF/Pandas DataFrames or CuPy/SciPy
30-
sparse matrices.
7+
Overview
8+
--------
9+
10+
NVIDIA cuGraph is an open-source collection of GPU-accelerated graph analytics
11+
libraries. It supports creating and manipulating graphs and running scalable
12+
graph algorithms. Its Python APIs integrate with data stored in cuDF and pandas
13+
DataFrames, CuPy and SciPy sparse matrices, and NetworkX graphs. Lower-level
14+
Python, C, and C++ APIs support applications that need closer integration with
15+
cuGraph's graph primitives.
16+
17+
NVIDIA cuGraph libraries and supporting projects are maintained across several
18+
repositories:
19+
20+
* `cuGraph <https://github.com/rapidsai/cugraph>`_ provides the core
21+
GPU-accelerated graph analytics libraries, including the high-level
22+
:doc:`Python API <api_docs/cugraph/index>`, the lower-level
23+
:doc:`pylibcugraph Python API <api_docs/plc/pylibcugraph>`, the
24+
:doc:`C API <api_docs/cugraph_c/index>`, and the
25+
:doc:`C++ API <api_docs/cugraph_cpp/index>`.
26+
* `cuGraph-GNN <https://github.com/rapidsai/cugraph-gnn>`_ contains
27+
GPU-accelerated packages for graph neural network workflows built on NVIDIA
28+
cuGraph.
29+
30+
* `cuGraph-PyG <https://github.com/rapidsai/cugraph-gnn/tree/main/python/cugraph-pyg>`_
31+
integrates NVIDIA cuGraph with PyTorch Geometric and implements its
32+
``GraphStore``, ``FeatureStore``, ``Loader``, and ``Sampler`` interfaces.
33+
See the :doc:`Python API <api_docs/cugraph-pyg/cugraph_pyg>`.
34+
* `pylibwholegraph <https://github.com/rapidsai/cugraph-gnn/tree/main/python/pylibwholegraph>`_
35+
provides Python interfaces for distributed graph and key-value storage
36+
through WholeGraph. cuGraph-PyG can use WholeGraph for greater scalability.
37+
See the :doc:`Python API <api_docs/wholegraph/pylibwholegraph/index>`.
38+
39+
* `nx-cugraph <https://github.com/rapidsai/nx-cugraph>`_ provides a NetworkX
40+
backend that can accelerate supported NetworkX algorithms on NVIDIA GPUs with
41+
zero code changes. See the :doc:`nx-cugraph documentation <nx_cugraph/index>`.
42+
* `cuGraph Docs <https://github.com/rapidsai/cugraph-docs>`_ contains the
43+
documentation sources and build configuration for NVIDIA cuGraph and its
44+
related libraries.
45+
46+
.. note::
3147

48+
**cuGraph-DGL was removed in release 25.08.** We recommend migrating to
49+
cuGraph-PyG, which provides the same functionality along with additional
50+
features such as heterogeneous sampling and a unified API. The cuGraph team
51+
is not planning further work in the DGL ecosystem.
3252

3353
---------------------------
3454
cuGraph Using NetworkX Code

0 commit comments

Comments
 (0)