Struct LearnerBuilder

pub struct LearnerBuilder<B, T, V, M, O, S>
where
    T: ItemLazy + 'static,
    V: ItemLazy + 'static,
    B: AutodiffBackend,
    M: AutodiffModule<B>,
    O: Optimizer<M, B>,
    S: LrScheduler,
{ /* private fields */ }

Struct to configure and create a learner.

Implementations

impl<B, T, V, M, O, S> LearnerBuilder<B, T, V, M, O, S>

where B: AutodiffBackend, T: ItemLazy + 'static, V: ItemLazy + 'static, M: AutodiffModule<B> + Display + 'static, O: Optimizer<M, B>, S: LrScheduler,

pub fn new(directory: impl AsRef<Path>) -> Self

Creates a new learner builder.

Arguments

• directory - The directory to save the checkpoints.

pub fn metric_loggers<MT, MV>(self, logger_train: MT, logger_valid: MV) -> Self

where MT: MetricLogger + 'static, MV: MetricLogger + 'static,

Replace the default metric loggers with the provided ones.

Arguments

• logger_train - The training logger.
• logger_valid - The validation logger.

pub fn with_checkpointing_strategy<CS>(self, strategy: CS) -> Self

where CS: CheckpointingStrategy + 'static,

Update the checkpointing_strategy.

pub fn renderer<MR>(self, renderer: MR) -> Self

where MR: MetricsRenderer + 'static,

Replace the default CLI renderer with a custom one.

Arguments

• renderer - The custom renderer.

pub fn metric_train<Me: Metric + 'static>(self, metric: Me) -> Self

where T::ItemSync: Adaptor<Me::Input>,

Register a training metric.

pub fn metric_valid<Me: Metric + 'static>(self, metric: Me) -> Self

where V::ItemSync: Adaptor<Me::Input>,

Register a validation metric.

pub fn grads_accumulation(self, accumulation: usize) -> Self

Enable gradients accumulation.

Notes

When you enable gradients accumulation, the gradients object used by the optimizer will be the sum of all gradients generated by each backward pass. It might be a good idea to reduce the learning to compensate.

The effect is similar to increasing the batch size and the learning rate by the accumulation amount.

pub fn metric_train_numeric<Me>(self, metric: Me) -> Self

where Me: Metric + Numeric + 'static, T::ItemSync: Adaptor<Me::Input>,

Register a numeric training metric.

pub fn metric_valid_numeric<Me: Metric + Numeric + 'static>( self, metric: Me, ) -> Self

where V::ItemSync: Adaptor<Me::Input>,

Register a numeric validation metric.

pub fn num_epochs(self, num_epochs: usize) -> Self

The number of epochs the training should last.

pub fn devices(self, devices: Vec<B::Device>) -> Self

Run the training loop on multiple devices.

pub fn checkpoint(self, checkpoint: usize) -> Self

The epoch from which the training must resume.

pub fn interrupter(&self) -> TrainingInterrupter

Provides a handle that can be used to interrupt training.

pub fn early_stopping<Strategy>(self, strategy: Strategy) -> Self

where Strategy: EarlyStoppingStrategy + 'static,

Register an early stopping strategy to stop the training when the conditions are meet.

pub fn with_application_logger( self, logger: Option<Box<dyn ApplicationLoggerInstaller>>, ) -> Self

By default, Rust logs are captured and written into experiment.log. If disabled, standard Rust log handling will apply.

pub fn with_file_checkpointer<FR>(self, recorder: FR) -> Self

where FR: FileRecorder<B> + 'static + FileRecorder<B::InnerBackend>, O::Record: 'static, M::Record: 'static, S::Record<B>: 'static,

Register a checkpointer that will save the optimizer, the model and the scheduler to different files.

pub fn summary(self) -> Self

Enable the training summary report.

The summary will be displayed at the end of .fit().

pub fn build( self, model: M, optim: O, lr_scheduler: S, ) -> Learner<LearnerComponentsMarker<B, S, M, O, AsyncCheckpointer<M::Record, B>, AsyncCheckpointer<O::Record, B>, AsyncCheckpointer<S::Record<B>, B>, AsyncProcessor<FullEventProcessor<T, V>>, Box<dyn CheckpointingStrategy>>>

where M::Record: 'static, O::Record: 'static, S::Record<B>: 'static,

Create the learner from a model and an optimizer. The learning rate scheduler can also be a simple learning rate.