TheRock 项目启动与配置教程

1. 项目目录结构及介绍

TheRock 项目是一个轻量级的开源构建平台，用于 HIP 和 ROCm。以下是项目的目录结构及其简要介绍：

• .github/：包含 GitHub Actions 工作流程文件，用于自动化项目的构建、测试和发布流程。
• build_tools/：包含构建过程中使用的脚本和工具，如获取源代码、应用补丁等。
• cmake/：包含 CMake 相关的配置文件，用于定义项目的构建规则和依赖。
• comm-libs/：通信库相关代码和依赖。
• compiler/：GPU 和主机编译器工具链的代码和配置。
• core/：核心运行时组件和工具。
• dockerfiles/：Dockerfile 文件，用于创建包含项目和相关依赖的 Docker 镜像。
• docs/：项目文档。
• examples/：示例代码，展示如何使用 TheRock 平台。
• external-builds/：外部项目的构建脚本和配置，如 PyTorch。
• math-libs/：数学库相关代码和依赖。
• ml-libs/：机器学习库相关代码和依赖。
• patches/：包含项目所需的补丁文件。
• profiler/：分析器相关代码和工具。
• tests/：测试代码和测试用例。
• third-party/：第三方库和依赖。
• CONTRIBUTING.md：贡献者指南，介绍如何参与项目开发。
• LICENSE：项目许可证文件。
• README.md：项目简介和说明。
• RELEASES.md：发布说明文档。
• ROADMAP.md：项目路线图。
• requirements-test.txt 和 requirements.txt：项目测试和运行所需的 Python 依赖。

2. 项目的启动文件介绍

项目的启动主要通过 CMake 进行，以下是启动文件和相关步骤：

• CMakeLists.txt：CMake 的主配置文件，定义了项目的构建规则、依赖和功能。
• CMakePresets.json：CMake 预设配置文件，包含了构建项目时的一些默认设置。

启动项目的基本步骤如下：

1. 克隆项目仓库：

   git clone https://github.com/nod-ai/TheRock.git
   cd TheRock
   

2. 初始化 Python 虚拟环境并安装 Python 依赖：

   python3 -m venv .venv
   source .venv/bin/activate
   pip install -r requirements.txt
   

3. 下载子模块和应用补丁：

   python ./build_tools/fetch_sources.py
   

4. 使用 CMake 配置项目并构建：

   cmake -B build -GNinja
   

3. 项目的配置文件介绍

项目的配置主要通过 CMake 参数进行，以下是一些重要的配置参数：

• -DTHEROCK_AMDGPU_FAMILIES=xxx 或 -DTHEROCK_AMDGPU_TARGETS=xxx：指定支持的 GPU 架构。
• -DTHEROCK_ENABLE_ALL=OFF：禁用所有可选组件。
• -DTHEROCK_ENABLE_CORE=OFF：禁用所有核心组件。
• -DTHEROCK_ENABLE_COMM_LIBS=OFF：禁用所有通信库。
• -DTHEROCK_ENABLE_MATH_LIBS=OFF：禁用所有数学库。
• -DTHEROCK_ENABLE_ML_LIBS=OFF：禁用所有机器学习库。

此外，还有针对各个组件的单独启用/禁用参数，例如 -DTHEROCK_ENABLE_COMPILER=ON 用于启用编译器工具链。

通过在 CMake 配置阶段设置这些参数，可以自定义项目的构建配置。CMake 配置完成后，会打印出一个报告，展示所有启用的功能和标志。