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

Nicer logging of list of dicts for hyper parameters #19963

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

Conversation

vork
Copy link

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

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