PrintCallback#

class braintools.trainer.PrintCallback(print_freq=100)#

Simple callback that prints training progress.

Parameters:

print_freq (int) – Print every n batches.

Examples

Metrics logged with prog_bar=True are printed every print_freq batches:

>>> 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()
>>> callback = braintools.trainer.PrintCallback(print_freq=1)
>>> trainer = braintools.trainer.Trainer(
...     max_epochs=1, callbacks=[callback],
...     logger=False, enable_progress_bar=False, enable_checkpointing=False)
>>> trainer.fit(model, loader)

--- Epoch 0 ---
  Step 0: loss: ...
  Step 1: loss: ...
Epoch 0 completed.
on_train_batch_end(trainer, module, outputs, batch, batch_idx)[source]#

Called at the end of each training batch.

on_train_epoch_end(trainer, module)[source]#

Called at the end of each training epoch.

on_train_epoch_start(trainer, module)[source]#

Called at the beginning of each training epoch.

on_validation_epoch_end(trainer, module)[source]#

Called at the end of each validation epoch.