concision-core 0.3.1

this crate implements the core modules for the concision framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

/*
    Appellation: error <module>
    Contrib: @FL03
*/
//! This module implements the core [`Error`] type for the framework and provides a [`Result`]
//! type alias for convenience.

/// a type alias for a [`Result`](core::result::Result) defined to use the custom [`Error`] as its error type.
pub type Result<T> = core::result::Result<T, Error>;

#[cfg(feature = "alloc")]
use alloc::{boxed::Box, string::String};
/// The [`Error`] type enumerates various errors that can occur within the framework.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
    #[error("The provided batch is empty")]
    EmptyBatch,
    #[error("Invalid model configuration")]
    InvalidModelConfig,
    #[error("The model is not supported for the given input")]
    IncompatibleInput,
    #[error("An invalid batch size was provided: {0}")]
    InvalidBatchSize(usize),
    #[error("Input is incompatible with the model: found {0} and expected {1}")]
    InvalidInputFeatures(usize, usize),
    #[error("The provided dataset has invalid target features: found {0} and expected {1}")]
    InvalidTargetFeatures(usize, usize),
    #[error("An uninitialized object was used")]
    Uninitialized,
    #[error("The model is not trained")]
    Untrained,
    #[cfg(feature = "alloc")]
    #[error("Unsupported model {0}")]
    UnsupportedModel(String),
    #[cfg(feature = "alloc")]
    #[error("An unsupported operation was attempted: {0}")]
    UnsupportedOperation(String),
    #[error("Parameter Error")]
    ParameterError(String),
    #[error(transparent)]
    AnyError(#[from] anyhow::Error),
    #[cfg(feature = "alloc")]
    #[error(transparent)]
    BoxError(#[from] Box<dyn core::error::Error + Send + Sync>),
    #[error(transparent)]
    ParamError(#[from] concision_params::ParamsError),
    #[error(transparent)]
    #[cfg(feature = "concision_init")]
    InitError(#[from] concision_init::InitError),
    #[cfg(feature = "serde")]
    #[error(transparent)]
    DeserializeError(#[from] serde::de::value::Error),
    #[error(transparent)]
    FmtError(#[from] core::fmt::Error),
    #[cfg(feature = "serde_json")]
    #[error(transparent)]
    JsonError(#[from] serde_json::Error),
    #[cfg(feature = "std")]
    #[error(transparent)]
    IoError(#[from] std::io::Error),
    #[error(transparent)]
    ShapeError(#[from] ndarray::ShapeError),
    #[error("Unknown Error: {0}")]
    UnknownError(String),
}

impl From<String> for Error {
    fn from(value: String) -> Self {
        Self::UnknownError(value)
    }
}

impl From<&str> for Error {
    fn from(value: &str) -> Self {
        Self::UnknownError(String::from(value))
    }
}