torch.utils.tensorboard#

创建于：2019年4月25日 | 最后更新于：2022年3月10日

在深入之前，更多关于 TensorBoard 的详情请参见 https://tensorflowcn.cn/tensorboard/

安装 TensorBoard 后，您可以使用这些工具将 PyTorch 模型和指标记录到一个目录中，以便在 TensorBoard UI 中进行可视化。对于 PyTorch 模型和张量，以及 Caffe2 网络和 blob，都支持标量、图像、直方图、图和嵌入可视化。

SummaryWriter 类是您记录数据以供 TensorBoard 消耗和可视化使用的主要入口。例如：

import torch
import torchvision
from torch.utils.tensorboard import SummaryWriter
from torchvision import datasets, transforms

# Writer will output to ./runs/ directory by default
writer = SummaryWriter()

transform = transforms.Compose([transforms.ToTensor(), transforms.Normalize((0.5,), (0.5,))])
trainset = datasets.MNIST('mnist_train', train=True, download=True, transform=transform)
trainloader = torch.utils.data.DataLoader(trainset, batch_size=64, shuffle=True)
model = torchvision.models.resnet50(False)
# Have ResNet model take in grayscale rather than RGB
model.conv1 = torch.nn.Conv2d(1, 64, kernel_size=7, stride=2, padding=3, bias=False)
images, labels = next(iter(trainloader))

grid = torchvision.utils.make_grid(images)
writer.add_image('images', grid, 0)
writer.add_graph(model, images)
writer.close()

这之后可以用 TensorBoard 进行可视化，TensorBoard 的安装和运行可以通过以下命令完成：

pip install tensorboard
tensorboard --logdir=runs

一个实验可以记录大量信息。为了避免 UI 混乱并更好地聚类结果，我们可以通过分层命名来组合图表。例如，“Loss/train” 和 “Loss/test” 将会一起分组，而“Accuracy/train” 和 “Accuracy/test” 将会在 TensorBoard 界面中分开分组。

from torch.utils.tensorboard import SummaryWriter
import numpy as np

writer = SummaryWriter()

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)

预期结果

class torch.utils.tensorboard.writer.SummaryWriter(log_dir=None, comment='', purge_step=None, max_queue=10, flush_secs=120, filename_suffix='')[source]#

直接将条目写入事件文件，供 TensorBoard 使用。

SummaryWriter 类提供了一个高级 API，用于在给定目录中创建事件文件，并向其中添加摘要和事件。该类异步更新文件内容。这使得训练程序可以从训练循环中直接调用方法向文件添加数据，而不会减慢训练速度。

__init__(log_dir=None, comment='', purge_step=None, max_queue=10, flush_secs=120, filename_suffix='')[source]#

创建一个 SummaryWriter，它将把事件和摘要写入事件文件。

参数

log_dir (str) – 保存目录位置。默认为 runs/CURRENT_DATETIME_HOSTNAME，每次运行都会改变。使用分层文件夹结构可以轻松比较不同运行。例如，为每个新实验传入‘runs/exp1’、‘runs/exp2’等，以便跨实验进行比较。
comment (str) – 添加到默认 log_dir 的注释 log_dir 后缀。如果指定了 log_dir，则此参数无效。
purge_step (int) – 当日志在步骤 $T+X$ 处崩溃并从步骤 $T$ 重新开始时，所有全局步长大于或等于 $T$ 的事件将被清除并隐藏在 TensorBoard 中。请注意，崩溃后恢复的实验应该具有相同的 log_dir。
max_queue (int) – 待处理事件和摘要队列的大小，在其中一个‘add’调用强制刷新到磁盘之前。默认为十项。
flush_secs (int) – 待处理事件和摘要刷新到磁盘的频率（秒）。默认为每两分钟一次。
filename_suffix (str) – 添加到 log_dir 目录中所有事件文件名中的后缀。更多关于文件名构建的细节请参见 tensorboard.summary.writer.event_file_writer.EventFileWriter。

