TensorBoardLogger

class pytorch_lightning.loggers.TensorBoardLogger(save_dir, name='lightning_logs', version=None, log_graph=False, default_hp_metric=True, prefix='', sub_dir=None, agg_key_funcs=None, agg_default_func=None, **kwargs)

Bases: pytorch_lightning.loggers.base.LightningLoggerBase

Log to local file system in TensorBoard format.

Implemented using SummaryWriter. Logs are saved to os.path.join(save_dir, name, version). This is the default logger in Lightning, it comes preinstalled.

Example:

from pytorch_lightning import Trainer
from pytorch_lightning.loggers import TensorBoardLogger

logger = TensorBoardLogger("tb_logs", name="my_model")
trainer = Trainer(logger=logger)

Parameters

• save_dir (str) – Save directory

• name (Optional[str]) – Experiment name. Defaults to 'default'. If it is the empty string then no per-experiment subdirectory is used.

• version (Union[int, str, None]) – Experiment version. If version is not specified the logger inspects the save directory for existing versions, then automatically assigns the next available version. If it is a string then it is used as the run-specific subdirectory name, otherwise 'version_${version}' is used.

• log_graph (bool) – Adds the computational graph to tensorboard. This requires that the user has defined the self.example_input_array attribute in their model.

• default_hp_metric (bool) – Enables a placeholder metric with key hp_metric when log_hyperparams is called without a metric (otherwise calls to log_hyperparams without a metric are ignored).

• prefix (str) – A string to put at the beginning of metric keys.

• sub_dir (Optional[str]) – Sub-directory to group TensorBoard logs. If a sub_dir argument is passed then logs are saved in /save_dir/name/version/sub_dir/. Defaults to None in which logs are saved in /save_dir/name/version/.

• **kwargs – Additional arguments used by SummaryWriter can be passed as keyword arguments in this logger. To automatically flush to disk, max_queue sets the size of the queue for pending logs before flushing. flush_secs determines how many seconds elapses before flushing.

finalize(status)

Do any processing that is necessary to finalize an experiment.

Parameters

status (str) – Status that the experiment finished with (e.g. success, failed, aborted)

Return type

None

log_graph(model, input_array=None)

Record model graph.

Parameters

• model (LightningModule) – lightning model

• input_array – input passes to model.forward

log_hyperparams(params, metrics=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.

Parameters

• params (Union[Dict[str, Any], Namespace]) – a dictionary-like container with the hyperparameters

• metrics (Optional[Dict[str, Any]]) – Dictionary with metric names as keys and measured quantities as values

Return type

None

log_metrics(metrics, step=None)

Records metrics. This method logs metrics as as soon as it received them. If you want to aggregate metrics for one specific step, use the agg_and_log_metrics() method.

Parameters

• metrics (Dict[str, float]) – Dictionary with metric names as keys and measured quantities as values

• step (Optional[int]) – Step number at which the metrics should be recorded

Return type

None

save()

Save log data.

Return type

None

property experiment: torch.utils.tensorboard.SummaryWriter

Actual tensorboard object. To use TensorBoard features in your LightningModule do the following.

Example:

self.logger.experiment.some_tensorboard_function()

Return type

SummaryWriter

property log_dir: str

The directory for this run’s tensorboard checkpoint.

By default, it is named 'version_${self.version}' but it can be overridden by passing a string value for the constructor’s version parameter instead of None or an int.

Return type

str

property name: str

Get the name of the experiment.

Return type

str

Returns

The name of the experiment.

property root_dir: str

Parent directory for all tensorboard checkpoint subdirectories.

If the experiment name parameter is an empty string, no experiment subdirectory is used and the checkpoint will be saved in “save_dir/version”

Return type

str

property save_dir: Optional[str]

Gets the save directory where the TensorBoard experiments are saved.

Return type

Optional[str]

Returns

The local path to the save directory where the TensorBoard experiments are saved.

property sub_dir: Optional[str]

Gets the sub directory where the TensorBoard experiments are saved.

Return type

Optional[str]

Returns

The local path to the sub directory where the TensorBoard experiments are saved.

property version: int

Get the experiment version.

Return type

int

Returns

The experiment version if specified else the next version.