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 failing when both module and data module save hyperparameters #20221

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

Conversation

mauvilsa
Copy link
Contributor

@mauvilsa mauvilsa commented Aug 22, 2024

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/

…arameters due to conflicting internal parameter
@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Aug 22, 2024
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

@@ -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?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was adding a warning, but then realized that if LightningCLI is used, then there would always be a warning. So now I changed the code so that only the LightningCLI internal params are skipped and removed from logging.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also only skipping _class_path because if _instantiator is skipped, then test_lightning_cli_load_from_checkpoint_dependency_injection fails. I don't understand why, but anyway _class_path is the only problem in #20182.

@lantiga lantiga added the waiting on author Waiting on user action, correction, or update label Nov 12, 2024
Copy link

codecov bot commented Nov 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81%. Comparing base (c110f4f) to head (ea8608f).
Report is 3 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (c110f4f) and HEAD (ea8608f). Click for more details.

HEAD has 547 uploads less than BASE
Flag BASE (c110f4f) HEAD (ea8608f)
gpu 3 2
pytest 79 2
lightning_fabric 20 0
cpu 148 24
python3.9 38 6
python3.10 19 3
lightning 112 19
python3.11 37 6
python3.12 54 9
pytorch_lightning 19 7
pytorch2.1 27 9
pytest-full 72 24
pytorch2.3 9 3
pytorch2.2.2 9 3
pytorch2.5.1 18 6
pytorch2.4.1 9 3
Additional details and impacted files
@@            Coverage Diff            @@
##           master   #20221     +/-   ##
=========================================
- Coverage      88%      81%     -8%     
=========================================
  Files         267      264      -3     
  Lines       23203    23152     -51     
=========================================
- Hits        20526    18744   -1782     
- Misses       2677     4408   +1731     
---- 🚨 Try these New Features:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pl Generic label for PyTorch Lightning package waiting on author Waiting on user action, correction, or update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Error while merging hparams when using LightningCLI and YAML
3 participants