Add auto_insert_metric_name to ModelCheckpoint docstring. #8310
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added auto_insert_metric_name in modelcheckpoint docstring
jiwidi
requested review from
Borda,
carmocca,
kaushikb11,
tchaton and
williamFalcon
as code owners
Codecov Report
@@ Coverage Diff @@
## master #8310 +/- ##
=======================================
- Coverage 93% 88% -5%
=======================================
Files 213 213
Lines 13798 13798
=======================================
- Hits 12799 12121 -678
- Misses 999 1677 +678 |
Co-authored-by: Carlos Mochol铆 <carlossmocholi@gmail.com>
Co-authored-by: Carlos Mochol铆 <carlossmocholi@gmail.com>
Co-authored-by: Carlos Mochol铆 <carlossmocholi@gmail.com>
Co-authored-by: Carlos Mochol铆 <carlossmocholi@gmail.com>
carmocca
approved these changes
Jul 6, 2021
Borda
approved these changes
Jul 6, 2021
awaelchli
approved these changes
Jul 7, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Hi!
Boring PR fixind docs, adds a missing parameter in the ModelCheckpoint docstring:
auto_insert_metric_name. This metric was added on #6277 but the docstring was missed. I found myself in need of this parameter and didn't see anything in the docstring so I went ask in Slack and @carmocca pointed me that this parameter existed, just that it wasn't on the docs! conversationThe parameter is used in code examples but lacks of any explanation https://pytorch-lightning.readthedocs.io/en/latest/extensions/generated/pytorch_lightning.callbacks.ModelCheckpoint.html#pytorch_lightning.callbacks.ModelCheckpoint. This will make it easier to understand
Did you have fun?
Always 馃檭