Struct ClientGroup 

pub struct ClientGroup { /* private fields */ }

The clients of distinct devices of one runtime that run collectives together, for a caller holding every member’s buffers.

Member i is rank i, in ascending device order. Work queued after a collective reads its result, but per-device all_reduce calls are not ordered against it, and on a device both use the two can hang. A member whose part fails, such as one whose source an earlier failure left stale, leaves the others waiting in it and runs no later collective over the group. Buffers move as bytes, so a pitched handle’s row padding counts toward its chunks.

Implementations

impl ClientGroup

pub fn new(clients: Vec<Client>) -> Result<Self, ClientGroupError>

A group of clients, one per member.

Errors

When there are none, when the device handle blocks, when they mix runtimes, when their devices are not in strictly ascending order, and when their runtime has no device transport.

pub fn clients(&self) -> &[Client]

The members’ clients, member i first being rank i.

pub fn reduces(&self, dtype: ElemType) -> bool

Whether the members reduce elements of dtype together. Every other collective moves bytes, whatever their type.

pub fn all_reduce( &self, buffers: Vec<MemberBuffers>, dtype: ElemType, op: ReduceOperation, )

Every member’s dst receives every member’s src reduced by op. A member’s src may be its dst.

pub fn all_gather(&self, buffers: Vec<MemberBuffers>)

Every member’s dst receives every member’s src, concatenated in member order.

pub fn reduce_scatter( &self, buffers: Vec<MemberBuffers>, dtype: ElemType, op: ReduceOperation, )

Member i’s dst receives chunk i of every member’s src reduced by op.

pub fn broadcast(&self, src: Handle, dst: Vec<Handle>)

Every member’s dst receives src, sent by the member whose device holds it. That member’s dst may be src.

pub fn all_to_all(&self, buffers: Vec<MemberBuffers>)

Member i’s dst receives chunk i of every member’s src, concatenated in member order.

Trait Implementations

impl Clone for ClientGroup

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.