Skip to main content

CollectiveConfig

Struct CollectiveConfig 

Source
pub struct CollectiveConfig {
    pub num_devices: usize,
    pub local_all_reduce: AllReduceStrategy,
    pub local_reduce: ReduceStrategy,
    pub local_broadcast: BroadcastStrategy,
    pub num_nodes: Option<usize>,
    pub global_all_reduce: Option<AllReduceStrategy>,
    pub global_reduce: Option<ReduceStrategy>,
    pub global_broadcast: Option<BroadcastStrategy>,
    pub tree_threshold_bytes: usize,
    pub tree_arity: usize,
    pub timeout: Duration,
}
Expand description

Configuration for collective operations.

Fields§

§num_devices: usize

Number of local devices (GPUs).

§local_all_reduce: AllReduceStrategy

Local all-reduce strategy.

§local_reduce: ReduceStrategy

Local reduce strategy.

§local_broadcast: BroadcastStrategy

Local broadcast strategy.

§num_nodes: Option<usize>

Number of nodes (None = single node).

§global_all_reduce: Option<AllReduceStrategy>

Global all-reduce strategy.

§global_reduce: Option<ReduceStrategy>

Global reduce strategy.

§global_broadcast: Option<BroadcastStrategy>

Global broadcast strategy.

§tree_threshold_bytes: usize

Threshold (bytes) below which tree is preferred over ring.

§tree_arity: usize

Tree arity (branching factor).

§timeout: Duration

Timeout for collective operations.

Implementations§

Source§

impl CollectiveConfig

Source

pub fn single_node(num_devices: usize) -> Self

Create a config for a single node with multiple devices.

Source

pub fn multi_node(num_devices: usize, num_nodes: usize) -> Self

Create a config for multi-node training.

Source

pub fn validate(&self) -> DistributedResult<()>

Validate the configuration.

Source

pub fn select_all_reduce( &self, buffer_size: usize, world_size: usize, ) -> AllReduceStrategy

Select the best all-reduce strategy for a given buffer size.

Trait Implementations§

Source§

impl Clone for CollectiveConfig

Source§

fn clone(&self) -> CollectiveConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CollectiveConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CollectiveConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for CollectiveConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,