|
| 1 | +""" |
| 2 | +File logger |
| 3 | +----------- |
| 4 | +""" |
| 5 | +import io |
| 6 | +import os |
| 7 | +import csv |
| 8 | +import torch |
| 9 | + |
| 10 | +from argparse import Namespace |
| 11 | +from typing import Optional, Dict, Any, Union |
| 12 | + |
| 13 | + |
| 14 | +from pytorch_lightning import _logger as log |
| 15 | +from pytorch_lightning.core.saving import save_hparams_to_yaml |
| 16 | +from pytorch_lightning.loggers.base import LightningLoggerBase |
| 17 | +from pytorch_lightning.utilities.distributed import rank_zero_only |
| 18 | + |
| 19 | + |
| 20 | +class ExperimentWriter(object): |
| 21 | + NAME_HPARAMS_FILE = 'hparams.yaml' |
| 22 | + NAME_METRICS_FILE = 'metrics.csv' |
| 23 | + |
| 24 | + def __init__(self, log_dir): |
| 25 | + self.hparams = {} |
| 26 | + self.metrics = [] |
| 27 | + self.metrics_keys = ["step"] |
| 28 | + |
| 29 | + self.log_dir = log_dir |
| 30 | + if not os.path.exists(log_dir): |
| 31 | + os.makedirs(log_dir) |
| 32 | + |
| 33 | + self.metrics_file_path = os.path.join(self.log_dir, self.NAME_METRICS_FILE) |
| 34 | + |
| 35 | + def log_hparams(self, params): |
| 36 | + self.hparams.update(params) |
| 37 | + |
| 38 | + def log_metrics(self, metrics_dict, step=None): |
| 39 | + def _handle_value(value): |
| 40 | + if isinstance(value, torch.Tensor): |
| 41 | + return value.item() |
| 42 | + return value |
| 43 | + |
| 44 | + if step is None: |
| 45 | + step = len(self.metrics) |
| 46 | + |
| 47 | + new_row = dict.fromkeys(self.metrics_keys) |
| 48 | + new_row['step'] = step |
| 49 | + for k, v in metrics_dict.items(): |
| 50 | + if k not in self.metrics_keys: |
| 51 | + self.metrics_keys.append(k) |
| 52 | + new_row[k] = _handle_value(v) |
| 53 | + self.metrics.append(new_row) |
| 54 | + |
| 55 | + def save(self): |
| 56 | + hparams_file = os.path.join(self.log_dir, self.NAME_HPARAMS_FILE) |
| 57 | + save_hparams_to_yaml(hparams_file, self.hparams) |
| 58 | + |
| 59 | + if self.metrics: |
| 60 | + with io.open(self.metrics_file_path, 'w', newline='') as f: |
| 61 | + self.writer = csv.DictWriter(f, fieldnames=self.metrics_keys) |
| 62 | + self.writer.writeheader() |
| 63 | + self.writer.writerows(self.metrics) |
| 64 | + |
| 65 | + |
| 66 | +class FileLogger(LightningLoggerBase): |
| 67 | + r""" |
| 68 | + Log to local file system in yaml and CSV format. Logs are saved to |
| 69 | + ``os.path.join(save_dir, name, version)``. |
| 70 | +
|
| 71 | + Example: |
| 72 | + >>> from pytorch_lightning import Trainer |
| 73 | + >>> from pytorch_lightning.loggers import FileLogger |
| 74 | + >>> logger = FileLogger("logs", name="my_exp_name") |
| 75 | + >>> trainer = Trainer(logger=logger) |
| 76 | +
|
| 77 | + Args: |
| 78 | + save_dir: Save directory |
| 79 | + name: Experiment name. Defaults to ``'default'``. |
| 80 | + version: Experiment version. If version is not specified the logger inspects the save |
| 81 | + directory for existing versions, then automatically assigns the next available version. |
| 82 | + """ |
| 83 | + |
| 84 | + def __init__(self, |
| 85 | + save_dir: str, |
| 86 | + name: Optional[str] = "default", |
| 87 | + version: Optional[Union[int, str]] = None): |
| 88 | + |
| 89 | + super().__init__() |
| 90 | + self._save_dir = save_dir |
| 91 | + self._name = name or '' |
| 92 | + self._version = version |
| 93 | + self._experiment = None |
| 94 | + |
| 95 | + @property |
| 96 | + def root_dir(self) -> str: |
| 97 | + """ |
| 98 | + Parent directory for all checkpoint subdirectories. |
| 99 | + If the experiment name parameter is ``None`` or the empty string, no experiment subdirectory is used |
| 100 | + and the checkpoint will be saved in "save_dir/version_dir" |
| 101 | + """ |
| 102 | + if self.name is None or len(self.name) == 0: |
| 103 | + return self._save_dir |
| 104 | + return os.path.join(self._save_dir, self.name) |
| 105 | + |
| 106 | + @property |
| 107 | + def log_dir(self) -> str: |
| 108 | + """ |
| 109 | + The log directory for this run. By default, it is named |
| 110 | + ``'version_${self.version}'`` but it can be overridden by passing a string value |
| 111 | + for the constructor's version parameter instead of ``None`` or an int. |
| 112 | + """ |
| 113 | + # create a pseudo standard path ala test-tube |
| 114 | + version = self.version if isinstance(self.version, str) else f"version_{self.version}" |
| 115 | + log_dir = os.path.join(self.root_dir, version) |
| 116 | + return log_dir |
| 117 | + |
| 118 | + @property |
| 119 | + def experiment(self) -> ExperimentWriter: |
| 120 | + r""" |
| 121 | +
|
| 122 | + Actual ExperimentWriter object. To use ExperimentWriter features in your |
| 123 | + :class:`~pytorch_lightning.core.lightning.LightningModule` do the following. |
| 124 | +
|
| 125 | + Example:: |
| 126 | +
|
| 127 | + self.logger.experiment.some_experiment_writer_function() |
| 128 | +
|
| 129 | + """ |
| 130 | + if self._experiment is not None: |
| 131 | + return self._experiment |
| 132 | + |
| 133 | + os.makedirs(self.root_dir, exist_ok=True) |
| 134 | + self._experiment = ExperimentWriter(log_dir=self.log_dir) |
| 135 | + return self._experiment |
| 136 | + |
| 137 | + @rank_zero_only |
| 138 | + def log_hyperparams(self, params: Union[Dict[str, Any], Namespace]) -> None: |
| 139 | + params = self._convert_params(params) |
| 140 | + self.experiment.log_hparams(params) |
| 141 | + |
| 142 | + @rank_zero_only |
| 143 | + def log_metrics(self, metrics: Dict[str, float], step: Optional[int] = None) -> None: |
| 144 | + self.experiment.log_metrics(metrics, step) |
| 145 | + |
| 146 | + @rank_zero_only |
| 147 | + def save(self) -> None: |
| 148 | + super().save() |
| 149 | + self.experiment.save() |
| 150 | + |
| 151 | + @rank_zero_only |
| 152 | + def finalize(self, status: str) -> None: |
| 153 | + self.save() |
| 154 | + |
| 155 | + @property |
| 156 | + def name(self) -> str: |
| 157 | + return self._name |
| 158 | + |
| 159 | + @property |
| 160 | + def version(self) -> int: |
| 161 | + if self._version is None: |
| 162 | + self._version = self._get_next_version() |
| 163 | + return self._version |
| 164 | + |
| 165 | + def _get_next_version(self): |
| 166 | + root_dir = os.path.join(self._save_dir, self.name) |
| 167 | + |
| 168 | + if not os.path.isdir(root_dir): |
| 169 | + log.warning('Missing logger folder: %s', root_dir) |
| 170 | + return 0 |
| 171 | + |
| 172 | + existing_versions = [] |
| 173 | + for d in os.listdir(root_dir): |
| 174 | + if os.path.isdir(os.path.join(root_dir, d)) and d.startswith("version_"): |
| 175 | + existing_versions.append(int(d.split("_")[1])) |
| 176 | + |
| 177 | + if len(existing_versions) == 0: |
| 178 | + return 0 |
| 179 | + |
| 180 | + return max(existing_versions) + 1 |
0 commit comments