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

Tensorboard Docu about Hyperparams saving #5158

Merged
merged 10 commits into from
Jan 15, 2021
Merged

Tensorboard Docu about Hyperparams saving #5158

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3797e57
Add documentation to tensorboard
Skyy93 Dec 16, 2020
6af831e
Remove unnecessary whitespaces
Skyy93 Dec 16, 2020
034b609
Update pytorch_lightning/loggers/tensorboard.py
Skyy93 Dec 16, 2020
20c3f29
Add metrics to tensorboard logger
Skyy93 Dec 16, 2020
c6ca7f3
Merge branch 'tensorBoardDocu' of https://github.com/Skyy93/pytorch-l…
Skyy93 Dec 16, 2020
1a4ab89
Whitespace removed
Skyy93 Dec 16, 2020
92f8adf
Merge branch 'master' into tensorBoardDocu
SkafteNicki Jan 13, 2021
95590be
tensorboard spelling
awaelchli Jan 15, 2021
e753c8d
typing
awaelchli Jan 15, 2021
d68af89
Merge branch 'master' into tensorBoardDocu
awaelchli Jan 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions pytorch_lightning/loggers/tensorboard.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,21 @@ def experiment(self) -> SummaryWriter:
return self._experiment

@rank_zero_only
def log_hyperparams(self, params: Union[Dict[str, Any], Namespace],
metrics: Optional[Dict[str, Any]] = None) -> None:
def log_hyperparams(
self,
params: Union[Dict[str, Any], Namespace],
metrics: Optional[Dict[str, Any]] = None,
) -> None:
"""
Record hyperparameters. TensorBoard logs with and without saved hyperparameters
are incompatible, the hyperparameters are then not displayed in the TensorBoard.
Please delete or move the previously saved logs to display the new ones with hyperparameters.

Args:
params: a dictionary-like container with the hyperparameters
metrics: Dictionary with metric names as keys and measured quantities as values
"""

params = self._convert_params(params)

# store params to output
Expand Down