burn::train::metric

Struct TopKAccuracyMetric

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

Expand description

The Top-K accuracy metric.

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

Implementations§

§

impl TopKAccuracyMetric
where B: Backend,

pub fn new(k: usize) -> TopKAccuracyMetric

Creates the metric.

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

Sets the pad token.

Trait Implementations§

§

impl Clone for TopKAccuracyMetric
where B: Clone + Backend,

§

fn clone(&self) -> TopKAccuracyMetric

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 Default for TopKAccuracyMetric
where B: Default + Backend,

§

fn default() -> TopKAccuracyMetric

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

§

impl Metric for TopKAccuracyMetric
where B: Backend,

§

type Input = TopKAccuracyInput

The input type of the metric.

§

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

§

fn value(&self) -> NumericEntry

Returns the numeric value of the metric.

Auto Trait Implementations§

§

impl UnwindSafe for TopKAccuracyMetric
where B: UnwindSafe,

Blanket Implementations§

§

impl<T> Adaptor<()> for T

§

fn adapt(&self)

Adapt the type to be passed to a metric.

Source §

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

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

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

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

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

Source §

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

Mutably borrows from an owned value. Read more

Source §

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

Source §

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

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

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

Source §

fn into(self) -> U

Calls U::from(self).

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

Source §

impl<T> IntoEither for T

Source §

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

Source §

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

§