使用PyTorch C++前端

创建于：2019年1月15日 | 最后更新：2024年12月18日 | 最后验证：2024年11月5日

PyTorch C++前端是PyTorch机器学习框架的纯C++接口。虽然PyTorch的主要接口自然是Python，但这个Python API建立在一个庞大的C++代码库之上，提供了基础的数据结构和功能，如张量和自动微分。C++前端暴露了一个纯C++11 API，扩展了这个底层的C++代码库，提供了机器学习训练和推理所需的工具。这包括一个内置的常见神经网络建模组件集合；一个用于扩展这个集合的自定义模块的API；一个包含流行优化算法（如随机梯度下降）的库；一个带有API的并行数据加载器，用于定义和加载数据集；序列化例程等等。

本教程将引导您完成一个使用C++前端训练模型的端到端示例。具体来说，我们将训练一个DCGAN——一种生成模型——来生成MNIST数字的图像。虽然从概念上讲这是一个简单的示例，但它应该足以让您快速了解PyTorch C++前端，并激发您训练更复杂模型的兴趣。我们将从一些激励性的文字开始，解释为什么您会想要使用C++前端，然后直接进入定义和训练我们的模型。

提示

观看这个来自CppCon 2018的闪电演讲，快速（且幽默地）了解C++前端。

提示

This note 提供了对C++前端的组件和设计理念的全面概述。

提示

PyTorch C++ 生态系统的文档可在 https://pytorch.org/cppdocs 找到。在那里你可以找到高层次的描述以及 API 级别的文档。

动机

在我们开始GANs和MNIST数字的激动人心的旅程之前，让我们退一步讨论为什么你会想要使用C++前端而不是Python前端。我们（PyTorch团队）创建了C++前端，以便在无法使用Python或Python不是合适工具的环境中进行研究。这些环境的例子包括：

• 低延迟系统：你可能想在一个纯C++游戏引擎中进行强化学习研究，该引擎具有高帧率和低延迟要求。与Python库相比，使用纯C++库更适合这种环境。由于Python解释器的速度较慢，Python可能根本无法处理这种情况。

• 高度多线程环境：由于全局解释器锁（GIL），Python 无法同时运行多个系统线程。多进程是一种替代方案，但可扩展性较差且存在显著缺点。C++ 没有这样的限制，线程易于使用和创建。需要大量并行化的模型，如深度神经进化中使用的模型，可以从中受益。

• 现有的C++代码库：您可能是一个现有C++应用程序的所有者，该应用程序可能在后端服务器中提供网页服务，也可能在照片编辑软件中渲染3D图形，并且希望将机器学习方法集成到您的系统中。C++前端允许您继续使用C++，并避免在Python和C++之间来回绑定的麻烦，同时保留传统PyTorch（Python）体验的大部分灵活性和直观性。

C++前端并不是为了与Python前端竞争。它的目的是作为补充。我们知道研究人员和工程师都喜欢PyTorch，因为它简单、灵活且具有直观的API。我们的目标是确保您可以在所有可能的环境中利用这些核心设计原则，包括上述环境。如果其中一种场景很好地描述了您的使用情况，或者您只是感兴趣或好奇，请继续阅读，我们将在接下来的段落中详细探讨C++前端。

提示

C++前端试图提供一个尽可能接近Python前端的API。如果你对Python前端有经验，并且曾经问过自己“如何在C++前端中做X？”，那么按照你在Python中的方式编写代码，通常情况下，C++中可用的函数和方法与Python中的相同（只需记住将点替换为双冒号）。

编写一个基础应用程序

让我们从编写一个最小的C++应用程序开始，以验证我们在设置和构建环境方面是一致的。首先，你需要获取一份LibTorch发行版的副本——这是我们预构建的zip存档，其中包含了使用C++前端所需的所有相关头文件、库和CMake构建文件。LibTorch发行版可以在PyTorch网站上下载，适用于Linux、MacOS和Windows。本教程的其余部分将假设一个基本的Ubuntu Linux环境，但你也可以在MacOS或Windows上跟随。

提示

关于安装C++版本的PyTorch的说明更详细地描述了以下步骤。

提示

在Windows上，调试版和发布版的构建不兼容ABI。如果您计划在调试模式下构建您的项目，请尝试使用LibTorch的调试版本。同时，请确保在下面的cmake --build .行中指定正确的配置。

第一步是通过从PyTorch网站获取的链接在本地下载LibTorch发行版。对于一个普通的Ubuntu Linux环境，这意味着运行：

# If you need e.g. CUDA 9.0 support, please replace "cpu" with "cu90" in the URL below.
wget https://download.pytorch.org/libtorch/nightly/cpu/libtorch-shared-with-deps-latest.zip
unzip libtorch-shared-with-deps-latest.zip

接下来，让我们编写一个名为 dcgan.cpp 的小型 C++ 文件，该文件包含 torch/torch.h，目前仅打印出一个三乘三的单位矩阵：

#include <torch/torch.h>
#include <iostream>

int main() {
  torch::Tensor tensor = torch::eye(3);
  std::cout << tensor << std::endl;
}

为了构建这个小应用程序以及我们稍后将使用的完整训练脚本，我们将使用这个CMakeLists.txt文件：

cmake_minimum_required(VERSION 3.0 FATAL_ERROR)
project(dcgan)

find_package(Torch REQUIRED)

add_executable(dcgan dcgan.cpp)
target_link_libraries(dcgan "${TORCH_LIBRARIES}")
set_property(TARGET dcgan PROPERTY CXX_STANDARD 14)

注意

虽然CMake是LibTorch推荐的构建系统，但它并不是一个硬性要求。你也可以使用Visual Studio项目文件、QMake、普通的Makefiles或任何你觉得舒适的构建环境。然而，我们并不提供开箱即用的支持。

请注意上面CMake文件中的第4行：find_package(Torch REQUIRED)。 这指示CMake查找LibTorch库的构建配置。 为了让CMake知道在哪里找到这些文件，我们必须在调用cmake时设置CMAKE_PREFIX_PATH。在我们这样做之前，让我们同意以下dcgan应用程序的目录结构：

dcgan/
  CMakeLists.txt
  dcgan.cpp

