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

An instance of SaveConfigCallback should only save the config once #14927

Merged
merged 5 commits into from
Sep 30, 2022
Merged

An instance of SaveConfigCallback should only save the config once #14927

merged 5 commits into from
Sep 30, 2022

Conversation

mauvilsa
Copy link
Contributor

@mauvilsa mauvilsa commented Sep 28, 2022

What does this PR do?

When using LightningCLI(.., run=False) it is very common to call multiple Trainer methods, e.g. fit then test. In the second method call, the SaveConfigCallback attempts to save the config again, which by default would fail because it refuses to overwrite. This makes it necessary to have save_config_overwrite=True even though one might not want this. This can be observed in some places, for example #1715 (comment).

This change is so that a single instance of SaveConfigCallback only attempts to save the config once, avoiding the problem described before. I would consider this to be a bug fix.

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 Sep 28, 2022
@awaelchli
Copy link
Contributor

I think I agree with the changes. However, I don't understand this sentence:

This makes it necessary to have save_config_overwrite=True even though one might not want this.

In order to reproduce, I think it makes sense to have run=False, overwrite=False, because we want to save the config of the initial fit/test. If we were to overwrite, we would end up with the config of the last ever called fit/test, but that would make it not reproducible.

The logic in the code of this PR however makes sense to me, and I think it implements what I mean.

@awaelchli awaelchli added the lightningcli pl.cli.LightningCLI label Sep 28, 2022
@mergify mergify bot added the ready PRs ready to be merged label Sep 28, 2022
@carmocca carmocca added this to the pl:1.7.x milestone Sep 28, 2022
Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

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

LGTM !

@otaj otaj enabled auto-merge (squash) September 29, 2022 13:05
@mergify mergify bot added has conflicts and removed ready PRs ready to be merged labels Sep 29, 2022
@mergify mergify bot added ready PRs ready to be merged and removed has conflicts ready PRs ready to be merged labels Sep 29, 2022
@otaj otaj merged commit 15aa9c6 into Lightning-AI:master Sep 30, 2022
@mauvilsa mauvilsa deleted the cli-save-config-only-once branch September 30, 2022 12:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

5 participants