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

Added support for custom parameters in subclasses of SaveConfigCallback #14998

Merged
merged 1 commit into from
Oct 5, 2022
Merged

Added support for custom parameters in subclasses of SaveConfigCallback #14998

merged 1 commit into from
Oct 5, 2022

Conversation

mauvilsa
Copy link
Contributor

@mauvilsa mauvilsa commented Oct 4, 2022

What does this PR do?

Implements suggestion in #14628 (comment). Does not close that issue, but it makes it possible for people to implement by themselves.

This has the benefits that:

  • We remove duplications of parameters that were in both SaveConfigCallback and in LightningCLI.__init__.
  • Makes it possible for people to subclass SaveConfigCallback adding new parameters, and allow these be given on LightningCLI instantiation.

Currently the save of the config is not even mentioned in the docs. The pull requests #14976 adds it. Could be that this is added to the docs in that pull request.

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

SaveConfigCallback parameters in LightningCLI instantiation must now be given in save_config_kwargs, and making save_config_kwargs, save_config_overwrite and save_config_multifile deprecated.

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 Oct 4, 2022
@mauvilsa mauvilsa changed the title SaveConfigCallback subclass custom parameters support Added support for custom parameters in subclasses of SaveConfigCallback Oct 4, 2022
@mauvilsa mauvilsa marked this pull request as ready for review October 4, 2022 19:33
…back.

- Deprecated duplicate SaveConfigCallback parameters in LightningCLI.__init__: save_config_kwargs, save_config_overwrite and save_config_multifile
src/pytorch_lightning/cli.py Show resolved Hide resolved
@carmocca carmocca added this to the pl:1.8 milestone Oct 5, 2022
@carmocca carmocca added lightningcli pl.cli.LightningCLI feature Is an improvement or enhancement labels Oct 5, 2022
@mergify mergify bot added the ready PRs ready to be merged label Oct 5, 2022
@carmocca carmocca added the deprecation Includes a deprecation label Oct 5, 2022
@carmocca carmocca merged commit 3853580 into Lightning-AI:master Oct 5, 2022
@mauvilsa mauvilsa deleted the cli-save-config-improvements branch October 5, 2022 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation Includes a deprecation feature Is an improvement or enhancement 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.

3 participants