TensorBoard 日志记录器

TensorBoard 是一个用于机器学习实验的可视化工具包。TensorBoard 允许跟踪和可视化损失和准确性等指标，可视化模型图，查看直方图，显示图像等等。TensorBoard 与 Hugging Face Hub 紧密集成。当 TensorBoard 追踪（如 tfevents）被推送到 Hub 时，Hub 会自动检测并启动一个实例来可视化它们。有关 Hub 上 TensorBoard 集成的更多信息，请查看此指南。

为了从这种集成中受益，huggingface_hub 提供了一个自定义日志记录器，可以将日志推送到 Hub。它作为 SummaryWriter 的直接替代品，无需额外代码。追踪仍然保存在本地，并且后台作业会定期将它们推送到 Hub。

HFSummaryWriter

类 huggingface_hub.HFSummaryWriter

< 源 >

( *args **kwargs )

参数

repo_id (str) — 日志将被推送到的仓库 ID。
logdir (str, 可选) — 日志将被写入的目录。如果未指定，底层 SummaryWriter 对象将创建一个本地目录。
commit_every (int 或 float, 可选) — 日志推送到 Hub 的频率（分钟）。默认为 5 分钟。
squash_history (bool, 可选) — 每次提交后是否压缩仓库历史记录。默认为 False。当仓库变得太大时，压缩提交有助于避免性能下降。
repo_type (str, 可选) — 日志将被推送到仓库的类型。默认为“model”。
repo_revision (str, 可选) — 日志将被推送到的仓库修订版本。默认为“main”。
repo_private (bool, 可选) — 是否将仓库设为私有。如果为 None（默认），则除非组织的默认设置为私有，否则仓库将为公共。如果仓库已存在，此值将被忽略。
path_in_repo (str, 可选) — 日志将被推送到仓库中文件夹的路径。默认为“tensorboard/”。
repo_allow_patterns (List[str] 或 str, 可选) — 上传中包含的模式列表。默认为 "*.tfevents.*"。有关更多详细信息，请查看上传指南。
repo_ignore_patterns (List[str] 或 str, 可选) — 上传中排除的模式列表。有关更多详细信息，请查看上传指南。
token (str, 可选) — 身份验证令牌。默认为存储的令牌。更多详细信息请参阅https://huggingface.co/settings/token
kwargs — 传递给 SummaryWriter 的额外关键字参数。

TensorBoard SummaryWriter 的封装器，用于将训练日志推送到 Hub。

数据在本地记录，然后异步推送到 Hub。将数据推送到 Hub 是在单独的线程中完成的，以避免阻塞训练脚本。特别是，如果上传因任何原因失败（例如连接问题），主脚本将不会中断。数据会自动每 commit_every 分钟（默认为每 5 分钟）推送到 Hub。

HFSummaryWriter 是实验性的。其 API 将来可能会在不事先通知的情况下更改。

示例

# Taken from https://pytorch.ac.cn/docs/stable/tensorboard.html
- from torch.utils.tensorboard import SummaryWriter
+ from huggingface_hub import HFSummaryWriter

import numpy as np

- writer = SummaryWriter()
+ writer = HFSummaryWriter(repo_id="username/my-trained-model")

for n_iter in range(100):
    writer.add_scalar('Loss/train', np.random.random(), n_iter)
    writer.add_scalar('Loss/test', np.random.random(), n_iter)
    writer.add_scalar('Accuracy/train', np.random.random(), n_iter)
    writer.add_scalar('Accuracy/test', np.random.random(), n_iter)

>>> from huggingface_hub import HFSummaryWriter

# Logs are automatically pushed every 15 minutes (5 by default) + when exiting the context manager
>>> with HFSummaryWriter(repo_id="test_hf_logger", commit_every=15) as logger:
...     logger.add_scalar("a", 1)
...     logger.add_scalar("b", 2)

< > 在 GitHub 上更新

Hub Python 库

TensorBoard 日志记录器

HFSummaryWriter

类 huggingface_hub.HFSummaryWriter