-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Example and documentation for LightningCLI linking model and data arguments #7299
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
Merged
Conversation
This file contains hidden or 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 documentation for linking of arguments in LightningCLI.
Codecov Report
@@ Coverage Diff @@
## master #7299 +/- ##
=======================================
- Coverage 91% 87% -4%
=======================================
Files 200 200
Lines 12875 12873 -2
=======================================
- Hits 11765 11240 -525
- Misses 1110 1633 +523 |
carmocca
approved these changes
May 3, 2021
awaelchli
approved these changes
May 3, 2021
Co-authored-by: Adrian Wälchli <[email protected]>
awaelchli
reviewed
May 3, 2021
Contributor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe also bump the jsonargparse version? It's anyway new for 1.3. I Had to upgrade when running the example.
kaushikb11
approved these changes
May 3, 2021
kaushikb11
pushed a commit
to kaushikb11/pytorch-lightning
that referenced
this pull request
May 4, 2021
…uments (Lightning-AI#7299) Co-authored-by: Adrian Wälchli <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
argparse (removed)
Related to argument parsing (argparse, Hydra, ...)
docs
Documentation related
example
ready
PRs ready to be merged
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?
It can be a common use case that both the model and data module classes require the same input parameter. This pull request updates the computer_vision_fine_tuning.py by using LightningCLI and linking parameters. Also the LightningCLI documentation is updated explaining this.
There is also a change in the
LightningCLImethods. The linking must be done after adding all arguments. But the method to override for adding arguments was run before the add of core arguments. Furthermore it makes sense that in the same method arguments are added and links are configured, see computer_vision_fine_tuning.py#L276-L286. So theadd_arguments_to_parsermethod was moved after the core arguments and thebefore_parse_argumentswas removed since it was redundant.The linking of arguments was briefly discussed in #6862.
Before submitting
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:
Did you have fun?
Always 🙃