Struct TrainingComponents

Source

pub struct TrainingComponents<M: LearnerModel> {
    pub label: Option<String>,
    pub num_epochs: usize,
    pub checkpoint: Option<usize>,
    pub checkpointer: Option<LearningCheckpointer<M>>,
    pub grad_accumulation: Option<usize>,
    pub interrupter: Interrupter,
    pub early_stopping: Option<Box<dyn CloneEarlyStoppingStrategy>>,
    pub event_processor: SupervisedTrainingEventProcessor<M>,
    pub event_store: Arc<EventStoreClient>,
    pub summary: Option<LearnerSummaryConfig>,
}

Expand description

Struct to minimise parameters passed to SupervisedLearningStrategy::train. These components are used during training.

Fields§

§label: Option<String>

An optional label for this training.

§num_epochs: usize

The total number of epochs

§checkpoint: Option<usize>

The epoch number from which to continue the training.

§checkpointer: Option<LearningCheckpointer<M>>

A checkpointer used to load and save learner checkpoints.

§grad_accumulation: Option<usize>

Enables gradients accumulation.

§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: SupervisedTrainingEventProcessor<M>

An EventProcessor that processes events happening during training and validation.

§event_store: Arc<EventStoreClient>

A reference to an EventStoreClient.

§summary: Option<LearnerSummaryConfig>

Config for creating a summary of the learning

Auto Trait Implementations§

§

impl<M> Freeze for TrainingComponents<M>
where Option<LearningCheckpointer<M>>: Freeze, AsyncProcessorTraining<LearnerEvent<<M as TrainStep>::Output>, LearnerEvent<<M as InferenceStep>::Output>>: Freeze,

§

impl<M> Send for TrainingComponents<M>
where Option<LearningCheckpointer<M>>: Send, AsyncProcessorTraining<LearnerEvent<<M as TrainStep>::Output>, LearnerEvent<<M as InferenceStep>::Output>>: Send,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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 §