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

Fix save_last type annotation for ModelCheckpoint #19808

Conversation

mariovas3
Copy link
Contributor

@mariovas3 mariovas3 commented Apr 24, 2024

What does this PR do?

Fixes #19799

Before submitting
  • Was this discussed/agreed 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)
    • yes
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
    • no breaking changes in this PR
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

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

Reviewer checklist
  • 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

📚 Documentation preview 📚: https://pytorch-lightning--19808.org.readthedocs.build/en/19808/

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Apr 24, 2024
@mariovas3 mariovas3 force-pushed the bugfix/#19799_model-checkpoint-save_last-cli branch from a70f49b to 4feb7ff Compare April 24, 2024 12:43
@mariovas3 mariovas3 force-pushed the bugfix/#19799_model-checkpoint-save_last-cli branch from 4feb7ff to ad806f4 Compare April 30, 2024 16:56
@mariovas3 mariovas3 marked this pull request as ready for review April 30, 2024 19:13
@mariovas3 mariovas3 force-pushed the bugfix/#19799_model-checkpoint-save_last-cli branch 2 times, most recently from 9fc2954 to 2f8b53c Compare May 9, 2024 08:23
… jsonargparse can correctly parse inputs such as true, false, etc...

before this change jsonargparse gave errors complaining that strings like 'true' or 'false' were given when the annotation expected Optional[Literal[True, False, 'link']]; this is in contrast to most other bool parameters in the ModelCheckpoint callback's constructor. I also added a test in tests/test_pytorch/checkpointing/test_model_checkpoint.py::test_save_last_cli
@mariovas3 mariovas3 force-pushed the bugfix/#19799_model-checkpoint-save_last-cli branch from 2f8b53c to aca427f Compare May 20, 2024 14:40
@mariovas3
Copy link
Contributor Author

The PR is pretty compact - few modifications in 2 files.

The PR has been ready to review for the last 3 weeks. It passes all available tests.

Please someone review it, so I can close the issue and the PR.

@awaelchli awaelchli changed the title Bugfix/#19799 be able to parse save_last of ModelCheckpoint from cli Fix save_last type annotation for ModelCheckpoint Jun 5, 2024
@awaelchli awaelchli added callback: model checkpoint community This PR is from the community bug Something isn't working labels Jun 5, 2024
@awaelchli awaelchli added this to the 2.3 milestone Jun 5, 2024
Copy link
Member

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

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

@mariovas3 That's a great fix, thanks for sending the PR and including a test as well!

Copy link

codecov bot commented Jun 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53%. Comparing base (1a6786d) to head (f165de2).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #19808      +/-   ##
==========================================
- Coverage      84%      53%     -31%     
==========================================
  Files         426      418       -8     
  Lines       35264    35111     -153     
==========================================
- Hits        29553    18703   -10850     
- Misses       5711    16408   +10697     

@awaelchli awaelchli merged commit 812ffde into Lightning-AI:master Jun 6, 2024
97 of 98 checks passed
@mariovas3 mariovas3 deleted the bugfix/#19799_model-checkpoint-save_last-cli branch June 6, 2024 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working callback: model checkpoint community This PR is from the community pl Generic label for PyTorch Lightning package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

parsing issue with save_last parameter of ModelCheckpoint
2 participants