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.

Sign up for GitHub

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

Jump to bottom

Fix LightningCLI failing when both module and data module save hyperparameters #20221

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Fix LightningCLI failing when both module and data module save hyperparameters #20221

wants to merge 4 commits into from

Conversation

mauvilsa
Copy link
Contributor

@mauvilsa mauvilsa commented Aug 22, 2024 •
edited by github-actions bot
Loading

What does this PR do?

Fixes #20182

Before submitting
  • Was this discussed/agreed 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:

Reviewer checklist
  • 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

📚 Documentation preview 📚: https://pytorch-lightning--20221.org.readthedocs.build/en/20221/

@mauvilsa
Fix LightningCLI failing when both module and data module save hyperp…
17e2d64 
…arameters due to conflicting internal parameter
@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Aug 22, 2024
@mauvilsa mauvilsa mentioned this pull request Aug 23, 2024
Open
lantiga
lantiga approved these changes Nov 12, 2024
View reviewed changes
Copy link
Collaborator

@lantiga lantiga left a comment

Choose a reason for hiding this comment

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

LGTM, this is long overdue.

Just a suggestion and we're ready to merge

src/lightning/pytorch/loggers/utilities.py
@@ -69,6 +69,9 @@ def _log_hyperparams(trainer: "pl.Trainer") -> None:
lightning_hparams = pl_module.hparams_initial
inconsistent_keys = []
for key in lightning_hparams.keys() & datamodule_hparams.keys():
if key.startswith("_"):
# Prevent merging LightningCLI's internal hparams and discourage of private param names
Copy link
Collaborator

Choose a reason for hiding this comment

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

can we throw a warning here when a private param is skipped instead of doing it silently?

@lantiga lantiga added the waiting on author Waiting on user action, correction, or update label Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lantiga lantiga lantiga approved these changes

@Borda Borda Awaiting requested review from Borda Borda is a code owner

@tchaton tchaton Awaiting requested review from tchaton tchaton is a code owner

@awaelchli awaelchli Awaiting requested review from awaelchli

@justusschock justusschock Awaiting requested review from justusschock justusschock is a code owner

Assignees
No one assigned
Labels
pl Generic label for PyTorch Lightning package waiting on author Waiting on user action, correction, or update
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Error while merging hparams when using LightningCLI and YAML
3 participants
@mauvilsa @lantiga @Borda