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

LightningCLI support for argument links applied on instantiation #7895

Merged
merged 5 commits into from
Jun 12, 2021
Merged

LightningCLI support for argument links applied on instantiation #7895

merged 5 commits into from
Jun 12, 2021

Conversation

mauvilsa
Copy link
Contributor

@mauvilsa mauvilsa commented Jun 9, 2021

What does this PR do?

From discussions mostly in slack it became clear that there are common cases in which parameters that are only available after instantiating the data module class are needed to instantiate the model. To achieve the user had to subclass LightningCLI in a non-trivial way. With this PR these cases can be implemented in a much simpler way. The concept of argument linking is extended so that they can be applied on instantiation. It use is explained in the change of lightning_cli.rst.

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 update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

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:

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

@pep8speaks
Copy link

pep8speaks commented Jun 9, 2021

Hello @mauvilsa! Thanks for updating this PR.

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2021-06-09 19:33:48 UTC

@codecov
Copy link

codecov bot commented Jun 9, 2021

Codecov Report

Merging #7895 (42c6619) into master (b214442) will decrease coverage by 7%.
The diff coverage is 100%.

@@           Coverage Diff            @@
##           master   #7895     +/-   ##
========================================
- Coverage      91%     84%     -7%     
========================================
  Files         204     204             
  Lines       13630   13657     +27     
========================================
- Hits        12414   11415    -999     
- Misses       1216    2242   +1026     

@carmocca carmocca added this to the v1.4 milestone Jun 9, 2021
@carmocca carmocca added argparse (removed) Related to argument parsing (argparse, Hydra, ...) feature Is an improvement or enhancement labels Jun 9, 2021
Copy link
Contributor

@carmocca carmocca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still draft? What's missing?

docs/source/common/lightning_cli.rst Outdated Show resolved Hide resolved
docs/source/common/lightning_cli.rst Outdated Show resolved Hide resolved
pytorch_lightning/utilities/cli.py Show resolved Hide resolved
@mauvilsa mauvilsa marked this pull request as ready for review June 9, 2021 19:52
Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

smart!

@carmocca carmocca added the ready PRs ready to be merged label Jun 10, 2021
@awaelchli awaelchli enabled auto-merge (squash) June 12, 2021 10:53
@awaelchli awaelchli merged commit cdd01f3 into Lightning-AI:master Jun 12, 2021
@mauvilsa mauvilsa deleted the cli_link_on_instantiate branch June 12, 2021 12:06
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, ...) feature Is an improvement or enhancement ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants