Forward项目CMake构建指南：从环境准备到参数配置

前言

Forward是一个高性能的深度学习推理框架，支持多种主流框架模型的转换和优化。本文将详细介绍如何使用CMake构建Forward项目，包括环境准备、构建流程以及各种构建参数的详细说明。

环境准备

在开始构建Forward之前，需要确保系统满足以下基础环境要求：

1. CUDA环境

   • NVIDIA CUDA ≥ 10.0
   • CuDNN ≥ 7
   • 推荐版本：CUDA 10.2及以上

2. TensorRT

   • 版本要求 ≥ 7.0.0.11
   • 推荐版本：TensorRT-7.2.1.6

3. 构建工具

   • CMake ≥ 3.12.2
   • GCC ≥ 5.4.0
   • ld ≥ 2.26.1

4. 框架支持

   • PyTorch ≥ 1.7.0
   • TensorFlow ≥ 1.15.0（Linux用户需要特别注意）
   • Keras HDF5（默认从项目内源码构建）

详细构建步骤

1. 获取项目代码

首先需要获取Forward项目的源代码，可以通过版本控制工具获取最新代码。

2. TensorFlow依赖准备（仅Linux用户）

如果需要在Linux系统下使用TensorFlow支持，需要额外准备TensorFlow 1.15.0的库文件：

1. 进入项目目录下的tensorflow依赖目录
2. 下载预编译的TensorFlow 1.15.0库
3. 解压所有.so文件到指定目录

3. 创建构建目录

建议在项目根目录下创建独立的build目录进行构建：

mkdir -p build
cd build

4. 运行CMake配置

CMake配置是构建过程中最关键的一步，需要指定TensorRT的安装路径：

cmake .. -DTensorRT_ROOT=<path_to_TensorRT> -DENABLE_TENSORFLOW=ON -DENABLE_UNIT_TESTS=ON

5. 编译项目

使用make命令进行编译，-j参数可以加速编译过程：

make -j

6. 运行单元测试

编译完成后，建议运行单元测试验证构建是否成功：

cd bin/
./unit_test --gtest_filter=TestTfNodes.*

成功输出应显示所有测试用例通过。

CMake构建参数详解

Forward提供了丰富的CMake配置参数，可以根据需求灵活定制构建选项。

通用参数

1. TensorRT_ROOT（必需）

   • 指定TensorRT的安装路径
   • 无默认值，必须显式指定

2. ENABLE_PROFILING

   • 启用性能分析功能
   • 默认值：OFF

3. BUILD_PYTHON_LIB

   • 构建Python版本的Forward库
   • 启用时需要同时配置PYTHON_EXECUTABLE
   • 默认值：OFF

4. PYTHON_EXECUTABLE

   • 指定Python解释器路径
   • 应与工作环境中的Python版本一致

5. ENABLE_DYNAMIC_BATCH

   • 启用动态批次输入支持
   • 默认值：OFF

6. ENABLE_RNN

   • 启用RNN模型推理支持
   • 默认值：OFF

框架特定参数

PyTorch支持

1. ENABLE_TORCH

   • 启用PyTorch模型解析支持
   • 需要配置CMAKE_PREFIX_PATH或PYTHON_EXECUTABLE
   • 默认值：OFF

2. ENABLE_TORCH_PLUGIN

   • 启用Torch子模块插件
   • 可支持更多Torch操作，但性能不保证提升
   • 默认值：OFF

TensorFlow支持

1. ENABLE_TENSORFLOW
   • 启用TensorFlow模型解析支持
   • Linux用户需要额外准备TensorFlow 1.15.0库
   • 默认值：OFF

Keras支持

1. ENABLE_KERAS
   • 启用Keras模型解析支持
   • 需要配置HDF5库路径
   • 默认值：OFF

ONNX支持

1. ENABLE_ONNX
   • 启用ONNX模型解析支持
   • 默认值：OFF

构建建议

1. 多框架支持：可以同时启用多个框架支持，如同时构建PyTorch和TensorFlow支持。

2. 路径配置：当同时需要LibTorch和HDF5时，CMAKE_PREFIX_PATH可以用分号分隔多个路径。

3. Python版本：构建Python库时，确保PYTHON_EXECUTABLE指向的Python版本与使用环境一致。

4. 测试验证：建议始终启用单元测试，确保构建结果的正确性。

常见问题

1. TensorRT路径问题：最常见的构建失败原因是未正确指定TensorRT_ROOT路径。

2. 版本冲突：特别注意各依赖组件的版本要求，特别是CUDA、CuDNN和TensorRT的版本兼容性。

3. Python环境：当构建Python库时出现问题时，首先检查Python解释器路径是否正确。

通过本文的详细指南，开发者应该能够顺利完成Forward项目的构建，并根据实际需求灵活配置各种构建选项。