burn-train 0.19.0

Training crate for the Burn framework
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

use crate::metric::{ItemLazy, processor::EventProcessorEvaluation};
use burn_core::{module::Module, prelude::Backend};
use std::marker::PhantomData;

/// All components necessary to evaluate a model grouped in one trait.
pub trait EvaluatorComponentTypes {
    /// The backend in used for the evaluation.
    type Backend: Backend;
    /// The model to evaluate.
    type Model: Module<Self::Backend>
        + TestStep<Self::TestInput, Self::TestOutput>
        + core::fmt::Display
        + 'static;
    type EventProcessor: EventProcessorEvaluation<ItemTest = Self::TestOutput> + 'static;
    /// Type of input to the evaluation step
    type TestInput: Send + 'static;
    /// Type of output of the evaluation step
    type TestOutput: ItemLazy + 'static;
}

/// Trait to be implemented for validating models.
pub trait TestStep<TI, TO> {
    /// Runs a test step.
    ///
    /// # Arguments
    ///
    /// * `item` - The item to validate on.
    ///
    /// # Returns
    ///
    /// The test output.
    fn step(&self, item: TI) -> TO;
}

/// A marker type used to provide [evaluation components](EvaluatorComponentTypes).
pub struct EvaluatorComponentTypesMarker<B, M, E, TI, TO> {
    _p: PhantomData<(B, M, E, TI, TO)>,
}

impl<B, M, E, TI, TO> EvaluatorComponentTypes for EvaluatorComponentTypesMarker<B, M, E, TI, TO>
where
    B: Backend,
    M: Module<B> + TestStep<TI, TO> + core::fmt::Display + 'static,
    E: EventProcessorEvaluation<ItemTest = TO> + 'static,
    TI: Send + 'static,
    TO: ItemLazy + 'static,
{
    type Backend = B;
    type Model = M;
    type EventProcessor = E;
    type TestInput = TI;
    type TestOutput = TO;
}