brainharmony 0.1.0

Brain-Harmony multimodal brain foundation model — inference in Rust with Burn ML
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

/// Typed errors for brainharmony.
///
/// All public APIs return `Result<T, BrainHarmonyError>` (or `anyhow::Result`
/// for the CLI).  Match on the variant to handle specific failure modes.
use std::path::PathBuf;

#[derive(Debug, thiserror::Error)]
pub enum BrainHarmonyError {
    // -- Config -------------------------------------------------------------------

    #[error("unknown model variant \"{name}\" (expected vit_small, vit_base, or vit_large)")]
    UnknownVariant { name: String },

    #[error("invalid positional embedding mode \"{mode}\" (expected \"gradient_geoh\" or \"sincos\")")]
    InvalidPosMode { mode: String },

    // -- Files --------------------------------------------------------------------

    #[error("{kind} file not found: {path}")]
    FileNotFound { kind: &'static str, path: PathBuf },

    // -- Data ---------------------------------------------------------------------

    #[error("CSV is empty or contains no valid rows: {path}")]
    EmptyCsv { path: PathBuf },

    #[error(
        "CSV row {row} has {got} columns, expected {expected} (file: {path})"
    )]
    InconsistentCsvRow {
        path: PathBuf,
        row: usize,
        expected: usize,
        got: usize,
    },

    #[error("gradient CSV has {got} ROIs, expected {expected}")]
    GradientRoiMismatch { expected: usize, got: usize },

    #[error("geometric harmonics CSV has {got} ROIs, expected {expected}")]
    GeohRoiMismatch { expected: usize, got: usize },

    #[error("token count {got} exceeds maximum {max}")]
    TokenCountExceeded { got: usize, max: usize },

    // -- Weights ------------------------------------------------------------------

    #[error("weight key not found: {key}")]
    WeightKeyMissing { key: String },

    // -- Tensor -------------------------------------------------------------------

    #[error("tensor conversion failed: {reason}")]
    TensorConversion { reason: String },

    // -- Pass-through -------------------------------------------------------------

    #[error(transparent)]
    Io(#[from] std::io::Error),

    #[error(transparent)]
    Other(#[from] anyhow::Error),
}

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