162bed2aa2
* test: run tests also in wasm targets * fix: install rand with wasm-bindgen por wasm targets * fix: use actual usize size to access buffer. * fix: do not run functions that create files in wasm. * test: do not run in wasm test that panics. Co-authored-by: Luis Moreno <morenol@users.noreply.github.com>
93 lines
2.6 KiB
Rust
93 lines
2.6 KiB
Rust
//! # Recall score
|
|
//!
|
|
//! How many relevant items are selected?
|
|
//!
|
|
//! \\[recall = \frac{tp}{tp + fn}\\]
|
|
//!
|
|
//! where tp (true positive) - correct result, fn (false negative) - missing result
|
|
//!
|
|
//! Example:
|
|
//!
|
|
//! ```
|
|
//! use smartcore::metrics::recall::Recall;
|
|
//! let y_pred: Vec<f64> = vec![0., 1., 1., 0.];
|
|
//! let y_true: Vec<f64> = vec![0., 0., 1., 1.];
|
|
//!
|
|
//! let score: f64 = Recall {}.get_score(&y_pred, &y_true);
|
|
//! ```
|
|
//!
|
|
//! <script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
|
|
//! <script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
|
|
#[cfg(feature = "serde")]
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
use crate::linalg::BaseVector;
|
|
use crate::math::num::RealNumber;
|
|
|
|
/// Recall metric.
|
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
|
#[derive(Debug)]
|
|
pub struct Recall {}
|
|
|
|
impl Recall {
|
|
/// Calculated recall score
|
|
/// * `y_true` - cround truth (correct) labels.
|
|
/// * `y_pred` - predicted labels, as returned by a classifier.
|
|
pub fn get_score<T: RealNumber, V: BaseVector<T>>(&self, y_true: &V, y_pred: &V) -> T {
|
|
if y_true.len() != y_pred.len() {
|
|
panic!(
|
|
"The vector sizes don't match: {} != {}",
|
|
y_true.len(),
|
|
y_pred.len()
|
|
);
|
|
}
|
|
|
|
let mut tp = 0;
|
|
let mut p = 0;
|
|
let n = y_true.len();
|
|
for i in 0..n {
|
|
if y_true.get(i) != T::zero() && y_true.get(i) != T::one() {
|
|
panic!(
|
|
"Recall can only be applied to binary classification: {}",
|
|
y_true.get(i)
|
|
);
|
|
}
|
|
|
|
if y_pred.get(i) != T::zero() && y_pred.get(i) != T::one() {
|
|
panic!(
|
|
"Recall can only be applied to binary classification: {}",
|
|
y_pred.get(i)
|
|
);
|
|
}
|
|
|
|
if y_true.get(i) == T::one() {
|
|
p += 1;
|
|
|
|
if y_pred.get(i) == T::one() {
|
|
tp += 1;
|
|
}
|
|
}
|
|
}
|
|
|
|
T::from_i64(tp).unwrap() / T::from_i64(p).unwrap()
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
|
|
#[test]
|
|
fn recall() {
|
|
let y_true: Vec<f64> = vec![0., 1., 1., 0.];
|
|
let y_pred: Vec<f64> = vec![0., 0., 1., 1.];
|
|
|
|
let score1: f64 = Recall {}.get_score(&y_pred, &y_true);
|
|
let score2: f64 = Recall {}.get_score(&y_pred, &y_pred);
|
|
|
|
assert!((score1 - 0.5).abs() < 1e-8);
|
|
assert!((score2 - 1.0).abs() < 1e-8);
|
|
}
|
|
}
|