Enum AggregationError 

pub enum AggregationError {
    NoCommunicator {
        world_size: usize,
    },
    WorldSizeMismatch {
        transport_world_size: usize,
        config_world_size: usize,
        transport_rank: usize,
    },
    ButterflyRequiresPowerOfTwo {
        world_size: usize,
    },
}

Hierarchical aggregation strategies for distributed training

This module provides advanced hierarchical aggregation algorithms that optimize communication patterns for different network topologies and cluster configurations. It supports tree-based, ring-based, and butterfly aggregation patterns.

Communication

Aggregation is performed over a real transport::Transport (in-process shared memory or TCP) through the algorithms in collective. A HierarchicalAggregator built without a transport can only service a world size of one; any larger configuration returns AggregationError::NoCommunicator instead of aggregating against fabricated data.

Errors raised by hierarchical aggregation.

Variants

NoCommunicator

No transport was attached, so no peer data can be exchanged.

Fields

world_size: usize

Configured world size.

WorldSizeMismatch

The attached transport disagrees with the configuration.

Fields

transport_world_size: usize

World size reported by the transport.

config_world_size: usize

World size derived from the configuration.

transport_rank: usize

Rank reported by the transport.

ButterflyRequiresPowerOfTwo

Butterfly (recursive doubling) requires a power-of-two world size.

Fields

world_size: usize

Configured world size.

Trait Implementations

impl Debug for AggregationError

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

Formats the value using the given formatter.

impl Display for AggregationError

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

Formats the value using the given formatter.

impl Error for AggregationError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.