oxionnx 0.1.2

Pure Rust ONNX inference engine — zero C/C++ dependencies
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204

//! Numerical tolerance validation for inference results.

use oxionnx_core::Tensor;

/// Result of comparing two tensors with tolerance.
#[derive(Debug, Clone)]
pub struct ToleranceReport {
    /// Maximum absolute error across all elements.
    pub max_abs_error: f32,
    /// Mean absolute error.
    pub mean_abs_error: f32,
    /// Maximum relative error (excluding near-zero values).
    pub max_rel_error: f32,
    /// Mean relative error.
    pub mean_rel_error: f32,
    /// Number of elements compared.
    pub num_elements: usize,
    /// Number of elements exceeding absolute tolerance.
    pub num_abs_violations: usize,
    /// Number of elements exceeding relative tolerance.
    pub num_rel_violations: usize,
    /// Whether the comparison passed (within tolerance).
    pub passed: bool,
}

/// Compare two tensors with specified tolerances.
///
/// `abs_tol`: maximum allowed absolute error per element.
/// `rel_tol`: maximum allowed relative error per element.
/// An element passes if `|a - b| <= abs_tol + rel_tol * |b|`.
pub fn compare_tensors(
    actual: &Tensor,
    expected: &Tensor,
    abs_tol: f32,
    rel_tol: f32,
) -> Result<ToleranceReport, String> {
    if actual.shape != expected.shape {
        return Err(format!(
            "Shape mismatch: {:?} vs {:?}",
            actual.shape, expected.shape
        ));
    }
    if actual.data.len() != expected.data.len() {
        return Err(format!(
            "Length mismatch: {} vs {}",
            actual.data.len(),
            expected.data.len()
        ));
    }

    let n = actual.data.len();
    let mut max_abs = 0.0f32;
    let mut sum_abs = 0.0f64;
    let mut max_rel = 0.0f32;
    let mut sum_rel = 0.0f64;
    let mut abs_violations = 0usize;
    let mut rel_violations = 0usize;

    for i in 0..n {
        let a = actual.data[i];
        let e = expected.data[i];
        let abs_err = (a - e).abs();

        if abs_err > max_abs {
            max_abs = abs_err;
        }
        sum_abs += abs_err as f64;

        let threshold = abs_tol + rel_tol * e.abs();
        if abs_err > threshold {
            abs_violations += 1;
        }

        // Relative error (avoid division by near-zero)
        if e.abs() > 1e-8 {
            let rel_err = abs_err / e.abs();
            if rel_err > max_rel {
                max_rel = rel_err;
            }
            sum_rel += rel_err as f64;
            if rel_err > rel_tol {
                rel_violations += 1;
            }
        }
    }

    let mean_abs = if n > 0 {
        (sum_abs / n as f64) as f32
    } else {
        0.0
    };
    let mean_rel = if n > 0 {
        (sum_rel / n as f64) as f32
    } else {
        0.0
    };

    Ok(ToleranceReport {
        max_abs_error: max_abs,
        mean_abs_error: mean_abs,
        max_rel_error: max_rel,
        mean_rel_error: mean_rel,
        num_elements: n,
        num_abs_violations: abs_violations,
        num_rel_violations: rel_violations,
        passed: abs_violations == 0,
    })
}

/// Quick check: are two tensors approximately equal?
pub fn tensors_close(actual: &Tensor, expected: &Tensor, atol: f32, rtol: f32) -> bool {
    compare_tensors(actual, expected, atol, rtol)
        .map(|r| r.passed)
        .ok()
        .unwrap_or(false)
}

impl std::fmt::Display for ToleranceReport {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "Tolerance Report: {} elements, max_abs={:.6}, mean_abs={:.6}, \
             max_rel={:.6}, abs_violations={}, passed={}",
            self.num_elements,
            self.max_abs_error,
            self.mean_abs_error,
            self.max_rel_error,
            self.num_abs_violations,
            self.passed
        )
    }
}

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

    #[test]
    fn test_compare_tensors_exact() {
        let a = Tensor::new(vec![1.0, 2.0, 3.0, 4.0], vec![2, 2]);
        let b = Tensor::new(vec![1.0, 2.0, 3.0, 4.0], vec![2, 2]);
        let report = compare_tensors(&a, &b, 1e-6, 1e-6).expect("should succeed");
        assert!(report.passed);
        assert_eq!(report.num_abs_violations, 0);
        assert_eq!(report.num_rel_violations, 0);
        assert!(report.max_abs_error < 1e-10);
    }

    #[test]
    fn test_compare_tensors_within_tol() {
        let a = Tensor::new(vec![1.001, 2.001, 3.001], vec![3]);
        let b = Tensor::new(vec![1.0, 2.0, 3.0], vec![3]);
        // abs_tol=0.01 should pass since max diff is 0.001
        let report = compare_tensors(&a, &b, 0.01, 0.01).expect("should succeed");
        assert!(report.passed);
        assert_eq!(report.num_abs_violations, 0);
    }

    #[test]
    fn test_compare_tensors_violation() {
        let a = Tensor::new(vec![1.0, 2.0, 10.0], vec![3]);
        let b = Tensor::new(vec![1.0, 2.0, 3.0], vec![3]);
        // abs_tol=0.1, rel_tol=0.1: element at index 2 differs by 7.0
        let report = compare_tensors(&a, &b, 0.1, 0.1).expect("should succeed");
        assert!(!report.passed);
        assert!(report.num_abs_violations > 0);
        assert!((report.max_abs_error - 7.0).abs() < 1e-5);
    }

    #[test]
    fn test_compare_tensors_shape_mismatch() {
        let a = Tensor::new(vec![1.0, 2.0, 3.0], vec![3]);
        let b = Tensor::new(vec![1.0, 2.0, 3.0, 4.0], vec![4]);
        let result = compare_tensors(&a, &b, 1e-6, 1e-6);
        assert!(result.is_err());
        let err = result.expect_err("should be error");
        assert!(err.contains("Shape mismatch"));
    }

    #[test]
    fn test_tensors_close() {
        let a = Tensor::new(vec![1.0, 2.0, 3.0], vec![3]);
        let b = Tensor::new(vec![1.0, 2.0, 3.0], vec![3]);
        assert!(tensors_close(&a, &b, 1e-6, 1e-6));

        let c = Tensor::new(vec![1.0, 2.0, 100.0], vec![3]);
        assert!(!tensors_close(&a, &c, 1e-6, 1e-6));

        // Shape mismatch returns false
        let d = Tensor::new(vec![1.0, 2.0], vec![2]);
        assert!(!tensors_close(&a, &d, 1e-6, 1e-6));
    }

    #[test]
    fn test_tolerance_report_display() {
        let a = Tensor::new(vec![1.0, 2.0, 3.0], vec![3]);
        let b = Tensor::new(vec![1.0, 2.0, 3.0], vec![3]);
        let report = compare_tensors(&a, &b, 1e-6, 1e-6).expect("should succeed");
        let display = format!("{report}");
        assert!(display.contains("Tolerance Report"));
        assert!(display.contains("3 elements"));
        assert!(display.contains("passed=true"));
    }
}