burn::train::metric

Struct CharErrorRate

pub struct CharErrorRate<B>where
    B: Backend,
{ /* private fields */ }

Expand description

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<B> CharErrorRate<B>
where B: Backend,

pub fn new() -> CharErrorRate<B>

Creates the metric.

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

Sets the pad token.

Trait Implementations§

impl<B> Clone for CharErrorRate<B>
where B: Clone + Backend,

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

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<B> Default for CharErrorRate<B>
where B: Backend,

fn default() -> CharErrorRate<B>

Returns the “default value” for a type. Read more

impl<B> Metric for CharErrorRate<B>
where B: Backend,

The character error rate metric implementation.

type Input = CerInput<B>

The input type of the metric.

fn update( &mut self, input: &CerInput<B>, _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. Read more

impl<B> Numeric for CharErrorRate<B>
where B: Backend,

The character error rate metric implementation.

fn value(&self) -> NumericEntry

Returns the numeric value of the metric.

Auto Trait Implementations§

impl<B> Freeze for CharErrorRate<B>

impl<B> RefUnwindSafe for CharErrorRate<B>
where B: RefUnwindSafe,

impl<B> Send for CharErrorRate<B>

impl<B> Sync for CharErrorRate<B>

impl<B> Unpin for CharErrorRate<B>
where B: Unpin,

impl<B> UnwindSafe for CharErrorRate<B>
where B: UnwindSafe,

Blanket Implementations§

impl<T> Adaptor<()> for T

fn adapt(&self)

Adapt the type to be passed to a metric.

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WasmNotSend for T
where T: Send,

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

impl<T> WasmNotSync for T
where T: Sync,