Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
viclafargue committed Dec 12, 2024
1 parent fa1161c commit fc3572f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
14 changes: 9 additions & 5 deletions cpp/include/raft/core/device_resources_snmg.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,16 @@
namespace raft {

/**
* @brief SNMG resource container object that stores a NCCL clique and
* all necessary resources used for calling device functions, cuda kernels,
* libraries and/or NCCL communications on each GPU
* @brief SNMG (single-node multi-GPU) resource container object that stores a NCCL clique and all
* necessary resources used for calling device functions, cuda kernels, libraries and/or NCCL
* communications on each GPU. Note the `device_resources_snmg` object can also be used as a classic
* `device_resources` object. The associated resources will be the ones of the GPU used during
* object instantiation and a GPU switch operation will be ordered during the retrieval of said
* resources.
*
* Note that the NCCL communications sometimes require
* the use of multiple threads to avoid hangs
* The `device_resources_snmg` class is intended to be used in a single process to manage several
* GPUs. Please note that NCCL communications are the responsibility of the user. Blocking NCCL
* calls will sometimes require the use of several threads to avoid hangs.
*/
class device_resources_snmg : public device_resources {
public:
Expand Down
7 changes: 5 additions & 2 deletions docs/source/cpp_api/core_resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,11 @@ namespace *raft::core*
SNMG Device Resources
---------------------

The `raft::device_resources_snmg` provides a convenient way
to setup a NCCL clique and access device-related resources on each device.
The `raft::device_resources_snmg` provides a convenient way to design SNMG
(single-node multi-GPU) algorithms. It initiates device-related resources
for a set of devices forming clique. This includes NCCL communications.
GPUs can be addressed and exchanges be made over multiple threads
for performance or convenience.

``#include <raft/core/device_resources_snmg.hpp>``

Expand Down

0 comments on commit fc3572f

Please sign in to comment.