Timer#

class braintools.trainer.Timer(duration=None, verbose=True)#

Track training time.

Parameters:
  • duration (Dict[str, float] | None) – Maximum training duration. Keys can be ‘seconds’, ‘minutes’, ‘hours’, ‘days’.

  • verbose (bool) – Whether to print timing information.

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()
>>> timer = braintools.trainer.Timer(duration={'hours': 2}, verbose=False)
>>> trainer = braintools.trainer.Trainer(
...     max_epochs=2, callbacks=[timer],
...     logger=False, enable_progress_bar=False, enable_checkpointing=False)
>>> trainer.fit(model, loader)
>>> timer.should_stop  # far below the two-hour budget
False
>>> 0.0 < timer.time_remaining < 2 * 3600
True
on_fit_end(trainer, module)[source]#

Record end time and print summary.

on_fit_start(trainer, module)[source]#

Record start time.

on_train_epoch_end(trainer, module)[source]#

Record epoch time and check duration limit.

on_train_epoch_start(trainer, module)[source]#

Record epoch start time.

property should_stop: bool#

Whether training should stop due to time limit.

property time_elapsed: float | None#

Time elapsed since training started (seconds).

property time_remaining: float | None#

Estimated time remaining (seconds).