此外，我将解压后的LibTorch发行版的路径称为 /path/to/libtorch。请注意，这必须是一个绝对路径。特别是，将CMAKE_PREFIX_PATH设置为类似../../libtorch的内容会以意想不到的方式出错。相反，使用$PWD/../../libtorch来获取相应的绝对路径。现在，我们准备好构建我们的应用程序了：

root@fa350df05ecf:/home# mkdir build
root@fa350df05ecf:/home# cd build
root@fa350df05ecf:/home/build# cmake -DCMAKE_PREFIX_PATH=/path/to/libtorch ..
-- The C compiler identification is GNU 5.4.0
-- The CXX compiler identification is GNU 5.4.0
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Looking for pthread.h
-- Looking for pthread.h - found
-- Looking for pthread_create
-- Looking for pthread_create - not found
-- Looking for pthread_create in pthreads
-- Looking for pthread_create in pthreads - not found
-- Looking for pthread_create in pthread
-- Looking for pthread_create in pthread - found
-- Found Threads: TRUE
-- Found torch: /path/to/libtorch/lib/libtorch.so
-- Configuring done
-- Generating done
-- Build files have been written to: /home/build
root@fa350df05ecf:/home/build# cmake --build . --config Release
Scanning dependencies of target dcgan
[ 50%] Building CXX object CMakeFiles/dcgan.dir/dcgan.cpp.o
[100%] Linking CXX executable dcgan
[100%] Built target dcgan

在上面，我们首先在我们的dcgan目录中创建了一个build文件夹， 进入这个文件夹，运行cmake命令以生成必要的构建 （Make）文件，最后通过运行cmake --build . --config Release成功编译了项目。我们现在已经准备好执行我们的最小二进制文件 并完成本节关于基本项目配置的内容：

root@fa350df05ecf:/home/build# ./dcgan
1  0  0
0  1  0
0  0  1
[ Variable[CPUFloatType]{3,3} ]

对我来说，这看起来像是一个单位矩阵！

定义神经网络模型

现在我们已经配置好了基本环境，可以深入本教程中更有趣的部分了。首先，我们将讨论如何在C++前端中定义模块并与之交互。我们将从基本的小规模示例模块开始，然后使用C++前端提供的内置模块库实现一个完整的GAN。

模块API基础

与Python接口一致，基于C++前端的神经网络由可重用的构建块组成，这些构建块称为模块。有一个基础模块类，所有其他模块都从中派生。在Python中，这个类是torch.nn.Module，在C++中是torch::nn::Module。除了实现模块封装的算法的forward()方法外，模块通常包含三种子对象中的任何一种：参数、缓冲区和子模块。

参数和缓冲区以张量的形式存储状态。参数记录梯度，而缓冲区不记录。参数通常是神经网络的可训练权重。缓冲区的例子包括批量归一化的均值和方差。为了重用特定的逻辑和状态块，PyTorch API 允许模块嵌套。嵌套的模块被称为子模块。

参数、缓冲区和子模块必须显式注册。一旦注册，就可以使用像parameters()或buffers()这样的方法来检索整个（嵌套）模块层次结构中的所有参数的容器。同样，像to(...)这样的方法，例如to(torch::kCUDA)将所有参数和缓冲区从CPU移动到CUDA内存，适用于整个模块层次结构。

定义模块并注册参数

将这些词语转化为代码，让我们考虑这个用Python接口编写的简单模块：

import torch

class Net(torch.nn.Module):
  def __init__(self, N, M):
    super(Net, self).__init__()
    self.W = torch.nn.Parameter(torch.randn(N, M))
    self.b = torch.nn.Parameter(torch.randn(M))

  def forward(self, input):
    return torch.addmm(self.b, input, self.W)

在C++中，它看起来像这样：

#include <torch/torch.h>

struct Net : torch::nn::Module {
  Net(int64_t N, int64_t M) {
    W = register_parameter("W", torch::randn({N, M}));
    b = register_parameter("b", torch::randn(M));
  }
  torch::Tensor forward(torch::Tensor input) {
    return torch::addmm(b, input, W);
  }
  torch::Tensor W, b;
};

就像在Python中一样，我们定义了一个名为Net的类（为了简单起见，这里使用struct而不是class），并从模块基类派生它。在构造函数内部，我们使用torch::randn创建张量，就像我们在Python中使用torch.randn一样。一个有趣的区别是我们如何注册参数。在Python中，我们用torch.nn.Parameter类包装张量，而在C++中，我们必须通过register_parameter方法传递张量。这样做的原因是Python API可以检测到属性是torch.nn.Parameter类型，并自动注册这些张量。在C++中，反射非常有限，因此提供了一种更传统（且不那么神奇）的方法。

注册子模块和遍历模块层次结构

以同样的方式我们可以注册参数，我们也可以注册子模块。在Python中，当子模块被分配为模块的属性时，它们会自动被检测并注册：

class Net(torch.nn.Module):
  def __init__(self, N, M):
      super(Net, self).__init__()
      # Registered as a submodule behind the scenes
      self.linear = torch.nn.Linear(N, M)
      self.another_bias = torch.nn.Parameter(torch.rand(M))

  def forward(self, input):
    return self.linear(input) + self.another_bias

这允许，例如，使用parameters()方法递归访问我们模块层次结构中的所有参数：

>>> net = Net(4, 5)
>>> print(list(net.parameters()))
[Parameter containing:
tensor([0.0808, 0.8613, 0.2017, 0.5206, 0.5353], requires_grad=True), Parameter containing:
tensor([[-0.3740, -0.0976, -0.4786, -0.4928],
        [-0.1434,  0.4713,  0.1735, -0.3293],
        [-0.3467, -0.3858,  0.1980,  0.1986],
        [-0.1975,  0.4278, -0.1831, -0.2709],
        [ 0.3730,  0.4307,  0.3236, -0.0629]], requires_grad=True), Parameter containing:
tensor([ 0.2038,  0.4638, -0.2023,  0.1230, -0.0516], requires_grad=True)]

要在C++中注册子模块，使用恰当命名的register_module()方法来注册一个模块，例如torch::nn::Linear：

