Skip to content

Conversation

vork
Copy link
Contributor

@vork vork commented Jun 10, 2024

What does this PR do?

Currently, when hyper parameters are logged with log_hyperparams the function calls _flatten_dict to collapse the dict to a single level. However, when the config contains a list of dicts, this gets flattened to a single string. Instead I would propose to log the list as [key/0/item, key/1/item] etc.

Fixes #19957

Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs)
    Only a minor change
  • 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)
    This does not require any changes just makes the hyper parameter logging slightly nicer
  • 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--19963.org.readthedocs.build/en/19963/

vork added 4 commits June 7, 2024 15:41
The current hyper parameter logging flattens a config dictionary. However, when a nested element contains a list of dictionaries, it flattens it to a string. This creates indexed sub-elements.

This can be useful for network configs with multiple heads or other similar use cases.
@github-actions github-actions bot added the fabric lightning.fabric.Fabric label Jun 10, 2024
@mergify mergify bot removed the has conflicts label Jun 12, 2024
@jammm
Copy link

jammm commented Nov 6, 2024

@lantiga @Borda @tchaton @justusschock it would be great if you can take a look at this PR ^^

@Borda Borda requested a review from ethanwharris as a code owner March 14, 2025 09:11
Copy link

codecov bot commented Mar 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88%. Comparing base (96df8c4) to head (9fc3e1c).
Report is 114 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #19963   +/-   ##
=======================================
  Coverage      88%      88%           
=======================================
  Files         267      267           
  Lines       23355    23358    +3     
=======================================
+ Hits        20458    20461    +3     
  Misses       2897     2897           

@Borda Borda merged commit 7900105 into Lightning-AI:master Mar 14, 2025
108 checks passed
Borda added a commit that referenced this pull request Mar 18, 2025
* Add support for handling lists of dictionaries in logging
* Apply suggestions from code review
* Update CHANGELOG.md

---------

Co-authored-by: Jirka Borovec <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
(cherry picked from commit 7900105)
lexierule pushed a commit that referenced this pull request Mar 18, 2025
* Add support for handling lists of dictionaries in logging
* Apply suggestions from code review
* Update CHANGELOG.md

---------

Co-authored-by: Jirka Borovec <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
(cherry picked from commit 7900105)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fabric lightning.fabric.Fabric

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Logging Hyperparameters for list of dicts

3 participants