rust_metrics 0.1.0

Incremental evaluation metrics for classification and text generation pipelines.
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

#[derive(Debug, PartialEq, Eq)]
pub enum MetricError {
    LengthMismatch {
        predictions: usize,
        targets: usize,
    },
    InvalidClassIndex {
        class: usize,
        num_classes: usize,
    },
    InvalidLabelShape {
        total_labels: usize,
        num_labels: usize,
    },
    IncompatibleInput {
        expected: &'static str,
        got: &'static str,
    },
}

pub trait Metric<Input> {
    type Output;

    fn update(&mut self, input: Input) -> Result<(), MetricError>;

    fn reset(&mut self);

    fn compute(&self) -> Option<Self::Output>;
}