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.

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

Support saving and loading of step while saving and loading state #2765

Merged
merged 2 commits into from
Jul 1, 2024

Conversation

bipinKrishnan
Copy link
Contributor

What does this PR do?

This PR adds support to checkpoint the step(internal step tracker) value while calling Accelerator.save_state and also makes appropriate changes to Accelerator.load_state to support the loading of the saved step.

Fixes #2702

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

@muellerzr

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Copy link
Collaborator

@muellerzr muellerzr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay! Nice work, this looks great to me.

Let's modify the docstring for load_accelerator_state and mention that it may return, and can you rebase from main? This should make the failing tests pass

@bipinKrishnan
Copy link
Contributor Author

Hi @muellerzr, thanks for the feedback! Just pushed the updates, let me know if this is good to go :)

Copy link
Collaborator

@muellerzr muellerzr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice, thanks!

@muellerzr muellerzr merged commit 5a0b7dc into huggingface:main Jul 1, 2024
23 checks passed
@@ -240,6 +249,7 @@ def load_accelerator_state(
# Random states
try:
states = torch.load(input_dir.joinpath(f"{RNG_STATE_NAME}_{process_index}.pkl"))
override_attributes["step"] = states["step"]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a breaking change for people upgrading accelerate. If previously saved pickled states objects don't contain a "step" key, then random states fail to initialize correctly when you resume a training that was checkpointed from a prior version of accelerate.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, we've fixed this in a patch release

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see this now. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Is it possible to get save_state to save step as well?
4 participants