LearnerComponents

burn_train

Struct LearnerComponents 

Source 
pub struct LearnerComponents<LC: LearnerComponentTypes> {
    pub optim: LC::Optimizer,
    pub lr_scheduler: LC::LrScheduler,
    pub num_epochs: usize,
    pub grad_accumulation: Option<usize>,
    pub checkpointer: Option<LearnerCheckpointer<LC>>,
    pub interrupter: Interrupter,
    pub early_stopping: Option<Box<dyn CloneEarlyStoppingStrategy>>,
    pub event_processor: LC::EventProcessor,
    pub event_store: Arc<EventStoreClient>,
}
Expand description

Struct to minimise parameters passed to LearningMethod::learn These components are used during training

Fields§

§optim: LC::Optimizer

The Optimizer used for the training.

§lr_scheduler: LC::LrScheduler

The learning rate scheduler used for the training.

§num_epochs: usize

The number of epochs the training should last.

§grad_accumulation: Option<usize>

Enables gradients accumulation.

§checkpointer: Option<LearnerCheckpointer<LC>>

A LearnerCheckpointer used to save and load training checkpoints.

§interrupter: Interrupter

An Interupter that allows aborting the training/evaluation process early.

§early_stopping: Option<Box<dyn CloneEarlyStoppingStrategy>>

Cloneable reference to an early stopping strategy.

§event_processor: LC::EventProcessor

An EventProcessor that processes events happening during training and validation.

§event_store: Arc<EventStoreClient>

A reference to an EventStoreClient.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Adaptor<()> for T

Source§

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V