Checkpointing Options

Checkpointing Options#

Configuration options for APIs like CheckpointManager and Checkpointer.

AsyncOptions#

class orbax.checkpoint.options.AsyncOptions(timeout_secs=1200, barrier_sync_fn=None, post_finalization_callback=None, create_directories_asynchronously=True)[source][source]#

Options used to configure async behavior.

See AsyncCheckpointer for details.

__eq__(other)#

Return self==value.

__hash__ = None#
__init__(timeout_secs=1200, barrier_sync_fn=None, post_finalization_callback=None, create_directories_asynchronously=True)#

MultiprocessingOptions#

class orbax.checkpoint.options.MultiprocessingOptions(primary_host=0, active_processes=None, barrier_sync_key_prefix=None)[source][source]#

Options used to configure multiprocessing behavior.

primary_host: the host id of the primary host. Default to 0. If it’s set

to None, then all hosts will be considered as primary. It’s useful in the case that all hosts are only working with local storage.

active_processes: A set of process indices (corresponding to

multihost.process_index()) over which CheckpointManager is expected to be called. This makes it possible to have a CheckpointManager instance that runs over a subset of processes, rather than all processes as it is normally expected to do. If specified, primary_host must belong to active_processes.

barrier_sync_key_prefix: A string to be prepended to the barrier sync key

used to synchronize processes. This is useful to avoid collisions with other barrier syncs if another CheckpointManager is being used concurrently.

__eq__(other)#

Return self==value.

__hash__ = None#
__init__(primary_host=0, active_processes=None, barrier_sync_key_prefix=None)#

FileOptions#

class orbax.checkpoint.options.FileOptions(path_permission_mode=None)[source][source]#

Options used to configure checkpoint directories and files.

path_permission_mode#

Path permission mode for step directories, user metadata files. e.g. 0o750. Please check google/etils if your

Type:

int | None

__delattr__(name)#

Implement delattr(self, name).

__eq__(other)#

Return self==value.

__hash__()#

Return hash(self).

__init__(path_permission_mode=None)#
__setattr__(name, value)#

Implement setattr(self, name, value).

Contents