示例

from torch.utils.tensorboard import SummaryWriter

# create a summary writer with automatically generated folder name.
writer = SummaryWriter()
# folder location: runs/May04_22-14-54_s-MacBook-Pro.local/

# create a summary writer using the specified folder name.
writer = SummaryWriter("my_experiment")
# folder location: my_experiment

# create a summary writer with comment appended.
writer = SummaryWriter(comment="LR_0.1_BATCH_16")
# folder location: runs/May04_22-14-54_s-MacBook-Pro.localLR_0.1_BATCH_16/

add_scalar(tag, scalar_value, global_step=None, walltime=None, new_style=False, double_precision=False)[source]#

向摘要添加标量数据。

参数

tag (str) – 数据标识符
scalar_value (float 或 string/blobname) – 要保存的值
global_step (int) – 要记录的全局步长值
walltime (float) – 可选，用事件的 epoch 秒数覆盖默认 walltime (time.time())
new_style (boolean) – 是否使用新样式（tensor 字段）或旧样式（simple_value 字段）。新样式可以加快数据加载。

示例

from torch.utils.tensorboard import SummaryWriter
writer = SummaryWriter()
x = range(100)
for i in x:
    writer.add_scalar('y=2x', i * 2, i)
writer.close()

预期结果

add_scalars(main_tag, tag_scalar_dict, global_step=None, walltime=None)[source]#

向摘要添加多个标量数据。

参数

main_tag (str) – 标签的父名称
tag_scalar_dict (dict) – 键值对，存储标签和对应的值
global_step (int) – 要记录的全局步长值
walltime (float) – 可选，用事件的 epoch 秒数覆盖默认 walltime (time.time())

示例

from torch.utils.tensorboard import SummaryWriter
writer = SummaryWriter()
r = 5
for i in range(100):
    writer.add_scalars('run_14h', {'xsinx':i*np.sin(i/r),
                                    'xcosx':i*np.cos(i/r),
                                    'tanx': np.tan(i/r)}, i)
writer.close()
# This call adds three values to the same scalar plot with the tag
# 'run_14h' in TensorBoard's scalar section.

预期结果

add_histogram(tag, values, global_step=None, bins='tensorflow', walltime=None, max_bins=None)[source]#

向摘要添加直方图。

参数

tag (str) – 数据标识符
values (torch.Tensor, numpy.ndarray, 或 string/blobname) – 用于构建直方图的值
global_step (int) – 要记录的全局步长值
bins (str) – {‘tensorflow’,’auto’, ‘fd’, …} 中的一个。这决定了如何制作 bin。您可以在以下位置找到其他选项：https://numpy.com.cn/doc/stable/reference/generated/numpy.histogram.html
walltime (float) – 可选，用事件的 epoch 秒数覆盖默认 walltime (time.time())

示例

from torch.utils.tensorboard import SummaryWriter
import numpy as np
writer = SummaryWriter()
for i in range(10):
    x = np.random.random(1000)
    writer.add_histogram('distribution centers', x + i, i)
writer.close()

预期结果

add_image(tag, img_tensor, global_step=None, walltime=None, dataformats='CHW')[source]#

向摘要添加图像数据。

请注意，这需要 pillow 包。

参数

tag (str) – 数据标识符
img_tensor (torch.Tensor, numpy.ndarray, 或 string/blobname) – 图像数据
global_step (int) – 要记录的全局步长值
walltime (float) – 可选，用事件的 epoch 秒数覆盖默认 walltime (time.time())
dataformats (str) – 图像数据格式规范，形式为 CHW、HWC、HW、WH 等。

形状: img_tensor：默认为 $(3, H, W)$ 。您可以使用 torchvision.utils.make_grid() 将一批张量转换为 3xHxW 格式，或调用 add_images 并让我们处理。

示例

