评价此页
★ ★ ★ ★ ★
intermediate/tensorboard_tutorial

使用 TensorBoard 可视化模型、数据和训练#

创建日期：2019年8月8日 | 最后更新：2025年9月10日 | 最后验证：2024年11月5日

在 60 分钟入门 (60 Minute Blitz) 教程中，我们展示了如何加载数据、将其输入到我们定义为 nn.Module 子类的模型中、使用训练数据对模型进行训练，以及在测试数据上进行测试。为了观察训练过程，我们在模型训练时打印出一些统计信息，以了解训练是否在正常进行。然而，我们可以做得更好：PyTorch 集成了 TensorBoard，这是一款专为可视化神经网络训练结果而设计的工具。本教程将使用 Fashion-MNIST 数据集（可通过 torchvision.datasets 读取到 PyTorch 中）来演示其部分功能。

在本教程中，我们将学习如何：

  1. 读取数据并进行适当的转换（与之前的教程几乎相同）。

  2. 设置 TensorBoard。

  3. 向 TensorBoard 写入信息。

  4. 使用 TensorBoard 检查模型架构。

  5. 使用 TensorBoard 以更少的代码创建上一教程中所述可视化内容的交互式版本。

具体针对第 5 点，我们将看到：

  • 几种检查训练数据的方法。

  • 如何在模型训练时追踪其性能。

  • 如何在模型训练完成后评估其性能。

我们将从与 CIFAR-10 教程类似的样板代码开始。

# imports
import matplotlib.pyplot as plt
import numpy as np

import torch
import torchvision
import torchvision.transforms as transforms

import torch.nn as nn
import torch.nn.functional as F
import torch.optim as optim

# transforms
transform = transforms.Compose(
    [transforms.ToTensor(),
    transforms.Normalize((0.5,), (0.5,))])

# datasets
trainset = torchvision.datasets.FashionMNIST('./data',
    download=True,
    train=True,
    transform=transform)
testset = torchvision.datasets.FashionMNIST('./data',
    download=True,
    train=False,
    transform=transform)

# dataloaders
trainloader = torch.utils.data.DataLoader(trainset, batch_size=4, shuffle=True)

testloader = torch.utils.data.DataLoader(testset, batch_size=4, shuffle=False)

# constant for classes
classes = ('T-shirt/top', 'Trouser', 'Pullover', 'Dress', 'Coat',
        'Sandal', 'Shirt', 'Sneaker', 'Bag', 'Ankle Boot')

# helper function to show an image
# (used in the `plot_classes_preds` function below)
def matplotlib_imshow(img, one_channel=False):
    if one_channel:
        img = img.mean(dim=0)
    img = img / 2 + 0.5     # unnormalize
    npimg = img.numpy()
    if one_channel:
        plt.imshow(npimg, cmap="Greys")
    else:
        plt.imshow(np.transpose(npimg, (1, 2, 0)))

我们将定义与该教程中类似的模型架构，仅做微小修改，以适应图像现在是单通道而非三通道，且尺寸为 28x28 而非 32x32 的事实。

class Net(nn.Module):
    def __init__(self):
        super(Net, self).__init__()
        self.conv1 = nn.Conv2d(1, 6, 5)
        self.pool = nn.MaxPool2d(2, 2)
        self.conv2 = nn.Conv2d(6, 16, 5)
        self.fc1 = nn.Linear(16 * 4 * 4, 120)
        self.fc2 = nn.Linear(120, 84)
        self.fc3 = nn.Linear(84, 10)

    def forward(self, x):
        x = self.pool(F.relu(self.conv1(x)))
        x = self.pool(F.relu(self.conv2(x)))
        x = x.view(-1, 16 * 4 * 4)
        x = F.relu(self.fc1(x))
        x = F.relu(self.fc2(x))
        x = self.fc3(x)
        return x


net = Net()

我们将定义与之前相同的 optimizer（优化器）和 criterion（准则）。

criterion = nn.CrossEntropyLoss()
optimizer = optim.SGD(net.parameters(), lr=0.001, momentum=0.9)

1. TensorBoard 设置#

现在我们将设置 TensorBoard，从 torch.utils 导入 tensorboard，并定义一个 SummaryWriter，这是我们向 TensorBoard 写入信息的关键对象。 

