Struct eval_metrics::classification::PrCurve

source · [−]

pub struct PrCurve<T: Scalar> {
    pub points: Vec<PrPoint<T>>,
    /* private fields */
}

Expand description

Represents a full precision-recall curve

Fields

points: Vec<PrPoint<T>>

PR curve points

Implementations

impl<T: Scalar> PrCurve<T>

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

Computes the precision-recall curve from the provided data

Arguments

scores - vector of scores
labels - vector of labels

Errors

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

Examples

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

pub fn ap(&self) -> T

Computes average precision from the PR curve

Trait Implementations

impl<T: Clone + Scalar> Clone for PrCurve<T>

fn clone(&self) -> PrCurve<T>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<T: Debug + Scalar> Debug for PrCurve<T>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<T> RefUnwindSafe for PrCurve<T> where
T: RefUnwindSafe,

impl<T> Send for PrCurve<T> where
T: Send,

impl<T> Sync for PrCurve<T> where
T: Sync,

impl<T> Unpin for PrCurve<T> where
T: Unpin,

impl<T> UnwindSafe for PrCurve<T> where
T: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.