rust_metrics 0.1.1

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
30
31
32
33
34
35
36
37
38
39
40
41
42

/// Errors emitted by metrics when incoming batches cannot be processed.
#[derive(Debug, PartialEq, Eq)]
pub enum MetricError {
    /// `predictions.len()` and `targets.len()` differ.
    LengthMismatch {
        predictions: usize,
        targets: usize,
    },
    /// A class index is outside the configured range.
    InvalidClassIndex {
        class: usize,
        num_classes: usize,
    },
    /// Multilabel inputs do not align with the expected shape.
    InvalidLabelShape {
        total_labels: usize,
        num_labels: usize,
    },
    /// Inputs fail additional validation (value ranges, binary labels, etc.).
    IncompatibleInput {
        expected: &'static str,
        got: &'static str,
    },
}

/// Common interface implemented by every streaming metric.
///
/// Metrics accept batched `Input` values via [`update`](Metric::update), can be cleared with
/// [`reset`](Metric::reset), and report an [`Output`](Metric::Output) when enough data has been
/// observed.
pub trait Metric<Input> {
    type Output;

    /// Incorporate another batch of predictions/targets.
    fn update(&mut self, input: Input) -> Result<(), MetricError>;

    /// Drop any accumulated state.
    fn reset(&mut self);

    /// Compute the final value; returns `None` until at least one batch was seen.
    fn compute(&self) -> Option<Self::Output>;
}