State.checkpoint.restore#

State.checkpoint.restore(resume_after=None, mode='a')#

Restore state from checkpoints.

This can be used with “resume_after” to get the correct checkpoint, or for a new run.

If resume_after, then we expect the pipeline hdf5 file to exist and contain checkpoints from a previous run, including a checkpoint with name specified in resume_after

Parameters:
resume_afterstr or None

name of checkpoint to load from pipeline store

mode{‘a’, ‘w’, ‘r’, ‘r+’}, default ‘a’

same as for typical opening of H5Store. Ignored unless resume_after is not None. This is here to allow read-only pipeline for benchmarking.