-
-
Notifications
You must be signed in to change notification settings - Fork 385
/
tensorboard.py
180 lines (148 loc) · 5.52 KB
/
tensorboard.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
from typing import Dict
import os
import numpy as np
from tensorboardX import SummaryWriter
from catalyst.core.logger import ILogger
from catalyst.loggers.functional import image_to_tensor
class TensorboardLogger(ILogger):
"""Tensorboard logger for parameters, metrics, images and other artifacts.
Args:
logdir: path to logdir for tensorboard
use_logdir_postfix: boolean flag to use extra ``tensorboard`` prefix in the logdir
.. note::
This logger is used by default by ``dl.Runner`` and ``dl.SupervisedRunner`` in case of
specified logdir during ``runner.train(..., logdir=/path/to/logdir)``.
.. note::
This logger is used by default by ``dl.ConfigRunner`` and ``dl.HydraRunner`` in case of
specified logdir in config ``args``.
Notebook API examples:
.. code-block:: python
from catalyst import dl
runner = dl.SupervisedRunner()
runner.train(
...,
loggers={"tensorboard": dl.TensorboardLogger(logdir="./logdir/tensorboard"}
)
.. code-block:: python
from catalyst import dl
class CustomRunner(dl.IRunner):
# ...
def get_loggers(self):
return {
"console": dl.ConsoleLogger(),
"tensorboard": dl.TensorboardLogger(logdir="./logdir/tensorboard")
}
# ...
runner = CustomRunner().run()
Config API example:
.. code-block:: yaml
loggers:
tensorboard:
_target_: TensorboardLogger
logdir: ./logdir/tensorboard
...
Hydra API example:
.. code-block:: yaml
loggers:
tensorboard:
_target_: catalyst.dl.TensorboardLogger
logdir: ./logdir/tensorboard
...
"""
def __init__(self, logdir: str, use_logdir_postfix: bool = False):
"""Init."""
if use_logdir_postfix:
logdir = os.path.join(logdir, "tensorboard")
self.logdir = logdir
self.loggers = {}
os.makedirs(self.logdir, exist_ok=True)
def _check_loader_key(self, loader_key: str):
if loader_key not in self.loggers.keys():
logdir = os.path.join(self.logdir, f"{loader_key}")
self.loggers[loader_key] = SummaryWriter(logdir)
def _log_metrics(self, metrics: Dict[str, float], step: int, loader_key: str, suffix=""):
for key, value in metrics.items():
self.loggers[loader_key].add_scalar(f"{key}{suffix}", float(value), step)
def log_metrics(
self,
metrics: Dict[str, float],
scope: str = None,
# experiment info
run_key: str = None,
global_epoch_step: int = 0,
global_batch_step: int = 0,
global_sample_step: int = 0,
# stage info
stage_key: str = None,
stage_epoch_len: int = 0,
stage_epoch_step: int = 0,
stage_batch_step: int = 0,
stage_sample_step: int = 0,
# loader info
loader_key: str = None,
loader_batch_len: int = 0,
loader_sample_len: int = 0,
loader_batch_step: int = 0,
loader_sample_step: int = 0,
) -> None:
"""Logs batch and epoch metrics to Tensorboard."""
if scope == "batch":
self._check_loader_key(loader_key=loader_key)
# metrics = {k: float(v) for k, v in metrics.items()}
self._log_metrics(
metrics=metrics, step=global_sample_step, loader_key=loader_key, suffix="/batch"
)
elif scope == "loader":
self._check_loader_key(loader_key=loader_key)
self._log_metrics(
metrics=metrics, step=global_epoch_step, loader_key=loader_key, suffix="/epoch",
)
elif scope == "epoch":
# @TODO: remove naming magic
loader_key = "_epoch_"
per_loader_metrics = metrics[loader_key]
self._check_loader_key(loader_key=loader_key)
self._log_metrics(
metrics=per_loader_metrics,
step=global_epoch_step,
loader_key=loader_key,
suffix="/epoch",
)
def log_image(
self,
tag: str,
image: np.ndarray,
scope: str = None,
# experiment info
run_key: str = None,
global_epoch_step: int = 0,
global_batch_step: int = 0,
global_sample_step: int = 0,
# stage info
stage_key: str = None,
stage_epoch_len: int = 0,
stage_epoch_step: int = 0,
stage_batch_step: int = 0,
stage_sample_step: int = 0,
# loader info
loader_key: str = None,
loader_batch_len: int = 0,
loader_sample_len: int = 0,
loader_batch_step: int = 0,
loader_sample_step: int = 0,
) -> None:
"""Logs image to Tensorboard for current scope on current step."""
assert loader_key is not None
self._check_loader_key(loader_key=loader_key)
tensor = image_to_tensor(image)
self.loggers[loader_key].add_image(f"{tag}/{scope}", tensor, global_step=global_epoch_step)
def flush_log(self) -> None:
"""Flushes the loggers."""
for logger in self.loggers.values():
logger.flush()
def close_log(self, scope: str = None) -> None:
"""Closes the loggers."""
if scope is None or scope == "experiment":
for logger in self.loggers.values():
logger.close()
__all__ = ["TensorboardLogger"]