從原始碼構建¶

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