eval-metrics 1.0.2

Evaluation metrics for machine learning
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

//!
//! Details evaluation error types
//!

///
/// Represents a generic evaluation error
///
#[derive(Clone, Debug)]
pub struct EvalError {
    /// The error message
    pub msg: String
}

impl EvalError {

    ///
    /// Alerts than an invalid input was provided
    ///
    /// # Arguments
    ///
    /// * `msg` - detailed error message
    ///
    pub fn invalid_input(msg: &str) -> EvalError {
        EvalError {msg: format!("Invalid input: {}", msg)}
    }

    ///
    /// Alerts that an undefined metric was encountered
    ///
    /// # Arguments
    ///
    /// * `name` - metric name
    ///
    pub fn undefined_metric(name: &str) -> EvalError {
        EvalError {msg: format!("Undefined metric: {}", name)}
    }

    ///
    /// Alerts than an infinite/NaN value was encountered
    ///
    pub fn infinite_value() -> EvalError {
        EvalError {msg: String::from("Infinite or NaN value")}
    }

    ///
    /// Alerts that constant input data was encountered
    ///
    pub fn constant_input_data() -> EvalError {
        EvalError {msg: String::from("Constant input data")}
    }

    ///
    /// Alerts than an invalid metric was provided
    ///
    /// # Arguments
    ///
    /// * `name` - metric name
    ///
    pub fn invalid_metric(name: &str) -> EvalError {
        EvalError {msg: format!("Invalid metric: {}", name)}
    }
}

impl std::fmt::Display for EvalError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.msg)
    }
}

impl std::error::Error for EvalError {}