Struct eval_metrics::classification::BinaryConfusionMatrix

pub struct BinaryConfusionMatrix {
    pub tp_count: usize,
    pub fp_count: usize,
    pub tn_count: usize,
    pub fn_count: usize,
    // some fields omitted
}

Confusion matrix for binary classification

Fields

tp_count: usize

true positive count

fp_count: usize

false positive count

tn_count: usize

true negative count

fn_count: usize

false negative count

Implementations

impl BinaryConfusionMatrix

pub fn compute<T: Scalar>(
    scores: &Vec<T>,
    labels: &Vec<bool>,
    threshold: T
) -> Result<BinaryConfusionMatrix, EvalError>

Computes a new binary confusion matrix from the provided scores and labels

Arguments

• scores - vector of scores
• labels - vector of boolean labels
• threshold - decision threshold value for classifying scores

Errors

An invalid input error will be returned if either scores or labels are empty, or if their lengths do not match. An undefined metric error will be returned if scores contain any value that is not finite.

Examples

use eval_metrics::classification::BinaryConfusionMatrix;
let scores = vec![0.4, 0.7, 0.1, 0.3, 0.9];
let labels = vec![false, true, false, true, true];
let matrix = BinaryConfusionMatrix::compute(&scores, &labels, 0.5)?;

pub fn with_counts(
    tp_count: usize,
    fp_count: usize,
    tn_count: usize,
    fn_count: usize
) -> Result<BinaryConfusionMatrix, EvalError>

Constructs a binary confusion matrix with the provided counts

Arguments

• tp_count - true positive count
• fp_count - false positive count
• tn_count - true negative count
• fn_count - false negative count

Errors

An invalid input error will be returned if all provided counts are zero

pub fn accuracy(&self) -> Result<f64, EvalError>

Computes accuracy

pub fn precision(&self) -> Result<f64, EvalError>

Computes precision

pub fn recall(&self) -> Result<f64, EvalError>

Computes recall

pub fn f1(&self) -> Result<f64, EvalError>

Computes F1

pub fn mcc(&self) -> Result<f64, EvalError>

Computes Matthews correlation coefficient (phi)

Trait Implementations

impl Clone for BinaryConfusionMatrix

fn clone(&self) -> BinaryConfusionMatrix

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BinaryConfusionMatrix

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for BinaryConfusionMatrix

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<BinaryConfusionMatrix> for BinaryConfusionMatrix

fn eq(&self, other: &BinaryConfusionMatrix) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BinaryConfusionMatrix) -> bool

This method tests for !=.

impl Copy for BinaryConfusionMatrix

impl Eq for BinaryConfusionMatrix

impl StructuralEq for BinaryConfusionMatrix

impl StructuralPartialEq for BinaryConfusionMatrix