struct Net : torch::nn::Module {
  Net(int64_t N, int64_t M)
      : linear(register_module("linear", torch::nn::Linear(N, M))) {
    another_bias = register_parameter("b", torch::randn(M));
  }
  torch::Tensor forward(torch::Tensor input) {
    return linear(input) + another_bias;
  }
  torch::nn::Linear linear;
  torch::Tensor another_bias;
};

提示

你可以在这里的torch::nn命名空间文档中找到所有可用的内置模块的完整列表，例如torch::nn::Linear、torch::nn::Dropout或torch::nn::Conv2d。

上述代码的一个微妙之处在于为什么子模块是在构造函数的初始化列表中创建的，而参数是在构造函数体内创建的。这有一个很好的理由，我们将在下面关于C++前端的所有权模型部分中讨论。然而，最终的结果是我们可以像在Python中一样递归地访问我们的模块树的参数。调用parameters()会返回一个std::vector，我们可以对其进行迭代：

int main() {
  Net net(4, 5);
  for (const auto& p : net.parameters()) {
    std::cout << p << std::endl;
  }
}

打印如下：

root@fa350df05ecf:/home/build# ./dcgan
0.0345
1.4456
-0.6313
-0.3585
-0.4008
[ Variable[CPUFloatType]{5} ]
-0.1647  0.2891  0.0527 -0.0354
0.3084  0.2025  0.0343  0.1824
-0.4630 -0.2862  0.2500 -0.0420
0.3679 -0.1482 -0.0460  0.1967
0.2132 -0.1992  0.4257  0.0739
[ Variable[CPUFloatType]{5,4} ]
0.01 *
3.6861
-10.1166
-45.0333
7.9983
-20.0705
[ Variable[CPUFloatType]{5} ]

与Python中的三个参数一样。为了也能看到这些参数的名称，C++ API提供了一个named_parameters()方法，它返回一个OrderedDict，就像在Python中一样：

Net net(4, 5);
for (const auto& pair : net.named_parameters()) {
  std::cout << pair.key() << ": " << pair.value() << std::endl;
}

我们可以再次执行以查看输出：

root@fa350df05ecf:/home/build# make && ./dcgan                                                                                                                                            11:13:48
Scanning dependencies of target dcgan
[ 50%] Building CXX object CMakeFiles/dcgan.dir/dcgan.cpp.o
[100%] Linking CXX executable dcgan
[100%] Built target dcgan
b: -0.1863
-0.8611
-0.1228
1.3269
0.9858
[ Variable[CPUFloatType]{5} ]
linear.weight:  0.0339  0.2484  0.2035 -0.2103
-0.0715 -0.2975 -0.4350 -0.1878
-0.3616  0.1050 -0.4982  0.0335
-0.1605  0.4963  0.4099 -0.2883
0.1818 -0.3447 -0.1501 -0.0215
[ Variable[CPUFloatType]{5,4} ]
linear.bias: -0.0250
0.0408
0.3756
-0.2149
-0.3636
[ Variable[CPUFloatType]{5} ]

注意

The documentation for torch::nn::Module 包含了操作模块层次结构的完整方法列表。

运行网络的前向模式

要在C++中执行网络，我们只需调用我们自己定义的forward()方法：

int main() {
  Net net(4, 5);
  std::cout << net.forward(torch::ones({2, 4})) << std::endl;
}

打印类似以下内容：

root@fa350df05ecf:/home/build# ./dcgan
0.8559  1.1572  2.1069 -0.1247  0.8060
0.8559  1.1572  2.1069 -0.1247  0.8060
[ Variable[CPUFloatType]{2,5} ]

模块所有权

在这一点上，我们知道如何在C++中定义一个模块，注册参数，注册子模块，通过诸如parameters()等方法遍历模块层次结构，并最终运行模块的forward()方法。虽然C++ API中还有许多方法、类和主题需要深入研究，但我将引导您参考docs以获取完整的菜单。我们还将简要介绍一些更多的概念，因为我们即将实现DCGAN模型和端到端训练管道。在此之前，让我简要介绍一下C++前端为torch::nn::Module的子类提供的所有权模型。

对于本次讨论，所有权模型指的是模块存储和传递的方式——这决定了谁或什么拥有特定的模块实例。在Python中，对象总是动态分配（在堆上）并具有引用语义。这非常易于使用且易于理解。事实上，在Python中，你基本上可以忘记对象在哪里以及它们如何被引用，而专注于完成任务。

C++作为一种低级语言，在这个领域提供了更多的选择。这增加了复杂性，并极大地影响了C++前端的设计和人体工程学。特别是对于C++前端中的模块，我们可以选择使用值语义或引用语义。第一种情况是最简单的，并且在之前的示例中已经展示过：模块对象在栈上分配，当传递给函数时，可以被复制、移动（使用std::move）或通过引用或指针传递：

struct Net : torch::nn::Module { };

void a(Net net) { }
void b(Net& net) { }
void c(Net* net) { }

int main() {
  Net net;
  a(net);
  a(std::move(net));
  b(net);
  c(&net);
}

对于第二种情况——引用语义——我们可以使用std::shared_ptr。 引用语义的优势在于，就像在Python中一样，它减少了思考模块如何必须传递给函数以及参数如何必须声明的认知负担（假设你到处使用shared_ptr）。

struct Net : torch::nn::Module {};

void a(std::shared_ptr<Net> net) { }

int main() {
  auto net = std::make_shared<Net>();
  a(net);
}

根据我们的经验，来自动态语言的研究者通常更喜欢引用语义而不是值语义，尽管后者在C++中更为“原生”。同样重要的是要注意，torch::nn::Module的设计，为了保持与Python API的人体工程学接近，依赖于共享所有权。例如，我们之前（此处简化）定义的Net：

struct Net : torch::nn::Module {
  Net(int64_t N, int64_t M)
    : linear(register_module("linear", torch::nn::Linear(N, M)))
  { }
  torch::nn::Linear linear;
};

为了使用linear子模块，我们希望将其直接存储在我们的类中。然而，我们也希望模块基类能够知道并访问这个子模块。为此，它必须存储对这个子模块的引用。此时，我们已经达到了需要共享所有权的需求。无论是torch::nn::Module类还是具体的Net类都需要对子模块的引用。因此，基类将模块存储为shared_ptr，因此具体类也必须这样做。

