Struct TrainingComponents
pub struct TrainingComponents<M>where
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: AsyncProcessorTraining<LearnerEvent<<M as TrainStep>::Output>, LearnerEvent<<M as InferenceStep>::Output>>,
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: usizeThe 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: InterrupterAn Interupter that allows aborting the training/evaluation process early.
early_stopping: Option<Box<dyn CloneEarlyStoppingStrategy>>Cloneable reference to an early stopping strategy.
event_processor: AsyncProcessorTraining<LearnerEvent<<M as TrainStep>::Output>, LearnerEvent<<M as InferenceStep>::Output>>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> !RefUnwindSafe for TrainingComponents<M>
impl<M> !Sync for TrainingComponents<M>
impl<M> !Unpin for TrainingComponents<M>
impl<M> !UnsafeUnpin for TrainingComponents<M>
impl<M> !UnwindSafe for TrainingComponents<M>
impl<M> Freeze for TrainingComponents<M>
impl<M> Send for TrainingComponents<M>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
§impl<K, Q> Comparable<Q> for K
impl<K, Q> Comparable<Q> for K
§impl<K, Q> Equivalent<Q> for K
impl<K, Q> Equivalent<Q> for K
§fn equivalent(&self, key: &Q) -> bool
fn equivalent(&self, key: &Q) -> bool
Compare self to
key and return true if they are equal.impl<T> ErasedDestructor for Twhere
T: 'static,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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