braintools.trainer.find_checkpoint

braintools.trainer.find_checkpoint#

braintools.trainer.find_checkpoint(dirpath, pattern='*.ckpt', best=False, last=False)[source]#

Find a checkpoint file in a directory.

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

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

  • best (bool) – Return the best checkpoint (by name, looking for ‘best’ in filename).

  • last (bool) – Return the last/most recent checkpoint.

Returns:

Path to the found checkpoint, or None if not found.

Return type:

str | None

Examples

>>> import os, shutil, tempfile
>>> import braintools
>>> tmp = tempfile.mkdtemp()
>>> for name in ['epoch=1.ckpt', 'best.ckpt', 'last.ckpt']:
...     _ = braintools.trainer.save_checkpoint({'x': 0}, os.path.join(tmp, name))
>>> os.path.basename(braintools.trainer.find_checkpoint(tmp, best=True))
'best.ckpt'
>>> os.path.basename(braintools.trainer.find_checkpoint(tmp, last=True))
'last.ckpt'
>>> braintools.trainer.find_checkpoint(os.path.join(tmp, 'missing')) is None
True
>>> shutil.rmtree(tmp)