Struct FBetaScoreMetric

pub struct FBetaScoreMetric<B>
where
    B: Backend,
{ /* 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<B> FBetaScoreMetric<B>

where B: Backend,

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

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<B>

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<B>

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<B> Clone for FBetaScoreMetric<B>

where B: Clone + Backend,

fn clone(&self) -> FBetaScoreMetric<B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B> Default for FBetaScoreMetric<B>

where B: Backend,

fn default() -> FBetaScoreMetric<B>

Returns the “default value” for a type.

impl<B> Metric for FBetaScoreMetric<B>

where B: Backend,

type Input = ConfusionStatsInput<B>

The input type of the metric.

fn update( &mut self, input: &<FBetaScoreMetric<B> as Metric>::Input, _metadata: &MetricMetadata, ) -> MetricEntry

Update the metric state and returns the current metric entry.

fn clear(&mut self)

Clear the metric state.

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

The parameterized name of the metric.

impl<B> Numeric for FBetaScoreMetric<B>

where B: Backend,

fn value(&self) -> NumericEntry

Returns the numeric value of the metric.