Struct TopKAccuracyMetric 

pub struct TopKAccuracyMetric { /* private fields */ }

The Top-K accuracy metric.

For K=1 (the default), this is equivalent to the accuracy metric.

Updating the metric panics if K exceeds the number of output classes.

Implementations

impl TopKAccuracyMetric

pub fn new(k: usize) -> TopKAccuracyMetric

Creates the metric.

Panics

Panics if k is zero.

pub fn with_pad_token(self, index: usize) -> TopKAccuracyMetric

Sets the pad token.

Trait Implementations

impl Clone for TopKAccuracyMetric

fn clone(&self) -> TopKAccuracyMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for TopKAccuracyMetric

fn default() -> TopKAccuracyMetric

Returns the “default value” for a type.

impl Metric for TopKAccuracyMetric

type Input = TopKAccuracyInput

The input type of the metric.

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

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.