Skip to content

Use cross-references for register_handler and CheckpointablesOptions in CheckpointableHandler documentation. #3421

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

Open
copybara-service wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Use cross-references for register_handler and CheckpointablesOptions in CheckpointableHandler documentation. #3421

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
15 changes: 7 additions & 8 deletions checkpoint/orbax/checkpoint/experimental/v1/_src/handlers/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,14 +138,13 @@ class CheckpointableHandler(Protocol[_Checkpointable, _AbstractCheckpointable]):
Crucially, once implemented, the handler must be registered with the
global registry or a context-local registry so that `save_checkpointables`
and `load_checkpointables` can automatically detect and use it for the
corresponding types. Use `orbax.checkpoint.v1.handlers.register_handler`
for global registration, or provide handlers via
`orbax.checkpoint.v1.context.CheckpointablesOptions` for context-local
registration.

First, take a look at
orbax/checkpoint/experimental/v1/_src/testing/handler_utils.py
for some toy implementations used for unit testing.
corresponding types. Use :py:func:`.register_handler` for global
registration, or provide handlers via :py:class:`.CheckpointablesOptions`
for context-local registration.

First, take a look at `handler_utils.py <
https://github.com/google/orbax/blob/main/checkpoint/orbax/checkpoint/experimental/v1/_src/testing/handler_utils.py
>`_ for some toy implementations used for unit testing.

Here are some details on how to implement `is_handleable` and
`is_abstract_handleable`.
Expand Down
Loading