Struct eval_metrics::classification::BinaryConfusionMatrix
source · [−]pub struct BinaryConfusionMatrix {
pub tp_count: usize,
pub fp_count: usize,
pub tn_count: usize,
pub fn_count: usize,
/* private fields */
}
Expand description
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
sourceimpl BinaryConfusionMatrix
impl BinaryConfusionMatrix
sourcepub fn compute<T: Scalar>(
scores: &Vec<T>,
labels: &Vec<bool>,
threshold: T
) -> Result<BinaryConfusionMatrix, EvalError>
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 scoreslabels
- vector of boolean labelsthreshold
- 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)?;
sourcepub fn from_counts(
tp_count: usize,
fp_count: usize,
tn_count: usize,
fn_count: usize
) -> Result<BinaryConfusionMatrix, EvalError>
pub fn from_counts(
tp_count: usize,
fp_count: usize,
tn_count: usize,
fn_count: usize
) -> Result<BinaryConfusionMatrix, EvalError>
Trait Implementations
sourceimpl Clone for BinaryConfusionMatrix
impl Clone for BinaryConfusionMatrix
sourcefn clone(&self) -> BinaryConfusionMatrix
fn clone(&self) -> BinaryConfusionMatrix
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for BinaryConfusionMatrix
impl Debug for BinaryConfusionMatrix
sourceimpl Display for BinaryConfusionMatrix
impl Display for BinaryConfusionMatrix
sourceimpl PartialEq<BinaryConfusionMatrix> for BinaryConfusionMatrix
impl PartialEq<BinaryConfusionMatrix> for BinaryConfusionMatrix
sourcefn eq(&self, other: &BinaryConfusionMatrix) -> bool
fn eq(&self, other: &BinaryConfusionMatrix) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &BinaryConfusionMatrix) -> bool
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
Auto Trait Implementations
impl RefUnwindSafe for BinaryConfusionMatrix
impl Send for BinaryConfusionMatrix
impl Sync for BinaryConfusionMatrix
impl Unpin for BinaryConfusionMatrix
impl UnwindSafe for BinaryConfusionMatrix
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more