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

Validate that state-key is unique when using multiple callbacks of the same type #15634

Merged
merged 10 commits into from
Nov 11, 2022

Conversation

awaelchli
Copy link
Contributor

@awaelchli awaelchli commented Nov 11, 2022

What does this PR do?

If you give two different callback instances with the same state key to the Trainer, they overwrite each other when saving a checkpoint. Only one of two states will actually be in the checkpoint. Hence, the trainer would fail to resume all states correctly (silently).

This PR validates this at the time of the trainer instantiation.

This change is required to continue with an improved version of #15606 to make checkpoint migration better.

Does your PR introduce any breaking changes? If yes, please list them.

If someone was affected by this but weren't noticing it, when they upgrade Lighting they will get a friendly error now. Apart from that change, there are no intended breaking behaviors.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is free to review the PR once the tests have passed.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

I made sure I had fun coding 🙃

cc @Borda @awaelchli

@awaelchli awaelchli added feature Is an improvement or enhancement checkpointing Related to checkpointing labels Nov 11, 2022
@awaelchli awaelchli added this to the v1.9 milestone Nov 11, 2022
@awaelchli awaelchli self-assigned this Nov 11, 2022
@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Nov 11, 2022
@mergify mergify bot added the ready PRs ready to be merged label Nov 11, 2022
@awaelchli awaelchli merged commit 75b5042 into master Nov 11, 2022
@awaelchli awaelchli deleted the feature/check-state-keys branch November 11, 2022 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
checkpointing Related to checkpointing feature Is an improvement or enhancement pl Generic label for PyTorch Lightning package ready PRs ready to be merged
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants