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

Introduce checkpoint migration #15237

Merged
merged 49 commits into from
Nov 2, 2022
Merged

Introduce checkpoint migration #15237

merged 49 commits into from
Nov 2, 2022

Conversation

awaelchli
Copy link
Contributor

@awaelchli awaelchli commented Oct 21, 2022

What does this PR do?

Part of #9396
Continues #8558

  • When Lightning loads checkpoints, the migration gets applied automatically. Instructions are printed how to upgrade the checkpoint files permanently.
  • This PR does not add any new migrations. These will be added in follow up PRs.
  • The only migration function we have at the moment is the one that was in upgrade_checkpoint.py (refactored)
  • A warning is raised when attempting to load a checkpoint that is newer than the current Lightning version. This is optional, but I added this to signal "migration" here means we only support going forward in time, not back. Please do not ask me to add support for going back in time.

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 @ananthsub @ninginthecloud @rohitgr7 @otaj

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Oct 21, 2022
@awaelchli awaelchli added feature Is an improvement or enhancement checkpointing Related to checkpointing labels Oct 21, 2022
@awaelchli awaelchli added this to the v1.9 milestone Oct 21, 2022
@awaelchli awaelchli self-assigned this Oct 21, 2022
@awaelchli awaelchli force-pushed the feature/migration-utils branch from 5bf9e9e to 277b0b8 Compare October 21, 2022 11:47
@awaelchli awaelchli mentioned this pull request Oct 28, 2022
11 tasks
@mergify mergify bot added the has conflicts label Nov 1, 2022
@mergify mergify bot removed the has conflicts label Nov 1, 2022
src/pytorch_lightning/core/saving.py Show resolved Hide resolved
src/pytorch_lightning/utilities/migration/migrations.py Outdated Show resolved Hide resolved
src/pytorch_lightning/utilities/migration/utils.py Outdated Show resolved Hide resolved
src/pytorch_lightning/utilities/migration/utils.py Outdated Show resolved Hide resolved
@mergify mergify bot added the ready PRs ready to be merged label Nov 2, 2022
@awaelchli awaelchli enabled auto-merge (squash) November 2, 2022 14:25
@awaelchli awaelchli merged commit 94f7d23 into master Nov 2, 2022
@awaelchli awaelchli deleted the feature/migration-utils branch November 2, 2022 15:14
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.

4 participants