Skip to content

Add Orbax v1 Context User Guide. #3249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
copybara-service merged 1 commit into from
May 29, 2026
Merged

Add Orbax v1 Context User Guide. #3249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions checkpoint/orbax/checkpoint/experimental/v1/_src/context/options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,13 +135,13 @@ class MultiprocessingOptions(_ActiveContextGuard):
host, only a subset of processes are active, and a custom barrier key is
used to prevent collisions with other concurrent checkpointers::

from orbax.checkpoint.v1.options import
MultiprocessingOptions
from orbax.checkpoint.v1.options import MultiprocessingOptions

options = MultiprocessingOptions(
primary_host=1,
active_processes={1, 2, 3},
barrier_sync_key_prefix="model_a_sync_"
)

Attributes:
primary_host: The host id of the primary host. Default to 0. If it's set
Expand Down Expand Up @@ -500,7 +500,8 @@ class PathwaysOptions(_ActiveContextGuard):
"""Options used to configure Pathways saving and loading.

Attributes:
checkpointing_impl: The implementation to use for Pathways checkpointing.
checkpointing_impl: The implementation mode to use for Pathways
checkpointing.
"""

checkpointing_impl: pathways_types.CheckpointingImpl | None = None
Expand Down
11 changes: 11 additions & 0 deletions docs/api_reference/checkpoint.v1.options.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,14 @@ MemoryOptions
------------------------------------------------------------
.. autoclass:: MemoryOptions
:members:

SafetensorsOptions
------------------------------------------------------------
.. autoclass:: SafetensorsOptions
:members:

CheckpointLayout
------------------------------------------------------------
.. autoclass:: CheckpointLayout
:members:

Loading
Loading