nove_learner 0.1.2

An easy-to-use, lightweight deep learning library wrapped around Candle Tensor.
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

use nove_dataloader::DataloaderError;
use nove_lossfn::LossFnError;
use nove_metric::AnyMetric;
use nove_model::ModelError;
use nove_optimizer::OptimizerError;
use nove_tensor::{DeviceError, TensorError};
use thiserror::Error;

pub mod common;

#[derive(Error, Debug)]
pub enum LearnerError {
    /// Tensor errors from the `nove_tensor` crate.
    #[error(transparent)]
    TensorError(#[from] TensorError),

    /// Device errors from the `nove_tensor` crate.
    #[error(transparent)]
    DeviceError(#[from] DeviceError),

    /// Dataloader errors from the `nove_dataloader` crate.
    #[error(transparent)]
    DataloaderError(#[from] DataloaderError),

    /// Optimizer errors from the `nove_optimizer` crate.
    #[error(transparent)]
    OptimizerError(#[from] OptimizerError),

    /// Model errors from the `nove_model` crate.
    #[error(transparent)]
    ModelError(#[from] ModelError),

    /// Lossfn errors from the `nove_lossfn` crate.
    #[error(transparent)]
    LossfnError(#[from] LossFnError),

    /// Metric errors from the `nove_metric` crate.
    #[error(transparent)]
    MetricError(#[from] nove_metric::MetricError),

    /// Missing argument.
    #[error("Missing argument: {0}")]
    MissingArgument(String),

    /// Invalid argument.
    #[error("Invalid argument: {0}")]
    InvalidArgument(String),

    /// Invalid path.
    #[error("Invalid path: {0}")]
    InvalidPath(String),

    /// Other errors.
    #[error("Other errors: {0}")]
    OtherError(String),
}

pub trait Learner {
    fn train(&mut self) -> Result<(), LearnerError>;
    fn validate(&mut self) -> Result<Vec<AnyMetric>, LearnerError>;
    fn test(&mut self) -> Result<Vec<AnyMetric>, LearnerError>;
}