但是等等！我在上面的代码中没有看到任何关于shared_ptr的提及！这是为什么呢？因为std::shared_ptr输入起来非常麻烦。为了让我们的研究人员保持高效，我们设计了一个复杂的方案来隐藏shared_ptr的提及——这种好处通常是为值语义保留的——同时保留引用语义。为了理解这是如何工作的，我们可以看一下核心库中torch::nn::Linear模块的简化定义（完整定义在这里）：

struct LinearImpl : torch::nn::Module {
  LinearImpl(int64_t in, int64_t out);

  Tensor forward(const Tensor& input);

  Tensor weight, bias;
};

TORCH_MODULE(Linear);

简而言之：该模块不称为Linear，而是LinearImpl。一个宏TORCH_MODULE然后定义了实际的Linear类。这个“生成”的类实际上是一个std::shared_ptr的包装器。它是一个包装器而不是简单的typedef，以便构造函数仍然按预期工作，即你仍然可以写torch::nn::Linear(3, 4)而不是std::make_shared(3, 4)。我们称由宏创建的类为模块持有者。与（共享）指针一样，你使用箭头运算符访问底层对象（如model->forward(...)）。最终结果是一个与Python API非常相似的所有权模型。引用语义成为默认，但不需要额外的std::shared_ptr或std::make_shared输入。对于我们的Net，使用模块持有者API看起来像这样：

struct NetImpl : torch::nn::Module {};
TORCH_MODULE(Net);

void a(Net net) { }

int main() {
  Net net;
  a(net);
}

这里有一个微妙的问题值得一提。默认构造的std::shared_ptr是“空的”，即包含一个空指针。那么默认构造的Linear或Net是什么呢？这是一个棘手的选择。我们可以说它应该是一个空的（null）std::shared_ptr。然而，回想一下Linear(3, 4)与std::make_shared(3, 4)是相同的。这意味着如果我们决定Linear linear;应该是一个空指针，那么就没有办法构造一个不接收任何构造函数参数或默认所有参数的模块。因此，在当前API中，默认构造的模块持有者（如Linear()）会调用底层模块的默认构造函数（LinearImpl()）。如果底层模块没有默认构造函数，你会得到一个编译器错误。要构造空的持有者，你可以将nullptr传递给持有者的构造函数。

在实践中，这意味着您可以像前面所示那样使用子模块，其中模块在初始化列表中注册和构建：

struct Net : torch::nn::Module {
  Net(int64_t N, int64_t M)
    : linear(register_module("linear", torch::nn::Linear(N, M)))
  { }
  torch::nn::Linear linear;
};

或者你可以先用一个空指针构造持有者，然后在构造函数中赋值（对于Python用户来说更熟悉）：

struct Net : torch::nn::Module {
  Net(int64_t N, int64_t M) {
    linear = register_module("linear", torch::nn::Linear(N, M));
  }
  torch::nn::Linear linear{nullptr}; // construct an empty holder
};

总结：你应该使用哪种所有权模型——哪种语义？C++前端的API最支持模块持有者提供的所有权模型。这种机制的唯一缺点是模块声明下面多了一行样板代码。尽管如此，最简单的模型仍然是C++模块介绍中展示的值语义模型。对于小型、简单的脚本，你可能也可以使用它。但你迟早会发现，由于技术原因，它并不总是被支持。例如，序列化API（torch::save 和 torch::load）只支持模块持有者（或普通的shared_ptr）。因此，模块持有者API是使用C++前端定义模块的推荐方式，我们将在本教程中继续使用此API。

定义DCGAN模块

我们现在已经具备了必要的背景知识和介绍，可以定义我们在这篇文章中想要解决的机器学习任务的模块。回顾一下：我们的任务是从MNIST数据集生成数字图像。我们希望使用生成对抗网络（GAN）来解决这个任务。特别是，我们将使用DCGAN架构——这是最早且最简单的架构之一，但对于这个任务来说完全足够。

提示

你可以在这个仓库中找到本教程中展示的完整源代码。

什么是GAN aGAN？

GAN由两个不同的神经网络模型组成：一个生成器和一个判别器。生成器从噪声分布中接收样本，其目标是将每个噪声样本转换为类似于目标分布中的图像——在我们的例子中是MNIST数据集。判别器则接收来自MNIST数据集的真实图像或来自生成器的伪造图像。它被要求输出一个概率，判断特定图像的真实性（接近1）或伪造性（接近0）。判别器对生成器生成的图像真实性的反馈用于训练生成器。判别器对真实性判断能力的反馈用于优化判别器。理论上，生成器和判别器之间的微妙平衡使它们同步改进，导致生成器生成与目标分布无法区分的图像，欺骗判别器的（此时）卓越判断力，使其对真实和伪造图像都输出0.5的概率。对我们来说，最终结果是一个接收噪声作为输入并生成逼真数字图像作为输出的机器。

生成器模块

我们首先定义生成器模块，该模块由一系列转置的2D卷积、批量归一化和ReLU激活单元组成。我们在自己定义的模块的forward()方法中显式地传递输入（以函数式的方式）：

struct DCGANGeneratorImpl : nn::Module {
  DCGANGeneratorImpl(int kNoiseSize)
      : conv1(nn::ConvTranspose2dOptions(kNoiseSize, 256, 4)
                  .bias(false)),
        batch_norm1(256),
        conv2(nn::ConvTranspose2dOptions(256, 128, 3)
                  .stride(2)
                  .padding(1)
                  .bias(false)),
        batch_norm2(128),
        conv3(nn::ConvTranspose2dOptions(128, 64, 4)
                  .stride(2)
                  .padding(1)
                  .bias(false)),
        batch_norm3(64),
        conv4(nn::ConvTranspose2dOptions(64, 1, 4)
                  .stride(2)
                  .padding(1)
                  .bias(false))
 {
   // register_module() is needed if we want to use the parameters() method later on
   register_module("conv1", conv1);
   register_module("conv2", conv2);
   register_module("conv3", conv3);
   register_module("conv4", conv4);
   register_module("batch_norm1", batch_norm1);
   register_module("batch_norm2", batch_norm2);
   register_module("batch_norm3", batch_norm3);
 }

