Skip to content

LightningCLI instantiator receives values applied by instantiation links to set in hparams #20777

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

Conversation

mauvilsa
Copy link
Contributor

@mauvilsa mauvilsa commented Apr 30, 2025

What does this PR do?

Fixes save_hyperparameters when used through LightningCLI (feature introduced in #18105) so that target values of links applied for instantiation are included in hparams.

Fixes #20311
Fixes #20147

Also adds an official way to disable #18105 (parameter load_from_checkpoint_support), which might be desired by some people, e.g #20432, #20726

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--20777.org.readthedocs.build/en/20777/

@github-actions github-actions bot added ci Continuous Integration dockers labels Jun 6, 2025
@Borda
Copy link
Member

Borda commented Jun 6, 2025

Please check the failing GPU stand-alone test:

TypeError: _InstantiatorFn.call() missing 1 required keyword-only argument: 'applied_instantiation_links'

@mauvilsa
Copy link
Contributor Author

mauvilsa commented Jun 6, 2025

Please check the failing GPU stand-alone test:

TypeError: _InstantiatorFn.call() missing 1 required keyword-only argument: 'applied_instantiation_links'

Looking at the logs, in Install package & dependencies I see that jsonargparse v4.35.0 gets installed (e.g. here), even though the requirement is >=4.39.0, <4.40.0. I don't know how to figure out why this is happening.

@Borda
Copy link
Member

Borda commented Jun 11, 2025

Looking at the logs, in Install package & dependencies I see that jsonargparse v4.35.0 gets installed (e.g. here), even though the requirement is >=4.39.0, <4.40.0. I don't know how to figure out why this is happening.

not sure why, but we added this silly line:

pip install setuptools==75.6.0 jsonargparse==4.35.0

@Borda Borda merged commit d032388 into Lightning-AI:master Jun 11, 2025
101 checks passed
@mauvilsa mauvilsa deleted the issue-20311-cli-save-hyper-instatiation-links branch June 11, 2025 07:29
Borda pushed a commit that referenced this pull request Jun 19, 2025
…nks to set in hparams (#20777)

* Instantiator receives values applied by instantiation links to set in hparams (#20311).
* Add cleandir to test_lightning_cli_link_arguments
* fix install...

---------

Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com>
Co-authored-by: Jirka B <j.borovec+github@gmail.com>

(cherry picked from commit d032388)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous Integration dependencies Pull requests that update a dependency file dockers pl Generic label for PyTorch Lightning package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Save save_hyperparameters no longer respects linked arguments. link_arguments does not work in lightning 2.3
2 participants