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

Tensorboard Docu about Hyperparams saving #5158

Merged
merged 10 commits into from
Jan 15, 2021

Conversation

Skyy93
Copy link
Contributor

@Skyy93 Skyy93 commented Dec 16, 2020

What does this PR do?

Adds a bit documentation to the tensorboard logger to clarify its behavior in the case of saving hyperparameters.

Fixes #1225

Before submitting

  • Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
  • 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? Otherwise, we ask you to create a separate PR for every change.
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?
  • Did you verify new and existing tests pass locally with your changes?
  • If you made a notable change (that affects users), did you update the CHANGELOG?

PR review

Anyone in the community is free to review the PR once the tests have passed.
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; Bugfixes should be including in bug-fix release milestones (m.f.X) and features should be included in (m.X.b) releases.

Did you have fun?

Make sure you had fun coding 🙃

@codecov
Copy link

codecov bot commented Dec 16, 2020

Codecov Report

Merging #5158 (d68af89) into master (d15f7a0) will not change coverage.
The diff coverage is 100%.

@@          Coverage Diff           @@
##           master   #5158   +/-   ##
======================================
  Coverage      93%     93%           
======================================
  Files         135     135           
  Lines       10006   10006           
======================================
  Hits         9329    9329           
  Misses        677     677           

@Skyy93 Skyy93 marked this pull request as ready for review December 16, 2020 10:01
@Borda Borda added the docs Documentation related label Dec 16, 2020
@Borda Borda added this to the 1.1.x milestone Dec 16, 2020
pytorch_lightning/loggers/tensorboard.py Outdated Show resolved Hide resolved
pytorch_lightning/loggers/tensorboard.py Outdated Show resolved Hide resolved
@tchaton tchaton enabled auto-merge (squash) January 11, 2021 12:37
@SkafteNicki SkafteNicki added the ready PRs ready to be merged label Jan 11, 2021
pytorch_lightning/loggers/tensorboard.py Outdated Show resolved Hide resolved
pytorch_lightning/loggers/tensorboard.py Outdated Show resolved Hide resolved
@tchaton tchaton merged commit d62ca82 into Lightning-AI:master Jan 15, 2021
Borda added a commit that referenced this pull request Feb 4, 2021
* Add documentation to tensorboard

* Remove unnecessary whitespaces

* Update pytorch_lightning/loggers/tensorboard.py

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>

* Add metrics to tensorboard logger

* Whitespace removed

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

How to log hparams to Tensorboard?
6 participants