 torch::Tensor forward(torch::Tensor x) {
   x = torch::relu(batch_norm1(conv1(x)));
   x = torch::relu(batch_norm2(conv2(x)));
   x = torch::relu(batch_norm3(conv3(x)));
   x = torch::tanh(conv4(x));
   return x;
 }

 nn::ConvTranspose2d conv1, conv2, conv3, conv4;
 nn::BatchNorm2d batch_norm1, batch_norm2, batch_norm3;
};
TORCH_MODULE(DCGANGenerator);

DCGANGenerator generator(kNoiseSize);

我们现在可以在DCGANGenerator上调用forward()，将噪声样本映射为图像。

选择的特定模块，如nn::ConvTranspose2d和nn::BatchNorm2d，遵循了之前概述的结构。kNoiseSize常量决定了输入噪声向量的大小，并设置为100。当然，超参数是通过研究生下降法找到的。

注意

在发现超参数的过程中，没有研究生受到伤害。他们定期被喂食Soylent。

注意

简要说明如何将选项传递给C++前端中的内置模块，如Conv2d：每个模块都有一些必需的选项，例如BatchNorm2d的特征数量。如果您只需要配置必需的选项，可以直接将它们传递给模块的构造函数，例如BatchNorm2d(128)或Dropout(0.5)或Conv2d(8, 4, 2)（用于输入通道数、输出通道数和内核大小）。然而，如果您需要修改通常默认的其他选项，例如Conv2d的bias，则需要构造并传递一个options对象。C++前端中的每个模块都有一个相关的选项结构体，称为ModuleOptions，其中Module是模块的名称，例如LinearOptions用于Linear。这就是我们为上面的Conv2d模块所做的。

判别器模块

判别器同样由一系列卷积、批量归一化和激活函数组成。然而，这里的卷积是常规卷积而非转置卷积，并且我们使用了一个alpha值为0.2的Leaky ReLU，而不是普通的ReLU。此外，最终的激活函数变为Sigmoid，它将值压缩到0到1的范围内。然后，我们可以将这些压缩后的值解释为判别器分配给图像为真实图像的概率。

为了构建判别器，我们将尝试一些不同的方法：一个Sequential模块。 就像在Python中一样，PyTorch在这里提供了两种用于模型定义的API：一种是功能性的， 其中输入通过连续的函数传递（例如生成器模块示例），另一种是更面向对象的， 我们构建一个包含整个模型作为子模块的Sequential模块。使用Sequential，判别器将如下所示：

nn::Sequential discriminator(
  // Layer 1
  nn::Conv2d(
      nn::Conv2dOptions(1, 64, 4).stride(2).padding(1).bias(false)),
  nn::LeakyReLU(nn::LeakyReLUOptions().negative_slope(0.2)),
  // Layer 2
  nn::Conv2d(
      nn::Conv2dOptions(64, 128, 4).stride(2).padding(1).bias(false)),
  nn::BatchNorm2d(128),
  nn::LeakyReLU(nn::LeakyReLUOptions().negative_slope(0.2)),
  // Layer 3
  nn::Conv2d(
      nn::Conv2dOptions(128, 256, 4).stride(2).padding(1).bias(false)),
  nn::BatchNorm2d(256),
  nn::LeakyReLU(nn::LeakyReLUOptions().negative_slope(0.2)),
  // Layer 4
  nn::Conv2d(
      nn::Conv2dOptions(256, 1, 3).stride(1).padding(0).bias(false)),
  nn::Sigmoid());

提示

一个Sequential模块简单地执行函数组合。第一个子模块的输出成为第二个子模块的输入，第三个子模块的输出成为第四个子模块的输入，依此类推。

加载数据

现在我们已经定义了生成器和判别器模型，我们需要一些数据来训练这些模型。C++前端，像Python一样，带有一个强大的并行数据加载器。这个数据加载器可以从数据集中读取批量数据（你可以自己定义数据集），并提供了许多配置选项。

注意

虽然Python数据加载器使用多进程，但C++数据加载器是真正的多线程，并且不会启动任何新进程。

数据加载器是C++前端的data API的一部分，包含在torch::data::命名空间中。该API由几个不同的组件组成：

• 数据加载器类，

• 用于定义数据集的API，

• 一个用于定义转换的API，可以应用于数据集，

• 一个用于定义采样器的API，它生成用于索引数据集的索引，

• 现有数据集、转换和采样器的库。

在本教程中，我们可以使用C++前端自带的MNIST数据集。让我们为此实例化一个torch::data::datasets::MNIST，并应用两个变换：首先，我们对图像进行归一化，使其范围从-1到+1（原始范围为0到1）。其次，我们应用Stack 整理，它将一批张量沿着第一个维度堆叠成一个单一的张量：

auto dataset = torch::data::datasets::MNIST("./mnist")
    .map(torch::data::transforms::Normalize<>(0.5, 0.5))
    .map(torch::data::transforms::Stack<>());

请注意，MNIST数据集应位于相对于您执行训练二进制文件的./mnist目录中。您可以使用此脚本来下载MNIST数据集。

接下来，我们创建一个数据加载器并将此数据集传递给它。要创建一个新的数据加载器，我们使用torch::data::make_data_loader，它返回一个正确类型的std::unique_ptr（这取决于数据集的类型、采样器的类型以及其他一些实现细节）：

auto data_loader = torch::data::make_data_loader(std::move(dataset));

数据加载器确实提供了很多选项。您可以查看完整集合这里。 例如，为了加快数据加载速度，我们可以增加工作线程的数量。默认数量为零，这意味着将使用主线程。 如果我们将workers设置为2，将会生成两个线程并发加载数据。 我们还应该将批量大小从默认的1增加到更合理的值，比如64（kBatchSize的值）。 因此，让我们创建一个DataLoaderOptions对象并设置适当的属性：

auto data_loader = torch::data::make_data_loader(
    std::move(dataset),
    torch::data::DataLoaderOptions().batch_size(kBatchSize).workers(2));

我们现在可以编写一个循环来加载数据批次，目前我们只会将其打印到控制台：

for (torch::data::Example<>& batch : *data_loader) {
  std::cout << "Batch size: " << batch.data.size(0) << " | Labels: ";
  for (int64_t i = 0; i < batch.data.size(0); ++i) {
    std::cout << batch.target[i].item<int64_t>() << " ";
  }
  std::cout << std::endl;
}

