import os from warnings import warn import torch from pkg_resources import parse_version from torch.utils.tensorboard import SummaryWriter from .base import LightningLoggerBase, rank_zero_only class TensorBoardLogger(LightningLoggerBase): r"""Log to local file system in TensorBoard format Implemented using :class:`torch.utils.tensorboard.SummaryWriter`. Logs are saved to `os.path.join(save_dir, name, version)` :example: .. code-block:: python logger = TensorBoardLogger("tb_logs", name="my_model") trainer = Trainer(logger=logger) trainer.train(model) :param str save_dir: Save directory :param str name: Experiment name. Defaults to "default". :param int version: Experiment version. If version is not specified the logger inspects the save directory for existing versions, then automatically assigns the next available version. :param \**kwargs: Other arguments are passed directly to the :class:`SummaryWriter` constructor. """ def __init__(self, save_dir, name="default", version=None, **kwargs): super().__init__() self.save_dir = save_dir self._name = name self._version = version self._experiment = None self.kwargs = kwargs @property def experiment(self): """The underlying :class:`torch.utils.tensorboard.SummaryWriter`. :rtype: torch.utils.tensorboard.SummaryWriter """ if self._experiment is not None: return self._experiment root_dir = os.path.join(self.save_dir, self.name) os.makedirs(root_dir, exist_ok=True) log_dir = os.path.join(root_dir, str(self.version)) self._experiment = SummaryWriter(log_dir=log_dir, **self.kwargs) return self._experiment @rank_zero_only def log_hyperparams(self, params): if parse_version(torch.__version__) < parse_version("1.3.0"): warn( f"Hyperparameter logging is not available for Torch version {torch.__version__}." " Skipping log_hyperparams. Upgrade to Torch 1.3.0 or above to enable" " hyperparameter logging." ) # TODO: some alternative should be added return try: # in case converting from namespace, todo: rather test if it is namespace params = vars(params) except TypeError: pass if params is not None: # `add_hparams` requires both - hparams and metric self.experiment.add_hparams(hparam_dict=dict(params), metric_dict={}) @rank_zero_only def log_metrics(self, metrics, step=None): for k, v in metrics.items(): if isinstance(v, torch.Tensor): v = v.item() self.experiment.add_scalar(k, v, step) @rank_zero_only def save(self): try: self.experiment.flush() except AttributeError: # you are using PT version (