在C++ 中加载 TorchScript 模型

在C++ 中加载 TorchScript 模型

译者：talengu

本教程已更新为可与PyTorch 1.2一起使用

顾名思义，PyTorch的主要接口是Python编程语言。尽管Python是许多需要动态性和易于迭代的场景的合适且首选的语言，但是在同样许多情况下，Python的这些属性恰恰是不利的。后者通常适用的一种环境是生产 -低延迟和严格部署要求的土地。对于生产场景，即使只将C ++绑定到Java，Rust或Go之类的另一种语言中，它通常也是首选语言。以下段落将概述PyTorch提供的从现有Python模型到可以加载和执行的序列化表示形式的路径完全来自C ++，不依赖Python。

步骤1：将PyTorch模型转换为Torch脚本

PyTorch模型从Python到C ++的旅程由Torch Script启用，Torch Script是PyTorch模型的表示形式，可以由Torch Script编译器理解，编译和序列化。如果您是从使用vanilla “eager” API编写的现有PyTorch模型开始的，则必须首先将模型转换为Torch脚本。在最常见的情况下(如下所述），这只需要很少的努力。如果您已经有了Torch脚本模块，则可以跳到本教程的下一部分。

有两种将PyTorch模型转换为Torch脚本的方法。第一种称为跟踪，一种机制，通过使用示例输入对模型的结构进行一次评估，并记录这些输入在模型中的流动，从而捕获模型的结构。这适用于有限使用控制流的模型。第二种方法是在模型中添加显式批注，以告知Torch Script编译器可以根据Torch Script语言施加的约束直接解析和编译模型代码。

小贴士您可以在官方Torch Script中找到有关这两种方法的完整文档，以及使用方法的进一步指导。

通过跟踪转换为 Torch Script

要将PyTorch模型通过跟踪转换为Torch Script，必须将模型的实例以及示例输入传递给torch.jit.trace 函数。这将产生一个torch.jit.ScriptModule对象，该对象的模型评估轨迹将嵌入在模块的forward方法中：

import torch
import torchvision
# An instance of your model.
model = torchvision.models.resnet18()
# An example input you would normally provide to your model's forward() method.
example = torch.rand(1, 3, 224, 224)
# Use torch.jit.trace to generate a torch.jit.ScriptModule via tracing.
traced_script_module = torch.jit.trace(model, example)

ScriptModule现在可以与常规PyTorch模块相同地评估被跟踪的对象：

In[1]: output = traced_script_module(torch.ones(1, 3, 224, 224))
In[2]: output[0, :5]
Out[2]: tensor([-0.2698, -0.0381,  0.4023, -0.3010, -0.0448], grad_fn=<SliceBackward>)

通过Annotation将Model转换为Torch Script

在某些情况下，例如，如果模型使用特定形式的控制流，如果想要直接在Torch Script中编写模型并相应地标注(annotate)模型。例如，假设有以下普通的 Pytorch模型：

import torch
class MyModule(torch.nn.Module):
    def __init__(self, N, M):
        super(MyModule, self).__init__()
        self.weight = torch.nn.Parameter(torch.rand(N, M))
    def forward(self, input):
        if input.sum() > 0:
          output = self.weight.mv(input)
        else:
          output = self.weight + input
        return output

因为forward此模块的方法使用取决于输入的控制流，所以它不适合跟踪。相反，我们可以将其转换为ScriptModule。为了将模块转换为ScriptModule，需要按以下方式编译模块torch.jit.script：

class MyModule(torch.nn.Module):
    def __init__(self, N, M):
        super(MyModule, self).__init__()
        self.weight = torch.nn.Parameter(torch.rand(N, M))
    def forward(self, input):
        if input.sum() > 0:
          output = self.weight.mv(input)
        else:
          output = self.weight + input
        return output
my_module = MyModule(10,20)
sm = torch.jit.script(my_module)

如果您需要排除某些方法，nn.Module 因为它们使用的是TorchScript不支持的Python功能，则可以使用以下方法注释这些方法@torch.jit.ignore

my_module是ScriptModule已经准备好进行序列化的实例。

步骤2：将脚本模块序列化为文件

一旦有了对ScriptModule PyTorch模型的跟踪或注释，就可以将其序列化为文件了。稍后，您将能够使用C++从此文件加载模块并执行它，而无需依赖Python。假设我们要序列化ResNet18先前在跟踪示例中显示的模型。要执行此序列化，只需在模块上调用 save 并传递一个文件名即可：

traced_script_module.save("traced_resnet_model.pt")

这将traced_resnet_model.pt在您的工作目录中生成一个文件。如果您还想序列化my_module，请回调my_module.save("my_module_model.pt")我们现在已经正式离开Python领域，并准备跨入C ++领域。

步骤3：在C++中加载脚本模块

要在C ++中加载序列化的PyTorch模型，您的应用程序必须依赖于 PyTorch C++ API(也称为LibTorch）。LibTorch发行版包含共享库，头文件和CMake构建配置文件的集合。虽然CMake不是依赖LibTorch的要求，但它是推荐的方法，并且将来会得到很好的支持。对于本教程，我们将使用CMake和LibTorch构建一个最小的C ++应用程序，该应用程序简单地加载并执行序列化的PyTorch模型。

最小的C ++应用程序

让我们从讨论加载模块的代码开始。以下将已经做：

#include <torch/script.h> // One-stop header.
#include <iostream>
#include <memory>
int main(int argc, const char* argv[]) {
  if (argc != 2) {
    std::cerr << "usage: example-app <path-to-exported-script-module>\n";
    return -1;
  }
  torch::jit::script::Module module;
  try {
    // Deserialize the ScriptModule from a file using torch::jit::load().
    module = torch::jit::load(argv[1]);
  }
  catch (const c10::Error& e) {
    std::cerr << "error loading the model\n";
    return -1;
  }
  std::cout << "ok\n";
}

该<torch/script.h>首标包括由运行示例所必需的库LibTorch所有相关包括。我们的应用程序接受序列化的PyTorch的文件路径ScriptModule作为其唯一的命令行参数，然后使用该torch::jit::load()函数继续反序列化该模块，该函数将该文件路径作为输入。作为回报，我们收到一个torch::jit::script::Module对象。我们将稍后讨论如何执行它。

取决于LibTorch和构建应用程序

假设我们将上述代码存储到名为的文件中example-app.cpp。最小CMakeLists.txt的构建看起来可能很简单：

cmake_minimum_required(VERSION 3.0 FATAL_ERROR)
project(custom_ops)
find_package(Torch REQUIRED)
add_executable(example-app example-app.cpp)
target_link_libraries(example-app "${TORCH_LIBRARIES}")
set_property(TARGET example-app PROPERTY CXX_STANDARD 11)

建立示例应用程序的最后一件事是LibTorch发行版。您可以随时从PyTorch网站的下载页面上获取最新的稳定版本。如果下载并解压缩最新的归档文件，则应收到具有以下目录结构的文件夹：

libtorch/
  bin/
  include/
  lib/
  share/

lib/ 文件夹包含您必须链接的共享库，
include/ 文件夹包含程序需要包含的头文件，
share/ 文件夹包含必要的CMake配置，以启用find_package(Torch)上面的简单命令。

小贴士在Windows上，调试和发行版本不兼容ABI。如果您打算以调试模式构建项目，请尝试使用LibTorch的调试版本。

最后一步是构建应用程序。为此，假定示例目录的布局如下：

example-app/
  CMakeLists.txt
  example-app.cpp

现在，我们可以运行以下命令从example-app/文件夹中构建应用程序：

mkdir build
cd build
cmake -DCMAKE_PREFIX_PATH=/path/to/libtorch ..
make

这里/path/to/libtorch应该是解压的LibTorch分布的完整路径。如果一切顺利，它将看起来像这样：

root@4b5a67132e81:/example-app# mkdir build
root@4b5a67132e81:/example-app# cd build
root@4b5a67132e81:/example-app/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
-- Configuring done
-- Generating done
-- Build files have been written to: /example-app/build
root@4b5a67132e81:/example-app/build# make
Scanning dependencies of target example-app
[ 50%] Building CXX object CMakeFiles/example-app.dir/example-app.cpp.o
[100%] Linking CXX executable example-app
[100%] Built target example-app

如果将生成的跟踪ResNet18模型的路径提供给traced_resnet_model.pt生成的example-app二进制文件，我们应该得到友好的“确定”。请注意，如果尝试与my_module_model.pt您一起运行此示例，则会收到一条错误消息，提示您输入的形状不兼容。my_module_model.pt期望使用1D而不是4D。

root@4b5a67132e81:/example-app/build# ./example-app <path_to_model>/traced_resnet_model.pt
ok

步骤4：在C ++中执行脚本模块

成功加载了ResNet18用C++编写的序列化代码后，现在离执行它仅几行代码了！让我们将这些行添加到C++应用程序的main()函数中：

// Create a vector of inputs.
std::vector<torch::jit::IValue> inputs;
inputs.push_back(torch::ones({1, 3, 224, 224}));
// Execute the model and turn its output into a tensor.
at::Tensor output = module.forward(inputs).toTensor();
std::cout << output.slice(/*dim=*/1, /*start=*/0, /*end=*/5) << '\n';

前两行设置了我们模型的输入。我们创建一个向量 torch::jit::IValue(类型擦除的值类型script::Module方法接受并返回），并添加单个输入。要创建输入张量，我们使用 torch::ones()，等效torch.ones于C++ API。然后，我们运行script::Module的forward方法，并将创建的输入向量传递给它。作为回报，我们得到一个新的IValue，通过调用将其转换为张量toTensor()。

小贴士要大致了解诸如torch::ones PyTorch C ++ API之类的功能，请参阅 https://pytorch.org/cppdocs 上的文档。PyTorch C ++ API提供了与Python API几乎相同的功能奇偶校验，使您可以像在Python中一样进一步操纵和处理张量。

在最后一行中，我们打印输出的前五个条目。由于在本教程前面的部分中，我们向Python中的模型提供了相同的输入，因此理想情况下，我们应该看到相同的输出。让我们通过重新编译应用程序并使用相同的序列化模型运行它来进行尝试：

Scanning dependencies of target example-app
[ 50%] Building CXX object CMakeFiles/example-app.dir/example-app.cpp.o
[100%] Linking CXX executable example-app
[100%] Built target example-app
root@4b5a67132e81:/example-app/build# ./example-app traced_resnet_model.pt
-0.2698 -0.0381  0.4023 -0.3010 -0.0448
[ Variable[CPUFloatType]{1,5} ]

作为参考，之前Python代码的输出是：

tensor([-0.2698, -0.0381,  0.4023, -0.3010, -0.0448], grad_fn=<SliceBackward>)

看起来很不错！

小贴士要将模型移至GPU内存，可以编写model.to(at::kCUDA);。通过调用来确保模型的输入也位于CUDA内存中tensor.to(at::kCUDA)，这将在CUDA内存中返回新的张量。

步骤5：获取帮助并探索API

希望本教程使您对PyTorch模型从Python到C++的路径有一个大致的了解。使用本教程中描述的概念，您应该能够从原始的“eager”的PyTorch模型，ScriptModule用Python 编译，在磁盘上序列化的文件，以及(关闭循环）到script::Module C++ 的可执行文件。

当然，有许多我们没有介绍的概念。例如，您可能会发现自己想要扩展ScriptModule使用C++或CUDA中实现的自定义运算符，并希望ScriptModule在纯C++生产环境中加载的内部执行此自定义运算符。好消息是：这是可能的，并且得到了很好的支持！现在，您可以浏览此文件夹中的示例，我们将很快提供一个教程。目前，以下链接通常可能会有所帮助：

Torch Script 参考: https://pytorch.org/docs/master/jit.html
PyTorch C++ API 文档: https://pytorch.org/cppdocs/
PyTorch Python API 文档: https://pytorch.org/docs/

与往常一样，如果您遇到任何问题或疑问，可以使用我们的论坛或GitHub问题进行联系。

在C ++中加载TorchScript模型