from torch.utils.tensorboard import SummaryWriter
import numpy as np
img = np.zeros((3, 100, 100))
img[0] = np.arange(0, 10000).reshape(100, 100) / 10000
img[1] = 1 - np.arange(0, 10000).reshape(100, 100) / 10000

img_HWC = np.zeros((100, 100, 3))
img_HWC[:, :, 0] = np.arange(0, 10000).reshape(100, 100) / 10000
img_HWC[:, :, 1] = 1 - np.arange(0, 10000).reshape(100, 100) / 10000

writer = SummaryWriter()
writer.add_image('my_image', img, 0)

# If you have non-default dimension setting, set the dataformats argument.
writer.add_image('my_image_HWC', img_HWC, 0, dataformats='HWC')
writer.close()

预期结果

add_images(tag, img_tensor, global_step=None, walltime=None, dataformats='NCHW')[source]#

向摘要添加批量图像数据。

请注意，这需要 pillow 包。

参数

tag (str) – 数据标识符
img_tensor (torch.Tensor, numpy.ndarray, 或 string/blobname) – 图像数据
global_step (int) – 要记录的全局步长值
walltime (float) – 可选，用事件的 epoch 秒数覆盖默认 walltime (time.time())
dataformats (str) – 图像数据格式规范，形式为 NCHW、NHWC、CHW、HWC、HW、WH 等。

形状: img_tensor：默认为 $(N, 3, H, W)$ 。如果指定了 dataformats，则可以接受其他形状。例如 NCHW 或 NHWC。

示例

from torch.utils.tensorboard import SummaryWriter
import numpy as np

img_batch = np.zeros((16, 3, 100, 100))
for i in range(16):
    img_batch[i, 0] = np.arange(0, 10000).reshape(100, 100) / 10000 / 16 * i
    img_batch[i, 1] = (1 - np.arange(0, 10000).reshape(100, 100) / 10000) / 16 * i

writer = SummaryWriter()
writer.add_images('my_image_batch', img_batch, 0)
writer.close()

预期结果

add_figure(tag, figure, global_step=None, close=True, walltime=None)[source]#

将 matplotlib 图渲染成图像并添加到摘要中。

请注意，这需要 matplotlib 包。

参数

tag (str) – 数据标识符
figure (Union[Figure, list of 'Figure']) – 图形或图形列表
global_step (Optional[int]) – 要记录的全局步长值
close (bool) – 自动关闭图形的标志
walltime (Optional[float]) – 可选，用事件的 epoch 秒数覆盖默认 walltime (time.time())

add_video(tag, vid_tensor, global_step=None, fps=4, walltime=None)[source]#

向摘要添加视频数据。

请注意，这需要 moviepy 包。

参数

tag (str) – 数据标识符
vid_tensor (torch.Tensor) – 视频数据
global_step (int) – 要记录的全局步长值
fps (float 或 int) – 每秒帧数
walltime (float) – 可选，用事件的 epoch 秒数覆盖默认 walltime (time.time())

形状: vid_tensor： $(N, T, C, H, W)$ 。对于 uint8 类型，值应在 [0, 255] 范围内；对于 float 类型，值应在 [0, 1] 范围内。

add_audio(tag, snd_tensor, global_step=None, sample_rate=44100, walltime=None)[source]#

向摘要添加音频数据。

参数

tag (str) – 数据标识符
snd_tensor (torch.Tensor) – 声音数据
global_step (int) – 要记录的全局步长值
sample_rate (int) – 采样率（Hz）
walltime (float) – 可选，用事件的 epoch 秒数覆盖默认 walltime (time.time())

形状: snd_tensor： $(1, L)$ 。值应在 [-1, 1] 之间。

add_text(tag, text_string, global_step=None, walltime=None)[source]#

向摘要添加文本数据。

参数

tag (str) – 数据标识符
text_string (str) – 要保存的字符串
global_step (int) – 要记录的全局步长值
walltime (float) – 可选，用事件的 epoch 秒数覆盖默认 walltime (time.time())

示例