在这种情况下，数据加载器返回的类型是torch::data::Example。 这个类型是一个简单的结构体，包含一个data字段用于数据和一个target 字段用于标签。因为我们之前应用了Stack整理，所以 数据加载器只返回一个这样的示例。如果我们没有应用 整理，数据加载器将返回std::vector>， 每个批次中的每个示例都有一个元素。

如果你重新构建并运行这段代码，你应该会看到类似这样的内容：

root@fa350df05ecf:/home/build# make
Scanning dependencies of target dcgan
[ 50%] Building CXX object CMakeFiles/dcgan.dir/dcgan.cpp.o
[100%] Linking CXX executable dcgan
[100%] Built target dcgan
root@fa350df05ecf:/home/build# make
[100%] Built target dcgan
root@fa350df05ecf:/home/build# ./dcgan
Batch size: 64 | Labels: 5 2 6 7 2 1 6 7 0 1 6 2 3 6 9 1 8 4 0 6 5 3 3 0 4 6 6 6 4 0 8 6 0 6 9 2 4 0 2 8 6 3 3 2 9 2 0 1 4 2 3 4 8 2 9 9 3 5 8 0 0 7 9 9
Batch size: 64 | Labels: 2 2 4 7 1 2 8 8 6 9 0 2 2 9 3 6 1 3 8 0 4 4 8 8 8 9 2 6 4 7 1 5 0 9 7 5 4 3 5 4 1 2 8 0 7 1 9 6 1 6 5 3 4 4 1 2 3 2 3 5 0 1 6 2
Batch size: 64 | Labels: 4 5 4 2 1 4 8 3 8 3 6 1 5 4 3 6 2 2 5 1 3 1 5 0 8 2 1 5 3 2 4 4 5 9 7 2 8 9 2 0 6 7 4 3 8 3 5 8 8 3 0 5 8 0 8 7 8 5 5 6 1 7 8 0
Batch size: 64 | Labels: 3 3 7 1 4 1 6 1 0 3 6 4 0 2 5 4 0 4 2 8 1 9 6 5 1 6 3 2 8 9 2 3 8 7 4 5 9 6 0 8 3 0 0 6 4 8 2 5 4 1 8 3 7 8 0 0 8 9 6 7 2 1 4 7
Batch size: 64 | Labels: 3 0 5 5 9 8 3 9 8 9 5 9 5 0 4 1 2 7 7 2 0 0 5 4 8 7 7 6 1 0 7 9 3 0 6 3 2 6 2 7 6 3 3 4 0 5 8 8 9 1 9 2 1 9 4 4 9 2 4 6 2 9 4 0
Batch size: 64 | Labels: 9 6 7 5 3 5 9 0 8 6 6 7 8 2 1 9 8 8 1 1 8 2 0 7 1 4 1 6 7 5 1 7 7 4 0 3 2 9 0 6 6 3 4 4 8 1 2 8 6 9 2 0 3 1 2 8 5 6 4 8 5 8 6 2
Batch size: 64 | Labels: 9 3 0 3 6 5 1 8 6 0 1 9 9 1 6 1 7 7 4 4 4 7 8 8 6 7 8 2 6 0 4 6 8 2 5 3 9 8 4 0 9 9 3 7 0 5 8 2 4 5 6 2 8 2 5 3 7 1 9 1 8 2 2 7
Batch size: 64 | Labels: 9 1 9 2 7 2 6 0 8 6 8 7 7 4 8 6 1 1 6 8 5 7 9 1 3 2 0 5 1 7 3 1 6 1 0 8 6 0 8 1 0 5 4 9 3 8 5 8 4 8 0 1 2 6 2 4 2 7 7 3 7 4 5 3
Batch size: 64 | Labels: 8 8 3 1 8 6 4 2 9 5 8 0 2 8 6 6 7 0 9 8 3 8 7 1 6 6 2 7 7 4 5 5 2 1 7 9 5 4 9 1 0 3 1 9 3 9 8 8 5 3 7 5 3 6 8 9 4 2 0 1 2 5 4 7
Batch size: 64 | Labels: 9 2 7 0 8 4 4 2 7 5 0 0 6 2 0 5 9 5 9 8 8 9 3 5 7 5 4 7 3 0 5 7 6 5 7 1 6 2 8 7 6 3 2 6 5 6 1 2 7 7 0 0 5 9 0 0 9 1 7 8 3 2 9 4
Batch size: 64 | Labels: 7 6 5 7 7 5 2 2 4 9 9 4 8 7 4 8 9 4 5 7 1 2 6 9 8 5 1 2 3 6 7 8 1 1 3 9 8 7 9 5 0 8 5 1 8 7 2 6 5 1 2 0 9 7 4 0 9 0 4 6 0 0 8 6
...

这意味着我们能够成功地从MNIST数据集中加载数据。

编写训练循环

现在让我们完成示例的算法部分，并实现生成器和判别器之间的微妙舞蹈。首先，我们将创建两个优化器，一个用于生成器，一个用于判别器。我们使用的优化器实现了Adam算法：

torch::optim::Adam generator_optimizer(
    generator->parameters(), torch::optim::AdamOptions(2e-4).betas(std::make_tuple(0.5, 0.5)));
torch::optim::Adam discriminator_optimizer(
    discriminator->parameters(), torch::optim::AdamOptions(5e-4).betas(std::make_tuple(0.5, 0.5)));

注意

截至撰写本文时，C++ 前端提供了实现 Adagrad、Adam、LBFGS、RMSprop 和 SGD 的优化器。文档中有最新的列表。

接下来，我们需要更新我们的训练循环。我们将添加一个外部循环以在每个时期耗尽数据加载器，然后编写GAN训练代码：

