Struct PrecisionMetric 

pub struct PrecisionMetric { /* private fields */ }

The Precision Metric

Implementations

impl PrecisionMetric

pub fn binary(threshold: f64) -> PrecisionMetric

Precision metric for binary classification.

Arguments

• threshold - The threshold to transform a probability into a binary prediction.

pub fn multiclass( top_k: usize, class_reduction: ClassReduction, ) -> PrecisionMetric

Precision metric for multiclass classification.

Arguments

• top_k - The number of highest predictions considered to find the correct label (typically 1).
• class_reduction - Class reduction type.

pub fn multilabel( threshold: f64, class_reduction: ClassReduction, ) -> PrecisionMetric

Precision metric for multi-label classification.

Arguments

• threshold - The threshold to transform a probability into a binary value.
• class_reduction - Class reduction type.

Trait Implementations

impl Clone for PrecisionMetric

fn clone(&self) -> PrecisionMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for PrecisionMetric

fn default() -> PrecisionMetric

Returns the “default value” for a type.

impl Metric for PrecisionMetric

type Input = ConfusionStatsInput

The input type of the metric.

fn update( &mut self, input: &<PrecisionMetric as Metric>::Input, _metadata: &MetricMetadata, ) -> Result<SerializedEntry, TensorReadError>

Update the metric state and returns the current metric entry.

fn compute(&mut self) -> Result<SerializedEntry, TensorReadError>

Compute the final metric value.

fn clear(&mut self)

Clear the metric state.

fn name(&self) -> Arc<String>

The parameterized name of the metric.

fn attributes(&self) -> MetricAttributes

Attributes of the metric.

fn description(&self) -> Option<String>

A short description of the metric.

impl Numeric for PrecisionMetric

fn value(&self) -> Option<NumericEntry>

Returns the numeric value of the metric, or None if this metric has no meaningful value yet (e.g. it only accumulates state per batch and computes its value once all state has been accumulated).

fn running_value(&self) -> Option<NumericEntry>

Returns the current aggregated value of the metric over the global step, or None if this metric has no meaningful value yet (e.g. it only accumulates state per batch and computes its value once all state has been accumulated).

fn final_value(&self) -> NumericEntry

Returns the final, authoritative value of the metric for the epoch. Only meaningful after Metric::compute has been called.