Enum ModelError

#[non_exhaustive]
pub enum ModelError {
    NotInitialized,
    NotTrained,
    InvalidModelConfig,
    UnsupportedModel,
    IncompatibleInput,
    UnsupportedOperation,
    InvalidBatchSize,
    InvalidInputShape,
    InvalidOutputShape,
    TrainingError(TrainingError),
    CoreError(Error),
}

The ModelError type is used to define the various errors encountered by the different components of a neural network. It is designed to be comprehensive, covering a wide range of potential issues that may arise during the operation of neural network components, such as invalid configurations, training failures, and other runtime errors. This error type is intended to provide a clear and consistent way to handle errors across the neural network components, making it easier to debug and resolve issues that may occur during the development and execution of neural network models.

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.

NotInitialized

The model is not initialized

NotTrained

The model is not trained

InvalidModelConfig

The model is not valid

UnsupportedModel

The model is not supported

IncompatibleInput

The model is not compatible with the given input

UnsupportedOperation

InvalidBatchSize

InvalidInputShape

InvalidOutputShape

TrainingError(TrainingError)

CoreError(Error)

Implementations

impl ModelError

pub fn not_initialized() -> Self

pub fn not_trained() -> Self

pub fn invalid_model_config() -> Self

pub fn unsupported_model() -> Self

pub fn incompatible_input() -> Self

pub fn unsupported_operation() -> Self

pub fn invalid_batch_size() -> Self

pub fn invalid_input_shape() -> Self

pub fn invalid_output_shape() -> Self

pub fn training_error(field_0: TrainingError) -> Self

pub fn core_error(field_0: Error) -> Self

Trait Implementations

impl Debug for ModelError

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

Formats the value using the given formatter.

impl Display for ModelError

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

Formats the value using the given formatter.

impl Error for ModelError

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<Error> for ModelError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ModelError> for Error

fn from(err: ModelError) -> Self

Converts to this type from the input type.

impl From<TrainingError> for ModelError

fn from(source: TrainingError) -> Self

Converts to this type from the input type.