TensorBoardLogger

class torchtune.training.metric_logging.TensorBoardLogger(log_dir: str, organize_logs: bool = True, **kwargs)

用于 PyTorch 的 TensorBoard 实现 (https://pytorch.ac.cn/docs/stable/tensorboard.html) 的记录器。

参数：

• log_dir (str) – torch.TensorBoard 日志目录

• organize_logs (bool) – 如果为 True，此类将在 log_dir 中为当前运行创建一个子目录。拥有子目录允许您跨运行比较日志。当 TensorBoard 在启动时传递一个 logdir 时，它会递归遍历以 logdir 为根的目录树，查找包含 tfevents 数据的子目录。每次遇到这样的子目录时，它都会将其加载为新的运行，并且前端将相应地组织数据。建议值为 True。运行 tensorboard –logdir my_log_dir 以查看日志。

• **kwargs – 其他参数

示例

>>> from torchtune.training.metric_logging import TensorBoardLogger
>>> logger = TensorBoardLogger(log_dir="my_log_dir")
>>> logger.log("my_metric", 1.0, 1)
>>> logger.log_dict({"my_metric": 1.0}, 1)
>>> logger.close()

注意

此实用程序需要安装 tensorboard 包。您可以使用 pip install tensorboard 安装它。为了查看 TensorBoard 日志，您需要在终端中运行 tensorboard –logdir my_log_dir。

close() → None

关闭日志资源，必要时刷新。在调用 close 后不应写入日志。

log(name: str, data: Union[Tensor, ndarray, int, float], step: int) → None

记录标量数据。

参数：

• name (str) – 用于对标量进行分组的标签名称

• data (Scalar) – 要记录的标量数据

• step (int) – 要记录的步长值

log_dict(payload: Mapping[str, Union[Tensor, ndarray, int, float]], step: int) → None

记录多个标量值。

参数：

• payload (Mapping[str, Scalar]) – 标签名称和标量值的字典

• step (int) – 要记录的步长值