burn::train::metric

Struct MetricMetadata

pub struct MetricMetadata {
    pub progress: Progress,
    pub global_progress: Progress,
    pub iteration: Option<usize>,
    pub lr: Option<f64>,
}

Expand description

Metric metadata that can be used when computing metrics.

Fields§

§progress: Progress

The current progress.

§global_progress: Progress

The global progress of the training (e.g. epochs).

§iteration: Option<usize>

The current iteration.

§lr: Option<f64>

The current learning rate.

Trait Implementations§

§

impl<T> From<&EvaluationItem<T>> for MetricMetadata

§

fn from(item: &EvaluationItem<T>) -> MetricMetadata

Converts to this type from the input type.

§

impl<T> From<&TrainingItem<T>> for MetricMetadata

§

fn from(item: &TrainingItem<T>) -> MetricMetadata

Converts to this type from the input type.

Auto Trait Implementations§

§

impl UnwindSafe for MetricMetadata

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

§

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.

§

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

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.

§

impl<T> IntoComptime for T

§

fn comptime(self) -> Self

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

§