diff --git a/docs/cugraph/source/index.rst b/docs/cugraph/source/index.rst index 167971e33e7..f5c5c4a828d 100644 --- a/docs/cugraph/source/index.rst +++ b/docs/cugraph/source/index.rst @@ -11,15 +11,15 @@ Introduction cuGraph is a library of graph algorithms that seamlessly integrates into the RAPIDS data science ecosystem and allows the data scientist to easily call graph algorithms using data stored in GPU DataFrames, NetworkX Graphs, or -even CuPy or SciPy sparse Matrices. A major integration effort with NetworkX is focused on -**zero code change** use of nx-cuGraph as a backend for NetworkX calls. This allows a near seamless -transition to GPU accelerated graph analytics. +even CuPy or SciPy sparse Matrices. Our major integration effort with NetworkX allows +**zero code change** use of nx-cuGraph as a backend for NetworkX calls. This offers a near seamless +transition to GPU accelerated graph analytics to NetworkX users with access to a supported GPU. Getting started with cuGraph Required hardware/software for cuGraph and `RAPIDS `_ * NVIDIA GPU, Volta architecture or later, with `compute capability 7.0+`_ - * CUDA 11.4-11.8, 12.0-12.5 + * CUDA 11.2-11.8, 12.0-12.5 * Python version 3.10, 3.11, or 3.12 * NetworkX version 3.0 or newer in order to use use the nx-cuGraph backend. Version 3.3 is required to use `NetworkX Configs `_ `see below <#cugraph-using-networkx-code>`_. @@ -44,11 +44,10 @@ This includes several ways to set up cuGraph * `pip `_ - - Build From Source -To build from source, check each RAPIDS GitHub README for set up and build instructions. Further links are provided in the `selector tool `_. If additional help is needed reach out on our `Slack Channel `_. +To build from source, check each RAPIDS GitHub README for set up and build instructions. Further links are provided in the `selector tool `_. +If additional help is needed reach out on our `Slack Channel `_. CuGraph Using NetworkX Code While the steps above are required to use the full suite of cuGraph graph analytics, cuGraph is now supported as a NetworkX backend using `nx-cugraph _. @@ -56,7 +55,7 @@ Nx-cugraph offers those with existing NetworkX code, a **zero code change** opti Cugraph API Example -Coming soon ! + Until then, `the cuGraph notebook repository `_ @@ -66,18 +65,10 @@ A simple example of `testing the degree centrality algorithm `_ with larger data sets as well. .. toctree:: - :maxdepth: 1 - :caption: cuGraph documentation Contents: - - basics/index - nx_cugraph/index - installation/index - tutorials/index - graph_support/index - wholegraph/index - references/index - api_docs/index + :maxdepth: 2 + top_toc + Indices and tables ================== diff --git a/docs/cugraph/source/top_toc.rst b/docs/cugraph/source/top_toc.rst new file mode 100644 index 00000000000..aa06962a1b2 --- /dev/null +++ b/docs/cugraph/source/top_toc.rst @@ -0,0 +1,13 @@ +.. toctree:: + :maxdepth: 2 + :caption: cuGraph documentation Contents: + :name: top_toc + + basics/index + nx_cugraph/index + installation/index + tutorials/index + graph_support/index + wholegraph/index + references/index + api_docs/index \ No newline at end of file