doc organization (#1197)

* doc organization

* removing what is rccl file

* Update index.rst

[ROCm/rccl commit: 3301cdf59a]
This commit is contained in:
srawat
2024-06-03 18:38:45 +05:30
committed by GitHub
orang tua 4f56aa5f8c
melakukan 072c378bc0
5 mengubah file dengan 11 tambahan dan 22 penghapusan
+8 -2
Melihat File
@@ -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 <https://github.com/ROCm/rccl>`_.
The documentation is structured as follows:
.. grid:: 2
:gutter: 3
+3 -4
Melihat File
@@ -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:
-16
Melihat File
@@ -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.