from torch.utils.tensorboard import SummaryWriter

# default `log_dir` is "runs" - we'll be more specific here
writer = SummaryWriter('runs/fashion_mnist_experiment_1')

请注意，仅这一行代码就会创建一个 runs/fashion_mnist_experiment_1 文件夹。

2. 向 TensorBoard 写入信息#

现在让我们使用 make_grid 将图像（具体来说是一个网格）写入我们的 TensorBoard。

# get some random training images
dataiter = iter(trainloader)
images, labels = next(dataiter)

# create grid of images
img_grid = torchvision.utils.make_grid(images)

# show images
matplotlib_imshow(img_grid, one_channel=True)

# write to tensorboard
writer.add_image('four_fashion_mnist_images', img_grid)

现在运行

PYTHONWARNINGS="ignore:pkg_resources is deprecated as an API:UserWarning" tensorboard --logdir=runs

命令行，然后导航至 https://:6006 应该就能看到如下内容。

../_static/img/tensorboard_first_view.png

现在你知道如何使用 TensorBoard 了！然而，这个例子在 Jupyter Notebook 中也可以完成——而 TensorBoard 的真正优势在于创建交互式可视化。我们接下来将介绍其中一种，并在教程结束前介绍更多内容。

3. 使用 TensorBoard 检查模型#

TensorBoard 的优势之一是能够可视化复杂的模型结构。让我们可视化我们构建的模型。 

writer.add_graph(net, images)
writer.close()

现在刷新 TensorBoard，你应该能看到一个看起来像这样的“Graphs”（图表）选项卡。 ../_static/img/tensorboard_model_viz.png

双击“Net”将其展开，查看构成模型的各个操作的详细视图。

TensorBoard 有一个非常实用的功能，可以将高维数据（如图像数据）可视化到低维空间；我们接下来将介绍这一功能。

4. 向 TensorBoard 添加“投影仪”（Projector）#

我们可以通过 add_embedding 方法可视化高维数据的低维表示。 

# helper function
def select_n_random(data, labels, n=100):
    '''
    Selects n random datapoints and their corresponding labels from a dataset
    '''
    assert len(data) == len(labels)

    perm = torch.randperm(len(data))
    return data[perm][:n], labels[perm][:n]

# select random images and their target indices
images, labels = select_n_random(trainset.data, trainset.targets)

# get the class labels for each image
class_labels = [classes[lab] for lab in labels]

# log embeddings
features = images.view(-1, 28 * 28)
writer.add_embedding(features,
                    metadata=class_labels,
                    label_img=images.unsqueeze(1))
writer.close()

现在在 TensorBoard 的“Projector”（投影仪）选项卡中，你可以看到这 100 张图像（每张都是 784 维的）被投影到三维空间中。此外，这是交互式的：你可以点击并拖动来旋转三维投影。最后，这里有几个让可视化更容易查看的小技巧：在左上角选择“color: label”，并启用“night mode”（夜间模式），因为背景是白色的，这样会让图像更容易看清。 ../_static/img/tensorboard_projector.png

现在我们已经彻底检查了数据，接下来让我们展示 TensorBoard 如何使追踪模型训练和评估变得更清晰，从训练开始。

5. 使用 TensorBoard 追踪模型训练#

在之前的例子中，我们只是每 2000 次迭代打印一次模型的运行损失。现在，我们将改用 plot_classes_preds 函数将运行损失记录到 TensorBoard，并查看模型的预测结果。 

# helper functions

def images_to_probs(net, images):
    '''
    Generates predictions and corresponding probabilities from a trained
    network and a list of images
    '''
    output = net(images)
    # convert output probabilities to predicted class
    _, preds_tensor = torch.max(output, 1)
    preds = np.squeeze(preds_tensor.numpy())
    return preds, [F.softmax(el, dim=0)[i].item() for i, el in zip(preds, output)]


def plot_classes_preds(net, images, labels):
    '''
    Generates matplotlib Figure using a trained network, along with images
    and labels from a batch, that shows the network's top prediction along
    with its probability, alongside the actual label, coloring this
    information based on whether the prediction was correct or not.
    Uses the "images_to_probs" function.
    '''
    preds, probs = images_to_probs(net, images)
    # plot the images in the batch, along with predicted and true labels
    fig = plt.figure(figsize=(12, 48))
    for idx in np.arange(4):
        ax = fig.add_subplot(1, 4, idx+1, xticks=[], yticks=[])
        matplotlib_imshow(images[idx], one_channel=True)
        ax.set_title("{0}, {1:.1f}%\n(label: {2})".format(
            classes[preds[idx]],
            probs[idx] * 100.0,
            classes[labels[idx]]),
                    color=("green" if preds[idx]==labels[idx].item() else "red"))
    return fig

