Enum DistributedError 

#[non_exhaustive]
pub enum DistributedError {
    InvalidWorldSize {
        world_size: usize,
    },
    InvalidRank {
        rank: usize,
        world_size: usize,
    },
    SelfSend {
        rank: usize,
    },
    SizeMismatch {
        expected: usize,
        got: usize,
    },
    Io {
        message: String,
    },
    LockPoisoned {
        message: String,
    },
    ChannelClosed {
        message: String,
    },
    UnsupportedOp {
        message: String,
    },
    Timeout {
        seconds: u64,
    },
    NoConnection {
        rank: usize,
    },
    BackendUnavailable {
        backend: &'static str,
    },
}

Errors specific to the distributed training subsystem.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidWorldSize

Fields

world_size: usize

InvalidRank

Fields

rank: usize

world_size: usize

SelfSend

Fields

rank: usize

SizeMismatch

Fields

expected: usize

got: usize

Io

Fields

message: String

LockPoisoned

Fields

message: String

ChannelClosed

Fields

message: String

UnsupportedOp

Fields

message: String

Timeout

Fields

seconds: u64

NoConnection

Fields

rank: usize

BackendUnavailable

Returned when the user requested a backend whose binding layer isn’t compiled into this build (e.g. gloo-backend / mpi-backend / ucc-backend feature off, or a CUDA-required backend on a non-CUDA system). The caller is expected to either enable the feature, install the underlying C library, or pick a different backend (SimulatedBackend / TcpBackend always work). (Replaces closed #459; live follow-ups: #1132 / #1133 / #1134.)

Fields

backend: &'static str

Trait Implementations

impl Debug for DistributedError

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

Formats the value using the given formatter.

impl Display for DistributedError

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

Formats the value using the given formatter.

impl Error for DistributedError

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.

impl From<DistributedError> for FerrotorchError

fn from(e: DistributedError) -> Self

Converts to this type from the input type.