Skip to content
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

Jump to bottom

Update orbax_upgrade_guide.rst for async checkpointing usage examples #4036

Merged
merged 5 commits into from
Jul 9, 2024
Merged

Update orbax_upgrade_guide.rst for async checkpointing usage examples #4036

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4b4d2fe
Update orbax_upgrade_guide.rst for async checkpointing usage examples
kaushaladiti-2802 Jun 26, 2024
8e307f1
Update orbax_upgrade_guide.rst
kaushaladiti-2802 Jul 8, 2024
5406692
Update orbax_upgrade_guide.rst
kaushaladiti-2802 Jul 8, 2024
7298cc5
Update orbax_upgrade_guide.rst
kaushaladiti-2802 Jul 9, 2024
4910005
Update orbax_upgrade_guide.rst
kaushaladiti-2802 Jul 9, 2024
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
Next Next commit
Update orbax_upgrade_guide.rst for async checkpointing usage examples
  • Loading branch information
@kaushaladiti-2802
kaushaladiti-2802 committed Jul 3, 2024
commit 4b4d2fee076497137e1983e8d78a85a8d629f824
29 changes: 28 additions & 1 deletion docs/guides/converting_and_upgrading/orbax_upgrade_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,33 @@ Then, you can call ``orbax.checkpoint.AsyncCheckpointer.wait_until_finished()``

For more details, read the `checkpoint guide <https://flax.readthedocs.io/en/latest/guides/training_techniques/use_checkpointing.html#asynchronized-checkpointing>`_.

You can also use Orbax AsyncCheckpointer with Flax APIs through async manager. Async manager internally calls wait_until_finished(). This solution is not actively maintained and the recommedation is to use Orbax async checkpointing.

For example:

.. codediff::
:title: flax.checkpoints(async), orbax.checkpoint(async)
:skip_test: flax.checkpoints
:sync:

PURE_CKPT_DIR = '/tmp/orbax_upgrade/pure'
kaushaladiti-2802 marked this conversation as resolved.
Show resolved Hide resolved
flax.config.update('flax_use_orbax_checkpointing', True)
async_manager = checkpoints.AsyncManager()

checkpoints.save_checkpoint(PURE_CKPT_DIR, CKPT_PYTREE, step=0, overwrite=True, async_manager=async_manager)
checkpoints.restore_checkpoint(PURE_CKPT_DIR, target=TARGET_PYTREE)
---

PURE_CKPT_DIR = '/tmp/orbax_upgrade/pure'

import orbax.checkpoint as ocp
ckptr = ocp.AsyncCheckpointer(ocp.StandardCheckpointHandler())
ckptr.save(PURE_CKPT_DIR, args=ocp.args.StandardSave(pytree))
# ... Continue with your work...
# ... Until a time when you want to wait until the save completes:
ckptr.wait_until_finished() # Blocks until the checkpoint saving is completed.
ckptr.restore(PURE_CKPT_DIR, args=ocp.args.StandardRestore(target))


Saving/loading a single JAX or NumPy Array
******************************************
Expand Down Expand Up @@ -210,4 +237,4 @@ For example:
Final words
***********

This guide provides an overview of how to migrate from the "legacy" Flax checkpointing API to the Orbax API. Orbax provides more functionalities and the Orbax team is actively developing new features. Stay tuned and follow the `official Orbax GitHub repository <https://github.com/google/orbax>`__ for more!
This guide provides an overview of how to migrate from the "legacy" Flax checkpointing API to the Orbax API. Orbax provides more functionalities and the Orbax team is actively developing new features. Stay tuned and follow the `official Orbax GitHub repository <https://github.com/google/orbax>`__ for more!
Loading