最后，让我们使用与之前教程相同的模型训练代码来训练模型，但每 1000 个批次将结果写入 TensorBoard 而不是打印到控制台；这是通过 add_scalar 函数完成的。

此外，在训练过程中，我们还将生成一张图像，显示模型对该批次中包含的四张图像的预测结果与实际结果的对比。 

running_loss = 0.0
for epoch in range(1):  # loop over the dataset multiple times

    for i, data in enumerate(trainloader, 0):

        # get the inputs; data is a list of [inputs, labels]
        inputs, labels = data

        # zero the parameter gradients
        optimizer.zero_grad()

        # forward + backward + optimize
        outputs = net(inputs)
        loss = criterion(outputs, labels)
        loss.backward()
        optimizer.step()

        running_loss += loss.item()
        if i % 1000 == 999:    # every 1000 mini-batches...

            # ...log the running loss
            writer.add_scalar('training loss',
                            running_loss / 1000,
                            epoch * len(trainloader) + i)

            # ...log a Matplotlib Figure showing the model's predictions on a
            # random mini-batch
            writer.add_figure('predictions vs. actuals',
                            plot_classes_preds(net, inputs, labels),
                            global_step=epoch * len(trainloader) + i)
            running_loss = 0.0
print('Finished Training')

你现在可以查看 scalars（标量）选项卡，查看在 15,000 次训练迭代中绘制的运行损失。 ../_static/img/tensorboard_scalar_runs.png

此外，我们可以查看模型在学习过程中对任意批次做出的预测。参见“Images”（图像）选项卡，并在“predictions vs. actuals”（预测与实际对比）可视化下方向下滚动查看；这向我们展示了，例如在仅经过 3000 次训练迭代后，模型已经能够区分视觉上截然不同的类别，如衬衫、运动鞋和外套，尽管此时它还不如训练后期那样自信。 ../_static/img/tensorboard_images.png

在之前的教程中，我们查看了模型训练完成后的每类准确率；在这里，我们将使用 TensorBoard 为每个类别绘制精确率-召回率曲线（此处有很好的解释：此处）。

6. 使用 TensorBoard 评估训练后的模型#

# 1. gets the probability predictions in a test_size x num_classes Tensor
# 2. gets the preds in a test_size Tensor
# takes ~10 seconds to run
class_probs = []
class_label = []
with torch.no_grad():
    for data in testloader:
        images, labels = data
        output = net(images)
        class_probs_batch = [F.softmax(el, dim=0) for el in output]

        class_probs.append(class_probs_batch)
        class_label.append(labels)

test_probs = torch.cat([torch.stack(batch) for batch in class_probs])
test_label = torch.cat(class_label)

# helper function
def add_pr_curve_tensorboard(class_index, test_probs, test_label, global_step=0):
    '''
    Takes in a "class_index" from 0 to 9 and plots the corresponding
    precision-recall curve
    '''
    tensorboard_truth = test_label == class_index
    tensorboard_probs = test_probs[:, class_index]

    writer.add_pr_curve(classes[class_index],
                        tensorboard_truth,
                        tensorboard_probs,
                        global_step=global_step)
    writer.close()

# plot all the pr curves
for i in range(len(classes)):
    add_pr_curve_tensorboard(i, test_probs, test_label)

你现在将看到一个“PR Curves”（PR 曲线）选项卡，其中包含每个类别的精确率-召回率曲线。随意查看一下；你会发现模型在某些类别上的“曲线下面积”接近 100%，而在其他类别上这个面积则较低。 ../_static/img/tensorboard_pr_curves.png

这就是对 TensorBoard 以及 PyTorch 与其集成的介绍。当然，你可以在 Jupyter Notebook 中完成 TensorBoard 能做的所有事情，但使用 TensorBoard，你可以默认获得交互式的视觉效果。

在此页面上
PyTorch 库