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

Deprecate description and env parameters in LightningCLI.__init__ #15651

Merged
merged 12 commits into from
Nov 27, 2022
Merged

Deprecate description and env parameters in LightningCLI.__init__ #15651

merged 12 commits into from
Nov 27, 2022

Conversation

mauvilsa
Copy link
Contributor

@mauvilsa mauvilsa commented Nov 11, 2022

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 through parser_kwargs:

  • description
  • env_prefix
  • env_parse

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 list all the breaking changes introduced by this pull request?
  • 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:

  • 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?

Make sure you had fun coding 🙃

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Nov 11, 2022
@mauvilsa mauvilsa marked this pull request as ready for review November 11, 2022 17:04
@carmocca carmocca added lightningcli pl.cli.LightningCLI deprecation Includes a deprecation labels Nov 11, 2022
@carmocca carmocca added this to the v1.9 milestone Nov 11, 2022
@mergify mergify bot removed the has conflicts label Nov 12, 2022
docs/source-pytorch/cli/lightning_cli_advanced.rst Outdated Show resolved Hide resolved
docs/source-pytorch/cli/lightning_cli_advanced_2.rst Outdated Show resolved Hide resolved
src/pytorch_lightning/cli.py Show resolved Hide resolved
src/pytorch_lightning/cli.py Outdated Show resolved Hide resolved
src/pytorch_lightning/cli.py Outdated Show resolved Hide resolved
src/pytorch_lightning/cli.py Outdated Show resolved Hide resolved
src/pytorch_lightning/cli.py Show resolved Hide resolved
src/pytorch_lightning/cli.py Outdated Show resolved Hide resolved
Copy link

@victor-yon victor-yon left a 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)

src/pytorch_lightning/CHANGELOG.md Outdated Show resolved Hide resolved
src/pytorch_lightning/cli.py Outdated Show resolved Hide resolved
src/pytorch_lightning/cli.py Show resolved Hide resolved
@mergify mergify bot added ready PRs ready to be merged and removed has conflicts ready PRs ready to be merged labels Nov 26, 2022
@awaelchli awaelchli enabled auto-merge (squash) November 26, 2022 22:01
@mergify mergify bot added the ready PRs ready to be merged label Nov 26, 2022
@awaelchli awaelchli merged commit 3fad651 into Lightning-AI:master Nov 27, 2022
@mauvilsa mauvilsa deleted the cli-parser-kwargs branch November 27, 2022 12:39
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add default_config_files argument to LightningCLI.__init__
5 participants