从源代码构建¶

ExecuTorch 使用 CMake 作为主要的构建系统。即使您不直接使用 CMake，CMake 也可以生成其他格式的脚本，例如 Make、Ninja 或 Xcode。更多信息请参阅 cmake-generators(7)。

系统要求¶

操作系统¶

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

Linux (x86_64)

CentOS 8+
Ubuntu 20.04.6 LTS+
RHEL 8+

macOS (x86_64/M1/M2)

Big Sur (11.0)+

Windows (x86_64)

带任意 Linux 选项的适用于 Linux 的 Windows 子系统 (WSL)

软件¶

conda 或其他虚拟环境管理器
- 我们推荐使用 conda，因为它提供跨语言支持并与 pip (Python 内置的包管理器) 无缝集成
- 或者，Python 内置的虚拟环境管理器 python venv 是一个不错的替代方案。
g++ 版本 7 或更高，clang++ 版本 5 或更高，或另一个兼容 C++17 的工具链。
python 版本 3.10-3.12

请注意，可交叉编译的核心运行时代码支持更广泛的工具链，最低可达 C++17。有关可移植性详细信息，请参阅运行时概览。

环境设置¶

克隆 ExecuTorch¶

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

创建虚拟环境¶

创建并激活 Python 虚拟环境

python3 -m venv .venv && source .venv/bin/activate && pip install --upgrade pip

或者，您可以在机器上安装 conda。然后，创建一个名为“executorch”的 Conda 环境。

conda create -yn executorch python=3.10.0 && conda activate executorch

从源代码安装 ExecuTorch pip 包¶

# 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_executorch.sh

使用--pybind 标志安装 pybindings 及其他后端的依赖项。

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

# Example: pybindings with CoreML *only*
./install_executorch.sh --pybind coreml

# Example: pybinds with CoreML *and* XNNPACK
./install_executorch.sh --pybind coreml xnnpack

默认情况下，./install_executorch.sh 命令会安装 XNNPACK 的 pybindings。要完全禁用所有 pybindings

./install_executorch.sh --pybind off

对于开发模式，请使用 --editable 运行命令，这允许我们修改 Python 源代码并立即看到更改。

./install_executorch.sh --editable [--pybind xnnpack]

# Or you can directly do the following if dependencies are already installed
# either via a previous invocation of `./install_executorch.sh` or by explicitly installing requirements via `./install_requirements.sh` first.
pip install -e .

如果修改了 C++ 文件，您仍然需要从源代码重新安装 ExecuTorch。

警告： 某些模块在可编辑模式下无法直接导入。这是一个已知问题，我们正在积极解决。要解决此问题
# This will fail
python -c "from executorch.exir import CaptureConfig"
# But this will succeed
python -c "from executorch.exir.capture import CaptureConfig"

注意： 清理构建系统

当获取上游仓库的新版本（通过 git fetch 或 git pull）时，最好清理旧的构建产物。构建系统目前对构建依赖项的变化适应性不佳。

您还应该再次更新和拉取子模块，以防它们的版本发生变化。
# From the root of the executorch repo:
./install_executorch.sh --clean
git submodule sync
git submodule update --init --recursive