diff --git a/projects/rccl/docs/api-library.rst b/projects/rccl/docs/api-reference/api-library.rst similarity index 100% rename from projects/rccl/docs/api-library.rst rename to projects/rccl/docs/api-reference/api-library.rst diff --git a/projects/rccl/docs/library-specification.rst b/projects/rccl/docs/api-reference/library-specification.rst similarity index 100% rename from projects/rccl/docs/library-specification.rst rename to projects/rccl/docs/api-reference/library-specification.rst diff --git a/projects/rccl/docs/index.rst b/projects/rccl/docs/index.rst index a9960b2019..94582f35a3 100644 --- a/projects/rccl/docs/index.rst +++ b/projects/rccl/docs/index.rst @@ -8,10 +8,16 @@ RCCL documentation =========================== -Welcome to the ROCm Collective Communication Library (RCCL) docs home page! To learn more, see :ref:`what-is-rccl`. +RCCL (pronounced “Rickel”) is a stand-alone library that provides multi-GPU and multi-node collective communication primitives optimized for AMD GPUs. +It implements routines such as ``all-reduce``, ``all-gather``, ``reduce``, ``broadcast``, ``reduce-scatter``, ``gather``, ``scatter``, ``all-to-allv``, and ``all-to-all`` as well as direct point-to-point (GPU-to-GPU) send and receive operations. +The provided collective communication routines are implemented using Ring and Tree algorithms. They are optimized to achieve high bandwidth and low latency by leveraging topology awareness, high-speed interconnects, and RDMA based collectives. -Our documentation is structured as follows: +RCCL utilizes PCIe and xGMI high-speed interconnects for intra-node communication as well as InfiniBand, RoCE, and TCP/IP for inter-node communication. +It supports an arbitrary number of GPUs installed in a single-node or multi-node platform and can be easily integrated into single- or multi-process (e.g., MPI) applications. +You can access RCCL code on our `GitHub repository `_. + +The documentation is structured as follows: .. grid:: 2 :gutter: 3 diff --git a/projects/rccl/docs/sphinx/_toc.yml.in b/projects/rccl/docs/sphinx/_toc.yml.in index ce1d262a08..3152ccf499 100644 --- a/projects/rccl/docs/sphinx/_toc.yml.in +++ b/projects/rccl/docs/sphinx/_toc.yml.in @@ -1,12 +1,11 @@ root: index subtrees: -- entries: - - file: what-is-rccl + - caption: API reference entries: - - file: library-specification + - file: api-reference/library-specification title: Library specification - - file: api-library + - file: api-reference/api-library - caption: About entries: diff --git a/projects/rccl/docs/what-is-rccl.rst b/projects/rccl/docs/what-is-rccl.rst deleted file mode 100644 index 110b4651c8..0000000000 --- a/projects/rccl/docs/what-is-rccl.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. meta:: - :description: RCCL is a stand-alone library that provides multi-GPU and multi-node collective communication primitives optimized for AMD GPUs - :keywords: RCCL, ROCm, library, API - -.. _what-is-rccl: - -===================== -What is RCCL? -===================== - -RCCL (pronounced “Rickel”) is a stand-alone library that provides multi-GPU and multi-node collective communication primitives optimized for AMD GPUs. -It implements routines such as `all-reduce`, `all-gather`, `reduce`, `broadcast`, `reduce-scatter`, `gather`, `scatter`, `all-to-allv`, and `all-to-all` as well as direct point-to-point (GPU-to-GPU) send and receive operations. -The provided collective communication routines are implemented using Ring and Tree algorithms. They are optimized to achieve high bandwidth and low latency by leveraging topology awareness, high-speed interconnects, and RDMA based collectives. - -RCCL utilizes PCIe and xGMI high-speed interconnects for intra-node communication as well as InfiniBand, RoCE, and TCP/IP for inter-node communication. -It supports an arbitrary number of GPUs installed in a single-node or multi-node platform and can be easily integrated into single- or multi-process (e.g., MPI) applications.