writer.add_text('lstm', 'This is an lstm', 0)
writer.add_text('rnn', 'This is an rnn', 10)

add_graph(model, input_to_model=None, verbose=False, use_strict_trace=True)[source]#

向摘要添加图数据。

参数

model (torch.nn.Module) – 要绘制的模型。
input_to_model (torch.Tensor 或 list of torch.Tensor) – 要馈送的变量或变量元组。
verbose (bool) – 是否在控制台中打印图结构。
use_strict_trace (bool) – 是否将关键字参数 strict 传递给 torch.jit.trace。当您希望追踪器记录可变容器类型（列表、字典）时，请传入 False。

add_embedding(mat, metadata=None, label_img=None, global_step=None, tag='default', metadata_header=None)[source]#

向摘要添加嵌入投影仪数据。

参数

mat (torch.Tensor 或 numpy.ndarray) – 一个矩阵，每行是数据点的特征向量
metadata (list) – 一个标签列表，每个元素都将被转换为字符串
label_img (torch.Tensor) – 与每个数据点对应的图像
global_step (int) – 要记录的全局步长值
tag (str) – 嵌入的名称
metadata_header (list) – 多列元数据的标题列表。如果提供，每个元数据都必须是一个列表，其中包含与标题对应的值。

形状

mat： $(N, D)$ ，其中 N 是数据数量，D 是特征维度

label_img： $(N, C, H, W)$

示例

import keyword
import torch
meta = []
while len(meta)<100:
    meta = meta+keyword.kwlist # get some strings
meta = meta[:100]

for i, v in enumerate(meta):
    meta[i] = v+str(i)

label_img = torch.rand(100, 3, 10, 32)
for i in range(100):
    label_img[i]*=i/100.0

writer.add_embedding(torch.randn(100, 5), metadata=meta, label_img=label_img)
writer.add_embedding(torch.randn(100, 5), label_img=label_img)
writer.add_embedding(torch.randn(100, 5), metadata=meta)

注意

分类（即非数值）元数据最多不能有 50 个唯一值，如果它们将用于嵌入投影仪中的着色。

add_pr_curve(tag, labels, predictions, global_step=None, num_thresholds=127, weights=None, walltime=None)[source]#

添加精确率-召回率曲线。

绘制精确率-召回率曲线可以帮助您了解模型在不同阈值设置下的性能。使用此函数，您可以为每个目标提供真实标签（T/F）和预测置信度（通常是模型的输出）。TensorBoard UI 将允许您交互式地选择阈值。

参数

tag (str) – 数据标识符
labels (torch.Tensor, numpy.ndarray, 或 string/blobname) – 真实数据。每个元素的二元标签。
predictions (torch.Tensor, numpy.ndarray, 或 string/blobname) – 元素被归类为真的概率。值应在 [0, 1] 范围内
global_step (int) – 要记录的全局步长值
num_thresholds (int) – 用于绘制曲线的阈值数量。
walltime (float) – 可选，用事件的 epoch 秒数覆盖默认 walltime (time.time())

示例

from torch.utils.tensorboard import SummaryWriter
import numpy as np
labels = np.random.randint(2, size=100)  # binary label
predictions = np.random.rand(100)
writer = SummaryWriter()
writer.add_pr_curve('pr_curve', labels, predictions, 0)
writer.close()

add_custom_scalars(layout)[source]#

通过在‘scalars’中收集图表标签来创建特殊图表。

注意：此函数只能为每个 SummaryWriter() 对象调用一次。

因为它只为 tensorboard 提供元数据，所以可以在训练循环之前或之后调用该函数。

参数: layout (dict) – {categoryName: *charts*}，其中 *charts* 也是一个字典 {chartName: *ListOfProperties*}。*ListOfProperties* 中的第一个元素是图表的类型（**Multiline** 或 **Margin** 之一），第二个元素应包含您在 add_scalar 函数中使用的标签列表，这些标签将被收集到新图表中。

