使用 PyTorch C++ 前端¶
创建于: 2019年1月15日 | 最后更新: 2025年1月23日 | 最后验证: 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++ 前端。
提示
这篇笔记全面概述了 C++ 前端的功能组件和设计理念。
提示
PyTorch C++ 生态系统的文档可在 https://pytorch.ac.cn/cppdocs 找到。在那里您可以找到高级描述以及 API 级别的文档。
动机¶
在我们开始激动人心的 GAN 和 MNIST 数字之旅之前，让我们退后一步，讨论为什么您一开始会想使用 C++ 前端而不是 Python 前端。我们（PyTorch 团队）创建 C++ 前端是为了在无法使用 Python 或 Python 根本不适合工作的环境中的研究成为可能。此类环境的示例包括：
低延迟系统：您可能希望在纯 C++ 游戏引擎中进行强化学习研究，该引擎具有高帧率和低延迟要求。使用纯 C++ 库比 Python 库更适合此类环境。由于 Python 解释器的速度较慢，Python 可能根本无法使用。
高多线程环境：由于全局解释器锁（GIL），Python 无法同时运行多个系统线程。多进程是一种替代方案，但可伸缩性较差且存在显著缺点。C++ 没有这样的限制，线程易于使用和创建。需要大量并行化的模型，例如 深度神经进化 中使用的模型，可以从中受益。
现有 C++ 代码库：您可能是现有 C++ 应用程序的所有者，该应用程序可能正在后端服务器中提供网页服务或在照片编辑软件中渲染 3D 图形，并且希望将机器学习方法集成到您的系统中。C++ 前端允许您留在 C++ 环境中，避免在 Python 和 C++ 之间来回绑定的麻烦，同时保留传统 PyTorch（Python）体验的许多灵活性和直观性。
C++ 前端无意与 Python 前端竞争。它是为了补充 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 上跟随操作。
提示
关于 安装 PyTorch C++ 分发包 的笔记更详细地描述了以下步骤。
提示
在 Windows 上，debug 和 release 构建在 ABI 上不兼容。如果您打算在 debug 模式下构建您的项目，请尝试使用 debug 版本的 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、普通的 Makefile 或您喜欢的任何其他构建环境。但是，我们不为此提供开箱即用的支持。
请注意上述 CMake 文件中的第 4 行：find_package(Torch REQUIRED)。这指示 CMake 查找 LibTorch 库的构建配置。为了让 CMake 知道在哪里找到这些文件，我们在调用 cmake 时必须设置 CMAKE_PREFIX_PATH。在此之前，让我们确定我们的 dcgan 应用程序的以下目录结构：
dcgan/
CMakeLists.txt
dcgan.cpp
此外，我将使用 /path/to/libtorch 来指代解压后的 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。
Module API 基础知识¶
与 Python 接口一致，基于 C++ 前端的神经网络由可重用的构建块组成，称为 模块 (modules)。有一个所有其他模块派生自的基础模块类。在 Python 中，这个类是 torch.nn.Module，在 C++ 中是 torch::nn::Module。除了实现模块封装的算法的 forward() 方法外，一个模块通常包含以下三种子对象中的任何一种：参数 (parameters)、缓冲区 (buffers) 和子模块 (submodules)。
参数和缓冲区以张量 (tensors) 的形式存储状态。参数记录梯度，而缓冲区不记录。参数通常是神经网络中可训练的权重。缓冲区的例子包括批量归一化 (batch normalization) 的均值和方差。为了重用特定的逻辑和状态块，PyTorch API 允许模块嵌套。嵌套的模块被称为子模块 (submodule)。
参数、缓冲区和子模块必须显式注册。注册后，可以使用 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<torch::Tensor>，我们可以对其进行迭代：
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} ]
注意
文档 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 中还有更多的方法、类和主题需要深入研究，但我将引导您查阅文档以获取完整内容。稍后我们实现 DCGAN 模型和端到端训练流水线时，也会涉及更多概念。在此之前，让我简要介绍一下 C++ 前端为 torch::nn::Module 的子类提供的所有权模型。
在本次讨论中，所有权模型指的是模块存储和传递的方式——这决定了谁或什么拥有一个特定的模块实例。在 Python 中，对象总是动态分配（在堆上），并且具有引用语义。这非常易于使用和理解。实际上，在 Python 中，您很大程度上可以忽略对象存储在哪里以及它们如何被引用，而专注于完成任务。
C++ 作为一种低级语言，在此领域提供了更多选项。这增加了复杂性，并严重影响了 C++ 前端的设计和易用性。特别是在 C++ 前端中，对于模块，我们可以选择使用值语义 (value semantics) 或引用语义 (reference semantics)。第一种情况最简单，并且在迄今为止的示例中有所展示：模块对象在栈上分配，当传递给函数时，可以被复制、移动（使用 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++。同样重要的是要注意，为了尽可能贴近 Python API 的易用性，torch::nn::Module 的设计依赖于共享所有权。例如，以下是我们之前（此处已缩短）的 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<MyModule> 写起来太麻烦了。为了保持研究人员的工作效率，我们设计了一个精巧的方案，在保留引用语义的同时，隐藏了对 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<LinearImpl> 的一个包装器。之所以是包装器而不是简单的 typedef，是为了让构造函数等按预期工作，也就是说，你仍然可以写 torch::nn::Linear(3, 4) 而不是 std::make_shared<LinearImpl>(3, 4)。我们将通过宏创建的类称为模块持有者（holder）。就像（共享）指针一样，你可以使用箭头运算符访问底层对象（例如 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 是什么呢？这是一个棘手的选择。我们可以说它应该是一个空的（空指针）std::shared_ptr<LinearImpl>。然而，回想一下 Linear(3, 4) 等同于 std::make_shared<LinearImpl>(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？¶
一个 GAN 由两个不同的神经网络模型组成：一个生成器（generator）和一个判别器（discriminator）。生成器接收来自噪声分布的样本，其目标是将每个噪声样本转换为类似于目标分布图像的图像——在我们的例子中是 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。当然，超参数是通过梯度下降法（grad student descent，此处为幽默说法）找到的。
注意
在发现超参数的过程中，没有研究生受到伤害。他们定期被喂食 Soylent。
注意
简要介绍一下在 C++ 前端如何将选项传递给内置模块（如 Conv2d）：每个模块都有一些必需的选项，例如 BatchNorm2d 的特征数量。如果你只需要配置必需的选项，可以直接将它们传递给模块的构造函数，例如 BatchNorm2d(128) 或 Dropout(0.5) 或 Conv2d(8, 4, 2)（分别对应输入通道数、输出通道数和核大小）。但是，如果你需要修改其他通常有默认值的选项，例如 Conv2d 的 bias，你需要构造并传递一个选项对象。C++ 前端中的每个模块都有一个关联的选项结构体，称为 ModuleOptions，其中 Module 是模块的名称，例如 Linear 对应 LinearOptions。这就是我们在上面的 Conv2d 模块中所做的。
判别器模块¶
判别器同样是一系列卷积、批量归一化和激活单元。然而，这里的卷积是普通的卷积而不是转置卷积，并且我们使用 alpha 值为 0.2 的 Leaky ReLU 而不是普通的 ReLU。此外，最后的激活函数变为 Sigmoid，它将值压缩到 0 到 1 的范围内。然后我们可以将这些压缩后的值解释为判别器判断图像真实性的概率。
为了构建判别器，我们将尝试一种不同的方法：使用 Sequential 模块。就像在 Python 中一样，PyTorch 在这里提供了两种模型定义 API：一种是函数式 API，其中输入通过连续的函数传递（例如生成器模块示例），另一种是更面向对象的 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，
用于定义可应用于数据集的转换（transforms）的 API，
用于定义生成数据集索引的采样器（samplers）的 API，
现有数据集、转换和采样器的库。
对于本教程，我们可以使用 C++ 前端附带的 MNIST 数据集。为此，我们实例化一个 torch::data::datasets::MNIST，并应用两个转换：首先，我们将图像归一化到 -1 到 +1 的范围（原始范围是 0 到 1）。其次，我们应用 Stack 整理（collation），它接收一批张量并将它们沿第一个维度堆叠成一个张量
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<torch::data::Example<>>，每批中的每个示例都有一个元素。
如果你重新构建并运行此代码，你应该会看到类似这样的输出
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 的优化器。文档中有最新的列表。
接下来，我们需要更新我们的训练循环。我们将添加一个外层循环来每个 epoch 遍历数据加载器，然后编写 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，以便使判别器的训练更鲁棒。这种技巧称为标签平滑（label smoothing）。
在评估判别器之前，我们将其参数的梯度清零。计算损失后，我们通过调用 d_loss.backward() 在网络中反向传播损失，以计算新的梯度。我们对伪造图像重复这个过程。我们让生成器通过向其馈送一批随机噪声来为伪造图像创建图像，而不是使用来自数据集的图像。然后我们将这些伪造图像前向传播给判别器。这次，我们希望判别器输出低概率，理想情况下全部为零。一旦我们计算了真实图像和伪造图像批次的判别器损失，我们就可以将判别器的优化器向前推进一步，以更新其参数。
要训练生成器，我们首先再次将其梯度清零，然后在伪造图像上重新评估判别器。然而，这次我们希望判别器分配非常接近于一的概率，这将表明生成器可以生成能够欺骗判别器，使其认为图像实际上是真实的（来自数据集）的图像。为此，我们将 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 个 epoch
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
应该看起来像这样
数字！万岁！现在轮到你了：你能否改进模型，让数字看起来更好？
