oxicuda-seq 0.4.0

OxiCUDA: Sequence Models & Structured Prediction (HMM/CRF/Kalman/MRF/alignment)
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

//! Error types for `oxicuda-seq`.

use thiserror::Error;

/// Errors that can be produced by sequence model algorithms.
#[derive(Debug, Error)]
pub enum SeqError {
    #[error("shape mismatch: expected {expected}, got {got}")]
    ShapeMismatch { expected: usize, got: usize },

    #[error("dimension mismatch between operands: a={a}, b={b}")]
    DimensionMismatch { a: usize, b: usize },

    #[error("algorithm did not converge after {iter} iterations")]
    NotConverged { iter: usize },

    #[error("invalid configuration: {0}")]
    InvalidConfiguration(String),

    #[error("empty input")]
    EmptyInput,

    #[error("index {index} out of bounds (len = {len})")]
    IndexOutOfBounds { index: usize, len: usize },

    #[error("numerical instability detected: {0}")]
    NumericalInstability(String),

    #[error("probability {0} is out of [0, 1]")]
    ProbabilityOutOfRange(f64),

    #[error("invalid parameter `{name}`: value = {value}")]
    InvalidParameter { name: String, value: f64 },

    #[error("unsupported SM version: {0}")]
    UnsupportedSmVersion(u32),

    #[error("invalid observation: {0}")]
    InvalidObservation(String),

    #[error("length mismatch: a={a}, b={b}")]
    LengthMismatch { a: usize, b: usize },

    #[error("graph invariant violated: {0}")]
    GraphInvariantViolated(String),
}

/// Result alias for fallible sequence operations.
pub type SeqResult<T> = Result<T, SeqError>;