State.checkpoint.open_store#
- State.checkpoint.open_store(pipeline_file_name: Path | None = None, overwrite=False, mode='a')#
Open the checkpoint store.
The format for the checkpoint store is determined by the checkpoint_format setting in the top-level Settings.
- Parameters:
- pipeline_file_namePath-like, optional
An explicit pipeline file path. If not given, the default pipeline file path is opened.
- overwritebool, default False
delete file before opening (unless resuming)
- mode{‘a’, ‘w’, ‘r’, ‘r+’}, default ‘a’
'r'
Read-only; no data can be modified.
'w'
Write; a new file is created (an existing file with the same name would be deleted).
'a'
Append; an existing file is opened for reading and writing, and if the file does not exist it is created.
'r+'
It is similar to
'a'
, but the file must already exist.