for (int64_t epoch = 1; epoch <= kNumberOfEpochs; ++epoch) {
  int64_t batch_index = 0;
  for (torch::data::Example<>& batch : *data_loader) {
    // Train discriminator with real images.
    discriminator->zero_grad();
    torch::Tensor real_images = batch.data;
    torch::Tensor real_labels = torch::empty(batch.data.size(0)).uniform_(0.8, 1.0);
    torch::Tensor real_output = discriminator->forward(real_images).reshape(real_labels.sizes());
    torch::Tensor d_loss_real = torch::binary_cross_entropy(real_output, real_labels);
    d_loss_real.backward();

    // Train discriminator with fake images.
    torch::Tensor noise = torch::randn({batch.data.size(0), kNoiseSize, 1, 1});
    torch::Tensor fake_images = generator->forward(noise);
    torch::Tensor fake_labels = torch::zeros(batch.data.size(0));
    torch::Tensor fake_output = discriminator->forward(fake_images.detach()).reshape(fake_labels.sizes());
    torch::Tensor d_loss_fake = torch::binary_cross_entropy(fake_output, fake_labels);
    d_loss_fake.backward();

    torch::Tensor d_loss = d_loss_real + d_loss_fake;
    discriminator_optimizer.step();

    // Train generator.
    generator->zero_grad();
    fake_labels.fill_(1);
    fake_output = discriminator->forward(fake_images).reshape(fake_labels.sizes());
    torch::Tensor g_loss = torch::binary_cross_entropy(fake_output, fake_labels);
    g_loss.backward();
    generator_optimizer.step();

    std::printf(
        "\r[%2ld/%2ld][%3ld/%3ld] D_loss: %.4f | G_loss: %.4f",
        epoch,
        kNumberOfEpochs,
        ++batch_index,
        batches_per_epoch,
        d_loss.item<float>(),
        g_loss.item<float>());
  }
}

在上面，我们首先评估判别器在真实图像上的表现，它应该分配一个高概率。为此，我们使用 torch::empty(batch.data.size(0)).uniform_(0.8, 1.0) 作为目标概率。

注意

我们选择在0.8到1.0之间均匀分布的随机值，而不是在所有地方都使用1.0，以使判别器的训练更加稳健。这个技巧被称为标签平滑。

在评估判别器之前，我们将其参数的梯度清零。计算损失后，我们通过调用d_loss.backward()通过网络反向传播以计算新的梯度。我们对假图像重复此过程。我们不是使用数据集中的图像，而是让生成器通过输入一批随机噪声来创建假图像。然后我们将这些假图像传递给判别器。这次，我们希望判别器输出低概率，理想情况下全部为零。一旦我们计算了真实图像批次和假图像批次的判别器损失，我们就可以将判别器的优化器向前推进一步以更新其参数。

为了训练生成器，我们再次首先将其梯度归零，然后重新评估判别器在假图像上的表现。然而，这次我们希望判别器分配的概率非常接近于一，这表明生成器可以生成图像，这些图像能够欺骗判别器，使其认为它们实际上是真实的（来自数据集）。为此，我们用全1填充fake_labels张量。最后，我们更新生成器的优化器以更新其参数。

我们现在应该准备好开始在CPU上训练我们的模型了。我们还没有任何代码来捕获状态或样本输出，但我们很快就会添加这些功能。现在，让我们只是观察我们的模型正在做一些事情——我们稍后会根据生成的图像来验证这些事情是否有意义。重新构建和运行应该会打印出类似的内容：

root@3c0711f20896:/home/build# make && ./dcgan
Scanning dependencies of target dcgan
[ 50%] Building CXX object CMakeFiles/dcgan.dir/dcgan.cpp.o
[100%] Linking CXX executable dcgan
[100%] Built target dcga
[ 1/10][100/938] D_loss: 0.6876 | G_loss: 4.1304
[ 1/10][200/938] D_loss: 0.3776 | G_loss: 4.3101
[ 1/10][300/938] D_loss: 0.3652 | G_loss: 4.6626
[ 1/10][400/938] D_loss: 0.8057 | G_loss: 2.2795
[ 1/10][500/938] D_loss: 0.3531 | G_loss: 4.4452
[ 1/10][600/938] D_loss: 0.3501 | G_loss: 5.0811
[ 1/10][700/938] D_loss: 0.3581 | G_loss: 4.5623
[ 1/10][800/938] D_loss: 0.6423 | G_loss: 1.7385
[ 1/10][900/938] D_loss: 0.3592 | G_loss: 4.7333
[ 2/10][100/938] D_loss: 0.4660 | G_loss: 2.5242
[ 2/10][200/938] D_loss: 0.6364 | G_loss: 2.0886
[ 2/10][300/938] D_loss: 0.3717 | G_loss: 3.8103
[ 2/10][400/938] D_loss: 1.0201 | G_loss: 1.3544
[ 2/10][500/938] D_loss: 0.4522 | G_loss: 2.6545
...

迁移到GPU

虽然我们当前的脚本可以在CPU上正常运行，但我们都知道卷积在GPU上要快得多。让我们快速讨论一下如何将我们的训练转移到GPU上。为此，我们需要做两件事：将GPU设备规范传递给我们自己分配的张量，并通过C++前端中所有张量和模块都有的to()方法显式地将任何其他张量复制到GPU上。实现这两点的最简单方法是在训练脚本的顶层创建一个torch::Device实例，然后将该设备传递给张量工厂函数，如torch::zeros以及to()方法。我们可以从使用CPU设备开始：

// Place this somewhere at the top of your training script.
torch::Device device(torch::kCPU);

新的张量分配如

torch::Tensor fake_labels = torch::zeros(batch.data.size(0));

应更新为将device作为最后一个参数：

torch::Tensor fake_labels = torch::zeros(batch.data.size(0), device);

对于那些我们无法控制的张量，比如来自MNIST数据集的张量，我们必须插入显式的to()调用。这意味着

torch::Tensor real_images = batch.data;

变成

torch::Tensor real_images = batch.data.to(device);

并且我们的模型参数应该移动到正确的设备上：

generator->to(device);
discriminator->to(device);

注意

如果一个张量已经存在于提供给to()的设备上，调用将不会执行任何操作。不会进行额外的复制。

此时，我们只是让之前驻留在CPU上的代码更加明确。 然而，现在也很容易将设备更改为CUDA设备：

torch::Device device(torch::kCUDA)

现在所有的张量都将存在于GPU上，调用快速的CUDA内核进行所有操作，而无需我们更改任何下游代码。如果我们想要指定特定的设备索引，可以将其作为第二个参数传递给Device构造函数。如果我们希望不同的张量存在于不同的设备上，我们可以传递单独的设备实例（例如一个在CUDA设备0上，另一个在CUDA设备1上）。我们甚至可以动态地进行这种配置，这通常有助于使我们的训练脚本更具可移植性：

