OpenXLA IREE 项目从源码构建指南

OpenXLA IREE 项目从源码构建指南

iree A retargetable MLIR-based machine learning compiler and runtime toolkit. 项目地址: https://gitcode.com/gh_mirrors/ir/iree

前言

OpenXLA IREE 是一个开源的机器学习编译器运行时系统，能够将机器学习模型高效地编译并部署到各种硬件后端。本文将详细介绍如何从源码构建 IREE 项目，帮助开发者快速搭建开发环境。

环境准备

基础工具要求

构建 IREE 需要以下基础工具：

• CMake（3.18 或更高版本）
• Ninja（推荐作为构建系统）
• C/C++ 编译器（推荐使用 Clang 或 MSVC）

各平台具体安装

Linux 系统

# Debian/Ubuntu 系统安装示例
sudo apt install cmake ninja-build clang lld

macOS 系统

# 使用 Homebrew 安装
brew install cmake ninja

Windows 系统

1. 安装 Visual Studio 或 Visual Studio Build Tools
2. 安装 CMake 和 Ninja
3. 使用 vcvarsall.bat 初始化 MSVC 环境

获取源码

使用 Git 获取 IREE 源码并初始化子模块：

git clone https://github.com/iree-org/iree.git
cd iree
git submodule update --init

基础构建流程

配置构建系统

# 基本配置命令
cmake -G Ninja -B ../iree-build/ .

执行构建

cmake --build ../iree-build/

注意：完整构建可能需要较长时间（5-10分钟在高性能机器上），如果不需要编译器部分，可通过 -DIREE_BUILD_COMPILER=OFF 加速构建。

优化构建配置

各平台推荐配置

Linux 推荐配置

cmake -G Ninja -B ../iree-build/ -S . \
    -DCMAKE_BUILD_TYPE=RelWithDebInfo \
    -DIREE_ENABLE_ASSERTIONS=ON \
    -DIREE_ENABLE_SPLIT_DWARF=ON \
    -DIREE_ENABLE_THIN_ARCHIVES=ON \
    -DCMAKE_C_COMPILER=clang \
    -DCMAKE_CXX_COMPILER=clang++ \
    -DIREE_ENABLE_LLD=ON

macOS 推荐配置

cmake -G Ninja -B ../iree-build/ -S . \
    -DCMAKE_BUILD_TYPE=RelWithDebInfo \
    -DIREE_ENABLE_ASSERTIONS=ON \
    -DIREE_ENABLE_SPLIT_DWARF=ON \
    -DCMAKE_C_COMPILER=clang \
    -DCMAKE_CXX_COMPILER=clang++ \
    -DIREE_ENABLE_LLD=ON

Windows 推荐配置

cmake -G Ninja -B ../iree-build/ -S . \
    -DCMAKE_BUILD_TYPE=RelWithDebInfo \
    -DIREE_ENABLE_ASSERTIONS=ON

使用 ccache 加速构建

-DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache

组件配置

默认构建内容

默认构建包括：

• 中小型编译器目标（llvm-cpu、vulkan-spirv 等）
• 所有运行时 HAL 驱动
• 所有编译器输入格式
• 所有编译器输出格式

自定义配置示例

仅启用 CPU 后端

cmake -G Ninja -B ../iree-build/ -S . \
    -DIREE_TARGET_BACKEND_DEFAULTS=OFF \
    -DIREE_TARGET_BACKEND_LLVM_CPU=ON \
    -DIREE_HAL_DRIVER_DEFAULTS=OFF \
    -DIREE_HAL_DRIVER_LOCAL_SYNC=ON \
    -DIREE_HAL_DRIVER_LOCAL_TASK=ON

启用 CUDA 支持

cmake -G Ninja -B ../iree-build/ -S . \
    -DIREE_TARGET_BACKEND_CUDA=ON \
    -DIREE_HAL_DRIVER_CUDA=ON

测试与示例

运行测试

# 构建测试
cmake --build ../iree-build/ --target iree-test-deps

# 运行测试
ctest --test-dir ../iree-build/

运行示例程序

# 运行嵌入式示例
../iree-build/runtime/src/iree/runtime/demo/hello_world_embedded

# 使用开发者工具
../iree-build/tools/iree-compile --help
../iree-build/tools/iree-run-module --help

Python 绑定

环境准备

需要 Python 3.9 或更高版本，推荐使用虚拟环境：

python -m venv .venv
source .venv/bin/activate  # Linux/macOS
# 或 .venv\Scripts\activate.bat (Windows)

构建 Python 绑定

cmake -G Ninja -B ../iree-build/ \
  -DIREE_BUILD_PYTHON_BINDINGS=ON \
  -DPython3_EXECUTABLE="$(which python3)" \
  .

安装 Python 绑定

方法一：安装可编辑 wheel

CMAKE_INSTALL_METHOD=ABS_SYMLINK python -m pip install -e ../iree-build/compiler
CMAKE_INSTALL_METHOD=ABS_SYMLINK python -m pip install -e ../iree-build/runtime

方法二：扩展 PYTHONPATH

source ../iree-build/.env && export PYTHONPATH
python -c "import iree.compiler; help(iree.compiler)"

TensorFlow/TFLite 支持

python -m pip install -r integrations/tensorflow/test/requirements.txt
python -m pip install integrations/tensorflow/python_projects/iree_tf
python -m pip install integrations/tensorflow/python_projects/iree_tflite

结语

本文详细介绍了 OpenXLA IREE 项目的完整构建流程，从环境准备到测试运行，涵盖了各主流平台的具体配置方法。开发者可以根据实际需求选择不同的构建选项，灵活配置项目组件。

iree A retargetable MLIR-based machine learning compiler and runtime toolkit. 项目地址: https://gitcode.com/gh_mirrors/ir/iree