TensorBoardResultTracker

class TensorBoardResultTracker(experiment_path: None | str | Path = None, experiment_name: str | None = None)[source]

A tracker for TensorBoard.

Initialize result tracking via Tensorboard.

Parameters:

experiment_path (None | str | Path) – The experiment path. A custom path at which the tensorboard logs will be saved.
experiment_name (str | None) – The name of the experiment, will be used as a sub directory name for the logging. If no default is given, the current time is used. If set, experiment_path is set, this argument has no effect.

Methods Summary

`end_run`([success])	End a run.
`log_metrics`(metrics[, step, prefix])	Log metrics to result store.
`log_params`(params[, prefix])	Log parameters to result store.

Methods Documentation

end_run(success: bool = True) → None[source]

End a run.

HAS to be called after the experiment is finished.

Parameters:: success (bool) – Can be used to signal failed runs. May be ignored.
Return type:: None

log_metrics(metrics: Mapping[str, float], step: int | None = None, prefix: str | None = None) → None[source]

Log metrics to result store.

Parameters:

metrics (Mapping[str, float]) – The metrics to log.
step (int | None) – An optional step to attach the metrics to (e.g. the epoch).
prefix (str | None) – An optional prefix to prepend to every key in metrics.

Return type:

None

log_params(params: Mapping[str, Any], prefix: str | None = None) → None[source]

Log parameters to result store.

Parameters:

Return type:

None