Struct CollectiveConfig 

pub struct CollectiveConfig { /* private fields */ }

Parameter struct for setting up and getting parameters for collective operations. Used in most collective api calls. This config is per-node. It is passed to reduce.

Implementations

impl CollectiveConfig

pub fn with_num_devices(self, num: usize) -> Self

Selects the number of devices (local peers) on the current node

pub fn with_local_all_reduce_strategy(self, strategy: AllReduceStrategy) -> Self

Selects an all-reduce strategy to use on the local level.

In multi-node contexts, use of the Ring strategy in the local level may be less advantageous. With multiple nodes, the global all-reduce step is enabled, and its result is redistributed to all devices. The Ring strategy inherently distributes the result, which in this context would not be necessary.

It is recommended to use a tree strategy locally, and a ring strategy globally.

pub fn with_local_reduce_strategy(self, strategy: ReduceStrategy) -> Self

Selects a reduce strategy to use on the local level.

pub fn with_local_broadcast_strategy(self, strategy: BroadcastStrategy) -> Self

Selects a broadcast strategy to use on the local level.

pub fn with_num_nodes(self, n: u32) -> Self

Set the number of nodes in the collective

This parameter is a global parameter and should only be set in multi-node contexts

pub fn with_global_address(self, addr: Address) -> Self

Set the network address of the Global Collective Orchestrator

This parameter is a global parameter and should only be set in multi-node contexts

pub fn with_node_address(self, addr: Address) -> Self

Define the address for this node

This parameter is a global parameter and should only be set in multi-node contexts

pub fn with_data_service_port(self, port: u16) -> Self

Selects the network port on which to expose the tensor data service used for peer-to-peer tensor downloading.

This parameter is a global parameter and should only be set in multi-node contexts

pub fn with_global_all_reduce_strategy( self, strategy: AllReduceStrategy, ) -> Self

Selects an all-reduce strategy to use on the global level.

This parameter is a global parameter and should only be set in multi-node contexts. See the local strategy

pub fn with_global_reduce_strategy(self, strategy: ReduceStrategy) -> Self

Selects an reduce strategy to use on the global level.

This parameter is a global parameter and should only be set in multi-node contexts. See the local strategy

pub fn with_global_broadcast_strategy(self, strategy: BroadcastStrategy) -> Self

Selects an broadcst strategy to use on the global level.

This parameter is a global parameter and should only be set in multi-node contexts. See the local strategy

pub fn is_valid(&self) -> bool

Returns whether the config is valid. If only some required global-level parameters are defined and others are not, the config is invalid.

Trait Implementations

impl Clone for CollectiveConfig

fn clone(&self) -> CollectiveConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectiveConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CollectiveConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CollectiveConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CollectiveConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CollectiveConfig

fn eq(&self, other: &CollectiveConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CollectiveConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CollectiveConfig

impl StructuralPartialEq for CollectiveConfig