Struct FBetaScoreMetric 

pub struct FBetaScoreMetric { /* private fields */ }

The F-beta score metric.

The beta parameter represents the ratio of recall importance to precision importance. beta > 1 gives more weight to recall, while beta < 1 favors precision.

Implementations

impl FBetaScoreMetric

pub fn binary(beta: f64, threshold: f64) -> FBetaScoreMetric

F-beta score metric for binary classification.

Arguments

• beta - Positive real factor to weight recall’s importance.
• threshold - The threshold to transform a probability into a binary prediction.

pub fn multiclass( beta: f64, top_k: usize, class_reduction: ClassReduction, ) -> FBetaScoreMetric

F-beta score metric for multiclass classification.

Arguments

• beta - Positive real factor to weight recall’s importance.
• top_k - The number of highest predictions considered to find the correct label (typically 1).
• class_reduction - Class reduction type.

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

F-beta score metric for multi-label classification.

Arguments

• beta - Positive real factor to weight recall’s importance.
• threshold - The threshold to transform a probability into a binary prediction.
• class_reduction - Class reduction type.

Trait Implementations

impl Clone for FBetaScoreMetric

fn clone(&self) -> FBetaScoreMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for FBetaScoreMetric

fn default() -> FBetaScoreMetric

Returns the “default value” for a type.

impl Metric for FBetaScoreMetric

type Input = ConfusionStatsInput

The input type of the metric.

fn update( &mut self, input: &<FBetaScoreMetric 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 FBetaScoreMetric

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.