Struct TrainEpoch

Source

pub struct TrainEpoch<TI> { /* private fields */ }

Expand description

A training epoch.

Implementations§

Source §

impl<TI> TrainEpoch<TI>

Source

pub fn new( dataloader: Arc<dyn DataLoader<TI>>, epoch: usize, epoch_total: usize, grad_accumulation: Option<usize>, ) -> Self

Constructs a new TrainEpoch.

Source §

impl<TI> TrainEpoch<TI>

Source

pub fn run<LC: LearnerComponents, TO>( &self, model: LC::Model, optim: LC::Optimizer, scheduler: &mut LC::LrScheduler, processor: &mut LC::EventProcessor, interrupter: &TrainingInterrupter, ) -> (LC::Model, LC::Optimizer)
where LC::EventProcessor: EventProcessor<ItemTrain = TO>, LC::Model: TrainStep<TI, TO>,

Runs the training epoch.

§Arguments

model - The model to train.
optim - The optimizer to use.
scheduler - The learning rate scheduler to use.
processor - The event processor to use.

§Returns

The trained model and the optimizer.

Source §

impl<TI> TrainEpoch<TI>

Source

pub fn run_multi_device<LC: LearnerComponents, TO>( &self, model: LC::Model, optim: LC::Optimizer, lr_scheduler: &mut LC::LrScheduler, processor: &mut LC::EventProcessor, devices: Vec<<LC::Backend as Backend>::Device>, interrupter: &TrainingInterrupter, ) -> (LC::Model, LC::Optimizer)
where LC::EventProcessor: EventProcessor<ItemTrain = TO>, LC::Model: TrainStep<TI, TO>, TO: Send + 'static, TI: Send + 'static,

Runs the training epoch on multiple devices.

§Arguments

model - The model to train.
optim - The optimizer to use.
lr_scheduler - The learning rate scheduler to use.
processor - The event processor to use.
devices - The devices to use.

§Returns

The trained model and the optimizer.

Auto Trait Implementations§

§

impl<TI> !UnwindSafe for TrainEpoch<TI>

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 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 §