braintools.trainer.list_checkpoints

braintools.trainer.list_checkpoints#

braintools.trainer.list_checkpoints(dirpath, pattern='*.ckpt', sort_by='time')[source]#

List all checkpoints in a directory.

Parameters:
  • dirpath (str) – Directory to search in.

  • pattern (str) – Glob pattern for checkpoint files.

  • sort_by (str) – How to sort checkpoints (‘time’, ‘name’, ‘epoch’).

Returns:

List of checkpoint file paths.

Return type:

List[str]

Examples

>>> import os, shutil, tempfile
>>> import braintools
>>> tmp = tempfile.mkdtemp()
>>> for epoch in [10, 2, 1]:
...     _ = braintools.trainer.save_checkpoint(
...         {'epoch': epoch}, os.path.join(tmp, f'epoch={epoch}.ckpt'))
>>> ckpts = braintools.trainer.list_checkpoints(tmp, sort_by='epoch')
>>> [os.path.basename(c) for c in ckpts]
['epoch=1.ckpt', 'epoch=2.ckpt', 'epoch=10.ckpt']
>>> shutil.rmtree(tmp)