示例

layout = {'Taiwan':{'twse':['Multiline',['twse/0050', 'twse/2330']]},
             'USA':{ 'dow':['Margin',   ['dow/aaa', 'dow/bbb', 'dow/ccc']],
                  'nasdaq':['Margin',   ['nasdaq/aaa', 'nasdaq/bbb', 'nasdaq/ccc']]}}

writer.add_custom_scalars(layout)

add_mesh(tag, vertices, colors=None, faces=None, config_dict=None, global_step=None, walltime=None)[source]#

向 TensorBoard 添加网格或 3D 点云。

该可视化基于 Three.js，因此允许用户与渲染的对象进行交互。除了顶点、面等基本定义外，用户还可以提供相机参数、光照条件等。请查看 https://threejs.org/docs/index.html#manual/en/introduction/Creating-a-scene 获取高级用法。

参数

tag (str) – 数据标识符
vertices (torch.Tensor) – 顶点 3D 坐标列表。
colors (torch.Tensor) – 每个顶点的颜色
faces (torch.Tensor) – 每个三角形内顶点的索引。（可选）
config_dict – 包含 ThreeJS 类名和配置的字典。
global_step (int) – 要记录的全局步长值
walltime (float) – 可选，用事件的 epoch 秒数覆盖默认 walltime (time.time())

形状

vertices： $(B, N, 3)$ 。（批次，顶点数，通道）

colors： $(B, N, 3)$ 。对于 uint8 类型，值应在 [0, 255] 范围内；对于 float 类型，值应在 [0, 1] 范围内。

faces： $(B, N, 3)$ 。对于 uint8 类型，值应在 [0, number_of_vertices] 范围内。

示例

from torch.utils.tensorboard import SummaryWriter
vertices_tensor = torch.as_tensor([
    [1, 1, 1],
    [-1, -1, 1],
    [1, -1, -1],
    [-1, 1, -1],
], dtype=torch.float).unsqueeze(0)
colors_tensor = torch.as_tensor([
    [255, 0, 0],
    [0, 255, 0],
    [0, 0, 255],
    [255, 0, 255],
], dtype=torch.int).unsqueeze(0)
faces_tensor = torch.as_tensor([
    [0, 2, 3],
    [0, 3, 1],
    [0, 1, 2],
    [1, 3, 2],
], dtype=torch.int).unsqueeze(0)

writer = SummaryWriter()
writer.add_mesh('my_mesh', vertices=vertices_tensor, colors=colors_tensor, faces=faces_tensor)

writer.close()

add_hparams(hparam_dict, metric_dict, hparam_domain_discrete=None, run_name=None, global_step=None)[source]#

添加一组要在 TensorBoard 中进行比较的超参数。

参数

hparam_dict (dict) – 字典中的每个键值对是超参数的名称及其对应的值。值的类型可以是 bool、string、float、int 或 None 之一。
metric_dict (dict) – 字典中的每个键值对是指标的名称及其对应的值。请注意，此处使用的键在 tensorboard 记录中应是唯一的。否则，您通过 add_scalar 添加的值将显示在 hparam 插件中。在大多数情况下，这是不希望的。
hparam_domain_discrete – (Optional[Dict[str, List[Any]]]) 一个字典，其中包含超参数的名称以及它们可以具有的所有离散值
run_name (str) – 运行的名称，将作为 logdir 的一部分。如果未指定，将使用当前时间戳。
global_step (int) – 要记录的全局步长值

示例

from torch.utils.tensorboard import SummaryWriter
with SummaryWriter() as w:
    for i in range(5):
        w.add_hparams({'lr': 0.1*i, 'bsize': i},
                      {'hparam/accuracy': 10*i, 'hparam/loss': 10*i})

预期结果

flush()[source]#

将事件文件刷新到磁盘。

调用此方法可确保所有待处理事件都已写入磁盘。

close()[source]#

torch.utils.tensorboard#

文档

教程

资源