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

Prefix log_metrics keys with class name in callbacks #12228

Merged
merged 7 commits into from
May 3, 2022
Merged

Prefix log_metrics keys with class name in callbacks #12228

merged 7 commits into from
May 3, 2022

Conversation

pbsds
Copy link
Contributor

@pbsds pbsds commented Mar 4, 2022 •
edited by awaelchli
Loading

What does this PR do?

It groups metrics logged by the built in callbacks by the callback class name.
Screenshot from tensorboard:
image

As i write a plethora of callbacks myself, i found this to be a nice thing to have, and why not upstream it while at it.

Fixes #12231

Does your PR introduce any breaking changes? If yes, please list them.

This may change the label/key some metrics are logged under.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
    • No, but you could do so here on this draft PR
  • 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 internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • 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

Did you have fun?

Make sure you had fun coding 🙃

@pbsds pbsds mentioned this pull request Mar 4, 2022
Closed
@stale
Copy link

stale bot commented Mar 19, 2022

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. If you need further help see our docs: https://pytorch-lightning.readthedocs.io/en/latest/generated/CONTRIBUTING.html#pull-request or ask the assistance of a core contributor here or on Slack. Thank you for your contributions.

@stale stale bot added the won't fix This will not be worked on label Mar 19, 2022
@pbsds pbsds force-pushed the callback_prefixes branch from 088725e to 1f3e9c2 Compare March 21, 2022 12:24
@stale stale bot removed the won't fix This will not be worked on label Mar 21, 2022
@pbsds pbsds marked this pull request as ready for review March 21, 2022 12:25
@pbsds
Copy link
Contributor Author

pbsds commented Apr 6, 2022

Are the broken code-runners blocking review?

@carmocca
Copy link
Contributor

carmocca commented Apr 6, 2022

Are the broken code-runners blocking review?

Yes, we have some blocking issues in our CI currently.

Can you also update the CHANGELOG?

@awaelchli awaelchli added this to the 1.7 milestone Apr 24, 2022
awaelchli
awaelchli approved these changes Apr 24, 2022
View reviewed changes
Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

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

LGTM
The tests probably need to be adjusted given the new name. And a changelog entry would be nice :)

@carmocca carmocca added the community This PR is from the community label Apr 25, 2022
@carmocca carmocca self-assigned this Apr 25, 2022
@pbsds pbsds requested a review from SeanNaren as a code owner May 2, 2022 16:39
@mergify mergify bot removed the has conflicts label May 2, 2022
@mergify mergify bot added the ready PRs ready to be merged label May 2, 2022
rohitgr7
rohitgr7 approved these changes May 2, 2022
View reviewed changes
Copy link
Contributor

@rohitgr7 rohitgr7 left a comment

Choose a reason for hiding this comment

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

should we do this for LearningRateMonitor?

@awaelchli awaelchli merged commit c278802 into Lightning-AI:master May 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rohitgr7 rohitgr7 rohitgr7 approved these changes

@carmocca carmocca carmocca approved these changes

@awaelchli awaelchli awaelchli approved these changes

@williamFalcon williamFalcon Awaiting requested review from williamFalcon

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

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

@kaushikb11 kaushikb11 Awaiting requested review from kaushikb11

@SeanNaren SeanNaren Awaiting requested review from SeanNaren

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

Assignees

@carmocca carmocca

Labels
callback: device stats callback: lr monitor community This PR is from the community feature Is an improvement or enhancement ready PRs ready to be merged
Projects
None yet
Milestone
pl:1.7
Development

Successfully merging this pull request may close these issues.

Prefix log_metrics keys with class name in callbacks
4 participants
@pbsds @carmocca @awaelchli @rohitgr7