LearningRateMonitor#

class braintools.trainer.LearningRateMonitor(logging_interval='step', log_momentum=False)#

Monitor and log learning rate during training.

Parameters:
  • logging_interval (str) – When to log the learning rate. One of ‘step’ or ‘epoch’.

  • log_momentum (bool) – Reserved for logging optimizer momentum values. Not yet implemented; the value is accepted but currently has no effect.

Examples

>>> 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()
>>> lr_monitor = braintools.trainer.LearningRateMonitor(logging_interval='epoch')
>>> trainer = braintools.trainer.Trainer(
...     max_epochs=2, callbacks=[lr_monitor],
...     logger=False, enable_progress_bar=False, enable_checkpointing=False)
>>> trainer.fit(model, loader)
>>> [round(h['lr-opt0'], 6) for h in lr_monitor.lr_history]
[0.1, 0.1]
property lr_history: List[Dict[str, float]]#

History of logged learning rates.

on_train_batch_start(trainer, module, batch, batch_idx)[source]#

Log learning rate at step start.

on_train_epoch_start(trainer, module)[source]#

Log learning rate at epoch start.