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 LightningCLI parse_env and description in subcommands #15138

Merged
merged 5 commits into from
Oct 21, 2022
Merged

Fix LightningCLI parse_env and description in subcommands #15138

merged 5 commits into from
Oct 21, 2022

Conversation

mauvilsa
Copy link
Contributor

@mauvilsa mauvilsa commented Oct 14, 2022

What does this PR do?

Fixes #12790 though the problem was not improperly forwarding arguments. In the case of parse_env it was a bug in jsonargparse which caused the environment variable names to not be shown in the help. Regarding description, I think it makes more sense to use the short description in the docstring of the trainer method. This is how it is already shown in the main help.

Fixes #12790

Does your PR introduce any breaking changes? If yes, please list them.

None

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?
  • [n/a] 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 Oct 14, 2022
- Use Trainer method docstring for LightningCLI subcommand description.
src/pytorch_lightning/cli.py Outdated Show resolved Hide resolved
@carmocca carmocca added this to the v1.8.x milestone Oct 20, 2022
@carmocca carmocca added lightningcli pl.cli.LightningCLI bug Something isn't working labels Oct 20, 2022
@mergify mergify bot added the ready PRs ready to be merged label Oct 21, 2022
@awaelchli awaelchli enabled auto-merge (squash) October 21, 2022 01:21
@carmocca carmocca modified the milestones: v1.8.x, v1.8 Oct 21, 2022
@awaelchli awaelchli merged commit b556713 into Lightning-AI:master Oct 21, 2022
@mauvilsa mauvilsa deleted the cli-fix-issue-12790 branch October 21, 2022 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working 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.

CLI arguments are not properly forwarded to subparsers
3 participants