Skip to content

Add Orbax migration guide #2885

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 2 commits into from
Mar 1, 2023
Merged

Conversation

IvyZX
Copy link
Collaborator

@IvyZX IvyZX commented Feb 18, 2023

Adds a documentation page and a colab to provide one-to-one mapping of flax.training.checkpoints save/restore calls to their equivalents in Orbax.

Page and colab content is the same. Only difference is that the page has codediff view.

@IvyZX IvyZX requested review from cgarciae and 8bitmp3 February 18, 2023 00:28
@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 force-pushed the orbax-upgrade-guide branch 2 times, most recently from d6a7746 to 6cba928 Compare February 18, 2023 02:43
@codecov-commenter
Copy link

codecov-commenter commented Feb 18, 2023

Codecov Report

Merging #2885 (382e4e8) into main (10a2123) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2885   +/-   ##
=======================================
  Coverage   81.71%   81.71%           
=======================================
  Files          55       55           
  Lines        5880     5880           
=======================================
  Hits         4805     4805           
  Misses       1075     1075           

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

@8bitmp3
Copy link
Collaborator

8bitmp3 commented Feb 28, 2023

@IvyZX Great work!

Added minor improvements -> see IvyZX#4.

  • Linted, rephrased, reorganized (as discussed)
  • Now with a ToC! (as discussed)
  • Fixed the Colab link
  • The notebook's text mirrors the RST file's text
    • This also ensures the Async checkpointing section is not missed by some users

Previews:

image

image

image

@IvyZX IvyZX force-pushed the orbax-upgrade-guide branch from cea188b to 136aa34 Compare March 1, 2023 03:25
@IvyZX IvyZX force-pushed the orbax-upgrade-guide branch from 136aa34 to 382e4e8 Compare March 1, 2023 03:30
@IvyZX
Copy link
Collaborator Author

IvyZX commented Mar 1, 2023

Thank you @8bitmp3 for the review! All changes LGTM. Feel free to make the approval whenever you are ready.

@copybara-service copybara-service bot merged commit 3568769 into google:main Mar 1, 2023
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.

3 participants