WordErrorRate

burn::train::metric

Struct WordErrorRate

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

Expand description

The word error rate (WER) metric, similar to the CER, is defined as the edit distance (e.g. Levenshtein distance) between the predicted and reference word sequences, divided by the total number of words in the reference. Here, the “units” within the sequences are words.

Implementations§

impl<B> WordErrorRate<B>
where B: Backend,

pub fn new() -> WordErrorRate<B>

Creates the metric.

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

Sets the pad token.

Trait Implementations§

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

fn clone(&self) -> WordErrorRate<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 WordErrorRate<B>
where B: Backend,

fn default() -> WordErrorRate<B>

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

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

type Input = WerInput<B>

The input type of the metric.

fn update( &mut self, input: &WerInput<B>, _metadata: &MetricMetadata, ) -> SerializedEntry

Update the metric state and returns the current metric entry.

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

The parameterized name of the metric. Read more

fn clear(&mut self)

Clear the metric state.

fn attributes(&self) -> MetricAttributes

Attributes of the metric. Read more

fn description(&self) -> Option<String>

A short description of the metric.

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

fn value(&self) -> NumericEntry

Returns the numeric value of the metric.

fn running_value(&self) -> NumericEntry

Returns the current aggregated value of the metric over the global step (epoch).

Auto Trait Implementations§

impl<B> Freeze for WordErrorRate<B>

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

impl<B> Send for WordErrorRate<B>

impl<B> Sync for WordErrorRate<B>

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

impl<B> UnwindSafe for WordErrorRate<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> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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> IntoComptime for T

fn comptime(self) -> Self

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> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

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,