sapient-core 0.2.1

Core types, tensor, DType, buffer, and error handling for SAPIENT
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! `SapientError` — unified error type for the entire SAPIENT engine.

use thiserror::Error;

/// The central error enum for all SAPIENT operations.
#[derive(Debug, Error)]
pub enum SapientError {
    // ── Shape / Type errors ──────────────────────────────────────────────────
    #[error("Shape mismatch: expected {expected:?}, got {got:?}")]
    ShapeMismatch {
        expected: Vec<usize>,
        got: Vec<usize>,
    },

    #[error("Rank mismatch: expected {expected}, got {got}")]
    RankMismatch { expected: usize, got: usize },

    #[error("Type mismatch: expected {expected}, got {got}")]
    TypeMismatch { expected: String, got: String },

    #[error("Incompatible shapes for broadcasting: {lhs:?} and {rhs:?}")]
    BroadcastError { lhs: Vec<usize>, rhs: Vec<usize> },

    // ── Graph / IR errors ────────────────────────────────────────────────────
    #[error("Graph contains a cycle — execution is impossible")]
    CyclicGraph,

    #[error("Node {0:?} not found in graph")]
    NodeNotFound(String),

    #[error("Graph validation failed: {0}")]
    InvalidGraph(String),

    #[error("Shape inference failed for op '{op}': {reason}")]
    ShapeInferenceFailed { op: String, reason: String },

    // ── Backend errors ───────────────────────────────────────────────────────
    #[error("Backend '{backend}' does not support op '{op}'")]
    UnsupportedOp { backend: String, op: String },

    #[error("Backend error from '{backend}': {message}")]
    BackendError { backend: String, message: String },

    #[error("No suitable backend found for execution")]
    NoBackendAvailable,

    // ── Memory / allocation errors ───────────────────────────────────────────
    #[error("Allocation failed: requested {bytes} bytes (alignment {align})")]
    AllocationFailed { bytes: usize, align: usize },

    #[error("Buffer size mismatch: expected {expected} bytes, got {got}")]
    BufferSizeMismatch { expected: usize, got: usize },

    #[error("Memory pool exhausted — consider increasing pool capacity")]
    PoolExhausted,

    // ── Format / IO errors ───────────────────────────────────────────────────
    #[error("ONNX parse error: {0}")]
    OnnxParseError(String),

    #[error("GGUF parse error: {0}")]
    GgufParseError(String),

    #[error("Safetensors parse error: {0}")]
    SafetensorsParseError(String),

    #[error("Unsupported model format: {0}")]
    UnsupportedFormat(String),

    #[error("Model not found at path '{0}'")]
    ModelNotFound(String),

    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),

    // ── Scheduling / runtime errors ──────────────────────────────────────────
    #[error("Request timed out (deadline exceeded)")]
    DeadlineExceeded,

    #[error("Batch scheduler is shut down")]
    SchedulerShutdown,

    #[error("Runtime is not initialized — call Session::new() first")]
    UninitializedRuntime,

    // ── Telemetry errors ─────────────────────────────────────────────────────
    #[error("Telemetry export failed: {0}")]
    TelemetryError(String),

    // ── Catch-all ────────────────────────────────────────────────────────────
    #[error("Internal error: {0}")]
    Internal(String),
}

/// Convenience alias used throughout the codebase.
pub type Result<T> = std::result::Result<T, SapientError>;

// ── Helper constructors ──────────────────────────────────────────────────────

impl SapientError {
    /// Create a backend error with context.
    pub fn backend(backend: impl Into<String>, message: impl Into<String>) -> Self {
        Self::BackendError {
            backend: backend.into(),
            message: message.into(),
        }
    }

    /// Create an unsupported-op error.
    pub fn unsupported_op(backend: impl Into<String>, op: impl Into<String>) -> Self {
        Self::UnsupportedOp {
            backend: backend.into(),
            op: op.into(),
        }
    }

    /// Create an internal error.
    pub fn internal(msg: impl Into<String>) -> Self {
        Self::Internal(msg.into())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn error_display() {
        let e = SapientError::ShapeMismatch {
            expected: vec![2, 3],
            got: vec![2, 4],
        };
        let s = e.to_string();
        assert!(s.contains("Shape mismatch"));
        assert!(s.contains("[2, 3]"));
    }

    #[test]
    fn from_io_error() {
        let io_err = std::io::Error::new(std::io::ErrorKind::NotFound, "file missing");
        let e: SapientError = io_err.into();
        assert!(matches!(e, SapientError::Io(_)));
    }
}