快捷键
1
2
3
4

设置 ExecuTorch

在本节中,我们将学习如何

  • 设置用于处理 ExecuTorch 的环境

  • 生成一个 ExecuTorch 示例程序

  • 构建并运行使用 ExecuTorch 运行时的程序

系统要求

操作系统

我们已在以下系统上测试了这些说明,尽管它们也应在类似的环境中工作。

Linux (x86_64)

  • CentOS 8+

  • Ubuntu 20.04.6 LTS+

  • RHEL 8+

macOS (x86_64/M1/M2)

  • Big Sur (11.0)+

Windows (x86_64)

  • Windows Subsystem for Linux (WSL) 以及任何 Linux 选项

软件

  • conda 或其他虚拟环境管理器

    • 我们推荐 conda,因为它提供跨语言支持并与 pip(Python 的内置包管理器)无缝集成。

    • 否则,Python 的内置虚拟环境管理器 python venv 也是一个不错的替代方案。

  • g++ 版本 7 或更高版本,clang++ 版本 5 或更高版本,或其他与 C++17 兼容的工具链。

请注意,可跨编译的核心运行时代码支持更广泛的工具链,低至 C++17。有关可移植性详细信息,请参阅 运行时概述

快速设置:Colab/Jupyter Notebook 原型

要充分利用 ExecuTorch,请按照下面提供的设置说明从源代码安装。

或者,如果您想快速轻松地试用 ExecuTorch,我们建议您使用以下 colab 笔记本 进行原型设计。您可以通过 pip 直接安装以获得基本功能。

pip install executorch

环境设置

创建虚拟环境

在您的机器上安装 conda。然后,创建一个虚拟环境来管理我们的依赖项。

# Create and activate a conda environment named "executorch"
conda create -yn executorch python=3.10.0
conda activate executorch

克隆并安装 ExecuTorch 要求

# Clone the ExecuTorch repo from GitHub
git clone -b release/0.4 https://github.com/pytorch/executorch.git
cd executorch

# Update and pull submodules
git submodule sync
git submodule update --init

# Install ExecuTorch pip package and its dependencies, as well as
# development tools like CMake.
# If developing on a Mac, make sure to install the Xcode Command Line Tools first.
./install_requirements.sh

使用 --pybind 标志 以 pybindings 和其他后端的依赖项进行安装。

./install_requirements.sh --pybind <coreml | mps | xnnpack>

设置环境后,您就可以将 PyTorch 程序转换为 ExecuTorch 了。

注意: 清理构建系统

获取上游存储库的新版本时(通过 git fetchgit pull),最好清理旧的构建工件。构建系统目前不适应构建依赖项的变化。

您还应更新并再次拉取子模块,以防其版本发生更改。

# From the root of the executorch repo:
rm -rf cmake-out pip-out
git submodule sync
git submodule update --init

创建 ExecuTorch 程序

设置环境后,您就可以将 PyTorch 程序转换为 ExecuTorch 了。

导出程序

ExecuTorch 提供了 API 来将 PyTorch nn.Module 编译成 ExecuTorch 运行时使用的 .pte 二进制文件。

  1. torch.export

  2. exir.to_edge

  3. exir.to_executorch

  4. 将结果保存为 .pte 二进制文件,供 ExecuTorch 运行时使用。

让我们尝试使用一个简单的 PyTorch 模型来添加其输入。

在 ExecuTorch 存储库之外的新目录中创建 export_add.py

注意:此文件不能位于 executorch 目录的父目录中。我们需要 python 从 site-packages 中导入,而不是从存储库本身导入。

mkdir -p ../example_files
cd ../example_files
touch export_add.py

将以下代码添加到 export_add.py

import torch
from torch.export import export
from executorch.exir import to_edge

# Start with a PyTorch model that adds two input tensors (matrices)
class Add(torch.nn.Module):
  def __init__(self):
    super(Add, self).__init__()

  def forward(self, x: torch.Tensor, y: torch.Tensor):
      return x + y

# 1. torch.export: Defines the program with the ATen operator set.
aten_dialect = export(Add(), (torch.ones(1), torch.ones(1)))

# 2. to_edge: Make optimizations for Edge devices
edge_program = to_edge(aten_dialect)

# 3. to_executorch: Convert the graph to an ExecuTorch program
executorch_program = edge_program.to_executorch()

# 4. Save the compiled .pte program
with open("add.pte", "wb") as file:
    file.write(executorch_program.buffer)

然后,从您的终端执行它。

python3 export_add.py

如果成功,您将在该目录中看到 add.pte

请参阅 ExecuTorch 导出教程,以了解有关导出过程的更多信息。

构建和运行

创建程序后,返回到 executorch 目录,使用 ExecuTorch 运行时执行它。

cd ../executorch

现在,让我们使用 executor_runner,这是一个使用 ExecuTorch 运行时在您的程序上运行 forward 方法的示例。

构建工具设置

ExecuTorch 存储库使用 CMake 构建其 C++ 代码。在这里,我们将配置它以构建 executor_runner 工具,以便在我们的桌面操作系统上运行它。

# Clean and configure the CMake build system. Compiled programs will
# appear in the executorch/cmake-out directory we create here.
(rm -rf cmake-out && mkdir cmake-out && cd cmake-out && cmake ..)

# Build the executor_runner target
cmake --build cmake-out --target executor_runner -j9

注意: 清理构建系统

获取上游存储库的新版本时(通过 git fetchgit pull),最好清理旧的构建工件。构建系统目前不适应构建依赖项的变化。

您还应更新并再次拉取子模块,以防其版本发生更改。

# From the root of the executorch repo:
rm -rf cmake-out pip-out
git submodule sync
git submodule update --init

运行您的程序

现在我们已经导出了一个程序并构建了运行时,让我们执行它!

./cmake-out/executor_runner --model_path ../example_files/add.pte

我们的输出是一个大小为 1 的 torch.Tensorexecutor_runner 将所有输入值设置为 torch.ones 张量,因此当 x=[1]y=[1] 时,我们得到 [1]+[1]=[2]

示例输出
Output 0: tensor(sizes=[1], [2.])

要了解如何构建类似的程序,请访问 运行时 API 教程

后续步骤

恭喜!您已成功导出、构建并运行了您的第一个 ExecuTorch 程序。现在您已经对 ExecuTorch 有了基本的了解,请探索其下面的高级功能和特性。

文档

访问 PyTorch 的全面开发者文档

查看文档

教程

获取针对初学者和高级开发人员的深入教程

查看教程

资源

查找开发资源并获得问题的解答

查看资源