Struct CharErrorRate 

pub struct CharErrorRate { /* private fields */ }

Character error rate (CER) is defined as the edit distance (e.g. Levenshtein distance) between the predicted and reference character sequences, divided by the total number of characters in the reference. This metric is commonly used in tasks such as speech recognition, OCR, or text generation to quantify how closely the predicted output matches the ground truth at a character level.

Implementations

impl CharErrorRate

pub fn new() -> CharErrorRate

Creates the metric.

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

Sets the pad token.

Trait Implementations

impl Clone for CharErrorRate

fn clone(&self) -> CharErrorRate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CharErrorRate

fn default() -> CharErrorRate

Returns the “default value” for a type.

impl Metric for CharErrorRate

The character error rate metric implementation.

type Input = CerInput

The input type of the metric.

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

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.