-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Deprecate description and env parameters in LightningCLI.__init__ #15651
Merged
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
mauvilsa
requested review from
awaelchli,
carmocca,
justusschock,
williamFalcon,
edenlightning,
tchaton and
Borda
as code owners
November 11, 2022 17:04
carmocca
added
lightningcli
pl.cli.LightningCLI
deprecation
Includes a deprecation
labels
Nov 11, 2022
carmocca
reviewed
Nov 12, 2022
Co-authored-by: Carlos Mocholí <[email protected]>
mauvilsa
commented
Nov 14, 2022
victor-yon
reviewed
Nov 19, 2022
victor-yon
approved these changes
Nov 19, 2022
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.
These changes solve the issue I submitted (#15174)
carmocca
approved these changes
Nov 21, 2022
This reverts commit ca1e57f.
awaelchli
approved these changes
Nov 26, 2022
mergify
bot
added
ready
PRs ready to be merged
and removed
has conflicts
ready
PRs ready to be merged
labels
Nov 26, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
deprecation
Includes a deprecation
lightningcli
pl.cli.LightningCLI
pl
Generic label for PyTorch Lightning package
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?
Fixes #15174
It includes the deprecations and the related suggestions in #15174 (comment). I also increased the minimum version of jsonargparse because otherwise mypy gives an error.
Does your PR introduce any breaking changes? If yes, please list them.
Three parameters are deprecated in
LightningCLI.__init__
which should now be given throughparser_kwargs
:description
env_prefix
env_parse
Before submitting
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:
Did you have fun?
Make sure you had fun coding 🙃