Skip to main content

Trainer

Struct Trainer 

Source
pub struct Trainer { /* private fields */ }
Expand description

Training utilities with scheduler, metrics, and validation

Implementations§

Source§

impl Trainer

Source

pub fn new(model: TrainableSSM, config: TrainingConfig) -> CoreResult<Self>

Create a new trainer

Source

pub fn train_epoch<F>( &mut self, data_loader: &[(Tensor, Tensor)], loss_fn: F, ) -> CoreResult<f32>
where F: Fn(&Tensor, &Tensor) -> CoreResult<Tensor>,

Train for one epoch

Source

pub fn evaluate<F>( &self, data_loader: &[(Tensor, Tensor)], loss_fn: F, ) -> CoreResult<f32>
where F: Fn(&Tensor, &Tensor) -> CoreResult<Tensor>,

Evaluate on validation data

Source

pub fn fit<F>( &mut self, train_loader: TimeSeriesDataLoader, val_loader: Option<TimeSeriesDataLoader>, loss_fn: F, ) -> CoreResult<()>
where F: Fn(&Tensor, &Tensor) -> CoreResult<Tensor> + Copy,

Full training loop with validation and early stopping

Source

pub fn model(&self) -> &TrainableSSM

Get reference to the model

Source

pub fn model_mut(&mut self) -> &mut TrainableSSM

Get mutable reference to the model

Source

pub fn metrics(&self) -> &TrainingMetrics

Get reference to training metrics

Source

pub fn metrics_mut(&mut self) -> &mut TrainingMetrics

Get mutable reference to training metrics

Source

pub fn current_step(&self) -> usize

Get current training step

Source

pub fn save_checkpoint<P: AsRef<Path>>( &self, path: P, name: &str, ) -> CoreResult<()>

Save checkpoint to disk

Saves model weights, optimizer state, training configuration, metrics, and metadata.

§Arguments
  • path - Directory to save checkpoint files
  • name - Checkpoint name (without extension)
§Example
trainer.save_checkpoint("checkpoints", "epoch_10")?;
// Creates: checkpoints/epoch_10.safetensors and checkpoints/epoch_10.json
Source

pub fn load_checkpoint<P: AsRef<Path>>( path: P, name: &str, model_config: KizzasiConfig, ) -> CoreResult<Self>

Load checkpoint and resume training

Creates a new Trainer from a saved checkpoint, restoring model weights, configuration, and training state.

§Arguments
  • path - Directory containing checkpoint files
  • name - Checkpoint name (without extension)
  • model_config - Model configuration (must match saved model)
§Example
let trainer = Trainer::load_checkpoint("checkpoints", "epoch_10", model_config)?;
// Continue training from epoch 10
Source

pub fn save_checkpoint_auto<P: AsRef<Path>>(&self, path: P) -> CoreResult<()>

Save checkpoint with automatic naming (epoch-based)

Convenience method that automatically names checkpoints based on current epoch.

§Example
trainer.save_checkpoint_auto("checkpoints")?;
// Creates: checkpoints/checkpoint_epoch_5.safetensors, etc.
Source

pub fn save_best_checkpoint<P: AsRef<Path>>(&self, path: P) -> CoreResult<()>

Save checkpoint if this is the best epoch (lowest validation loss)

Automatically saves a “best” checkpoint when validation loss improves.

§Example
// After each validation epoch
trainer.save_best_checkpoint("checkpoints")?;

Auto Trait Implementations§

Blanket Implementations§

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,