Skip to content

Add a documentation page on checkpointing #2530

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.

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
merged 4 commits into from
Oct 27, 2022
Merged

Conversation

IvyZX
Copy link
Collaborator

@IvyZX IvyZX commented Oct 13, 2022

This page is meant to address the following:

  • Explain how to save and load a checkpoint
  • What to do if you don't know the original object, what to do if it can be one of multiple objects (e.g., a TrainState with or without batch_stats)
  • How to use it in multiprocess

Live preview: https://flax--2530.org.readthedocs.build/en/2530/guides/use_checkpointing.html

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@IvyZX IvyZX requested a review from cgarciae October 13, 2022 01:05
@codecov-commenter
Copy link

codecov-commenter commented Oct 13, 2022

Codecov Report

Merging #2530 (041f5e0) into main (a479e13) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2530   +/-   ##
=======================================
  Coverage   79.41%   79.41%           
=======================================
  Files          49       49           
  Lines        5188     5188           
=======================================
  Hits         4120     4120           
  Misses       1068     1068           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@IvyZX IvyZX requested a review from levskaya October 13, 2022 21:52
@cgarciae
Copy link
Collaborator

cgarciae commented Oct 14, 2022

Hey @IvyZX, to enable jupytext for this notebook run:

jupytext --set-formats ipynb,md:myst docs/guides/use_checkpointing.ipynb

More info here:

https://flax.readthedocs.io/en/latest/advanced_topics/contributing.html#creating-new-notebooks

@IvyZX IvyZX force-pushed the pen branch 2 times, most recently from adb700f to 17df392 Compare October 14, 2022 20:35
@IvyZX IvyZX removed the request for review from levskaya October 17, 2022 20:40
@8bitmp3
Copy link
Collaborator

8bitmp3 commented Oct 27, 2022

Update in IvyZX#3

Update Flax Checkpointing guide
@copybara-service copybara-service bot merged commit 81268fc into google:main Oct 27, 2022
@IvyZX IvyZX deleted the pen branch November 7, 2022 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants