ModelCheckpoint#
- class braintools.trainer.ModelCheckpoint(dirpath=None, filename=None, monitor='val_loss', mode='min', save_top_k=3, save_last=True, every_n_epochs=1, every_n_train_steps=None, save_on_train_epoch_end=True, verbose=False)#
Save model checkpoints based on monitored metric.
- Parameters:
dirpath (
str|None) – Directory to save checkpoints. Default: current directory.filename (
str|None) – Checkpoint filename template. Can include {epoch}, {step}, and metric names. Default: ‘checkpoint-{epoch:02d}-{val_loss:.4f}’monitor (
str) – Metric to monitor for best model selection.mode (
str) – One of ‘min’ or ‘max’. In ‘min’ mode, the lowest metric value is best.save_top_k (
int) – Number of best models to keep. -1 means keep all.save_last (
bool) – Whether to save the last checkpoint regardless of metric.every_n_epochs (
int) – Save checkpoint every n epochs.every_n_train_steps (
int|None) – Save checkpoint every n training steps.save_on_train_epoch_end (
bool) – Whether to run checkpointing at end of training epoch.verbose (
bool) – Whether to print checkpoint saving messages.
Examples
Keep the two epochs with the lowest validation loss, plus
last.ckpt:>>> import os, shutil, tempfile >>> import numpy as np >>> import jax.numpy as jnp >>> import brainstate >>> import braintools >>> class Regressor(braintools.trainer.LightningModule): ... def __init__(self): ... super().__init__() ... self.linear = brainstate.nn.Linear(2, 1) ... def training_step(self, batch, batch_idx): ... x, y = batch ... loss = jnp.mean((self.linear(x) - y) ** 2) ... self.log('loss', loss, prog_bar=True) ... return {'loss': loss} ... def validation_step(self, batch, batch_idx): ... x, y = batch ... return {'loss': jnp.mean((self.linear(x) - y) ** 2)} ... def configure_optimizers(self): ... return braintools.optim.Adam(lr=0.1) >>> rng = np.random.default_rng(0) >>> X = rng.normal(size=(64, 2)).astype(np.float32) >>> y = X @ np.array([[1.0], [-2.0]], dtype=np.float32) + 0.5 >>> loader = braintools.trainer.DataLoader((X, y), batch_size=32) >>> brainstate.random.seed(0) >>> model = Regressor() >>> tmp = tempfile.mkdtemp() >>> checkpoint = braintools.trainer.ModelCheckpoint( ... dirpath=tmp, ... filename='model-{epoch:02d}', ... monitor='val_loss', ... mode='min', ... save_top_k=2, ... ) >>> trainer = braintools.trainer.Trainer( ... max_epochs=4, callbacks=[checkpoint], ... logger=False, enable_progress_bar=False, enable_checkpointing=False) >>> trainer.fit(model, loader, loader) >>> sorted(os.listdir(tmp)) ['last.ckpt', 'model-02.ckpt', 'model-03.ckpt'] >>> os.path.basename(checkpoint.best_model_path) 'model-03.ckpt' >>> shutil.rmtree(tmp)
- on_train_batch_end(trainer, module, outputs, batch, batch_idx)[source]#
Check if we should save a checkpoint at step.
- on_train_epoch_end(trainer, module)[source]#
Check if we should save a checkpoint at train-epoch end.
When validation runs this epoch we defer to
on_validation_epoch_endso the monitored validation metric is available. When there is no validation we save here (subject tosave_on_train_epoch_end).
- on_validation_epoch_end(trainer, module)[source]#
Checkpoint at validation end, where the monitored metric exists.
This is the correct point to evaluate a validation metric such as
monitor='val_loss'— running validation populates it just before this hook fires (unlikeon_train_epoch_end, which runs first).