torch::Device device = torch::kCPU;
if (torch::cuda::is_available()) {
  std::cout << "CUDA is available! Training on GPU." << std::endl;
  device = torch::kCUDA;
}

甚至

torch::Device device(torch::cuda::is_available() ? torch::kCUDA : torch::kCPU);

检查点和恢复训练状态

我们应该对训练脚本进行的最后一项增强是定期保存模型参数的状态、优化器的状态以及一些生成的图像样本。如果我们的计算机在训练过程中崩溃，前两者将允许我们恢复训练状态。对于长时间的训练会话，这绝对是必不可少的。幸运的是，C++前端提供了一个API来序列化和反序列化模型和优化器状态，以及单个张量。

核心API是torch::save(thing,filename)和 torch::load(thing,filename)，其中thing可以是 torch::nn::Module子类或像我们在训练脚本中拥有的Adam对象 这样的优化器实例。让我们更新我们的训练循环，以在特定间隔检查点保存 模型和优化器状态：

if (batch_index % kCheckpointEvery == 0) {
  // Checkpoint the model and optimizer state.
  torch::save(generator, "generator-checkpoint.pt");
  torch::save(generator_optimizer, "generator-optimizer-checkpoint.pt");
  torch::save(discriminator, "discriminator-checkpoint.pt");
  torch::save(discriminator_optimizer, "discriminator-optimizer-checkpoint.pt");
  // Sample the generator and save the images.
  torch::Tensor samples = generator->forward(torch::randn({8, kNoiseSize, 1, 1}, device));
  torch::save((samples + 1.0) / 2.0, torch::str("dcgan-sample-", checkpoint_counter, ".pt"));
  std::cout << "\n-> checkpoint " << ++checkpoint_counter << '\n';
}

其中 kCheckpointEvery 是一个整数，设置为类似 100 的值，以便每 100 批次进行一次检查点，而 checkpoint_counter 是一个计数器，每次我们创建检查点时都会增加。

要恢复训练状态，你可以在所有模型和优化器创建之后，但在训练循环开始之前，添加如下几行代码：

torch::optim::Adam generator_optimizer(
    generator->parameters(), torch::optim::AdamOptions(2e-4).beta1(0.5));
torch::optim::Adam discriminator_optimizer(
    discriminator->parameters(), torch::optim::AdamOptions(2e-4).beta1(0.5));

if (kRestoreFromCheckpoint) {
  torch::load(generator, "generator-checkpoint.pt");
  torch::load(generator_optimizer, "generator-optimizer-checkpoint.pt");
  torch::load(discriminator, "discriminator-checkpoint.pt");
  torch::load(
      discriminator_optimizer, "discriminator-optimizer-checkpoint.pt");
}

int64_t checkpoint_counter = 0;
for (int64_t epoch = 1; epoch <= kNumberOfEpochs; ++epoch) {
  int64_t batch_index = 0;
  for (torch::data::Example<>& batch : *data_loader) {

检查生成的图像

我们的训练脚本现在已经完成。我们准备好训练我们的GAN，无论是在CPU还是GPU上。为了检查我们训练过程的中间输出，我们添加了代码定期将图像样本保存到"dcgan-sample-xxx.pt"文件中，我们可以编写一个小的Python脚本来加载张量并使用matplotlib显示它们：

import argparse

import matplotlib.pyplot as plt
import torch


parser = argparse.ArgumentParser()
parser.add_argument("-i", "--sample-file", required=True)
parser.add_argument("-o", "--out-file", default="out.png")
parser.add_argument("-d", "--dimension", type=int, default=3)
options = parser.parse_args()

module = torch.jit.load(options.sample_file)
images = list(module.parameters())[0]

for index in range(options.dimension * options.dimension):
  image = images[index].detach().cpu().reshape(28, 28).mul(255).to(torch.uint8)
  array = image.numpy()
  axis = plt.subplot(options.dimension, options.dimension, 1 + index)
  plt.imshow(array, cmap="gray")
  axis.get_xaxis().set_visible(False)
  axis.get_yaxis().set_visible(False)

plt.savefig(options.out_file)
print("Saved ", options.out_file)

现在让我们训练我们的模型大约30个周期：

root@3c0711f20896:/home/build# make && ./dcgan                                                                                                                                10:17:57
Scanning dependencies of target dcgan
[ 50%] Building CXX object CMakeFiles/dcgan.dir/dcgan.cpp.o
[100%] Linking CXX executable dcgan
[100%] Built target dcgan
CUDA is available! Training on GPU.
[ 1/30][200/938] D_loss: 0.4953 | G_loss: 4.0195
-> checkpoint 1
[ 1/30][400/938] D_loss: 0.3610 | G_loss: 4.8148
-> checkpoint 2
[ 1/30][600/938] D_loss: 0.4072 | G_loss: 4.36760
-> checkpoint 3
[ 1/30][800/938] D_loss: 0.4444 | G_loss: 4.0250
-> checkpoint 4
[ 2/30][200/938] D_loss: 0.3761 | G_loss: 3.8790
-> checkpoint 5
[ 2/30][400/938] D_loss: 0.3977 | G_loss: 3.3315
...
-> checkpoint 120
[30/30][938/938] D_loss: 0.3610 | G_loss: 3.8084

并在图中显示图像：

root@3c0711f20896:/home/build# python display.py -i dcgan-sample-100.pt
Saved out.png

应该看起来像这样：

数字！万岁！现在轮到你了：你能改进模型使数字看起来更好吗？

结论

本教程希望能为您提供一个易于理解的PyTorch C++前端概述。像PyTorch这样的机器学习库必然拥有非常广泛和深入的API。因此，这里有许多概念我们没有时间或空间来讨论。然而，我鼓励您尝试使用API，并在遇到困难时查阅我们的文档，特别是库API部分。此外，请记住，只要有可能，C++前端都会遵循Python前端的设计和语义，因此您可以利用这一点来提高学习效率。

提示

你可以在这个仓库中找到本教程中展示的完整源代码。

一如既往，如果您遇到任何问题或有疑问，您可以使用我们的 论坛 或 GitHub 问题 来联系我们。