Enum ExecutionError 

pub enum ExecutionError {
    WithContext {
        reason: String,
    },
    Generic {
        reason: String,
        backtrace: BackTrace,
    },
    DevicePoisoned {
        reason: String,
    },
}

An error that can happen when syncing a device.

Variants

WithContext

A generic error happened during execution.

The backtrace and context information should be included in the reason string.

Fields

reason: String

The reason of the error.

Generic

A generic error happened during execution thrown in the Burn project.

The full context isn’t captured by the string alone.

Fields

reason: String

The reason of the error.

backtrace: BackTrace

The backtrace.

DevicePoisoned

The device is poisoned: a kernel faulted in a way the driver cannot recover from (an illegal memory access, a trap, a hardware fault).

Unlike the other variants, every later operation on the device fails: the process has to be restarted to use the device again.

Fields

reason: String

The reason of the error.

Implementations

impl ExecutionError

pub fn generic(reason: impl Into<String>) -> ExecutionError

An error raised inside Burn, capturing where it was raised.

Capturing is cheap — a BackTrace resolves its frames only when it is displayed — so this is the constructor to reach for by default.

pub fn with_context(reason: impl Into<String>) -> ExecutionError

An error from outside Burn, whose context the message already carries.

pub fn device_poisoned(reason: impl Into<String>) -> ExecutionError

The device is poisoned, see ExecutionError::DevicePoisoned.

pub fn reason(&self) -> &str

What went wrong, without the backtrace around it.

pub fn is_device_poisoned(&self) -> bool

Whether the device from which the error originates is poisoned.

false means the operation that failed can be dropped or redone; true means further operations on this device will fail.

Trait Implementations

impl Clone for ExecutionError

fn clone(&self) -> ExecutionError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutionError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExecutionError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ExecutionError

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

Formats the value using the given formatter.

impl Error for ExecutionError

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<ExecutionError> for TensorReadError

fn from(source: ExecutionError) -> TensorReadError

Converts to this type from the input type.

impl Serialize for ExecutionError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.