TheRock 项目启动与配置教程

TheRock 项目启动与配置教程

TheRock The HIP Environment and ROCm Kit - A lightweight open source build system for HIP and ROCm 项目地址: https://gitcode.com/gh_mirrors/th/TheRock

1. 项目目录结构及介绍

TheRock 项目是一个轻量级开源构建系统，用于HIP和ROCm。项目目录结构如下：

• .github/：包含GitHub特有的工作流文件和配置。
• build_tools/：构建工具相关脚本，用于下载源码和打补丁。
• cmake/：CMake相关的配置文件。
• comm-libs/：通信库相关源码。
• compiler/：编译器相关的源码和配置。
• core/：核心组件的源码。
• dockerfiles/：Docker镜像的配置文件。
• docs/：项目文档。
• examples/：示例代码。
• external-builds/：外部构建项目的配置。
• math-libs/：数学库相关源码。
• ml-libs/：机器学习库相关源码。
• patches/：补丁文件，用于修改第三方库。
• profiler/：性能分析器相关源码。
• tests/：测试代码。
• third-party/：第三方依赖库。
• .gitignore：Git忽略文件。
• .gitmodules：Git子模块配置。
• CMakeLists.txt：CMake主配置文件。
• CONTRIBUTING.md：贡献者指南。
• LICENSE：项目许可证。
• README.md：项目说明。
• RELEASES.md：版本发布说明。
• ROADMAP.md：项目路线图。
• requirements-test.txt：测试环境依赖。
• requirements.txt：项目依赖。
• version.json：项目版本信息。

2. 项目的启动文件介绍

项目的启动主要通过以下文件进行：

• build_tools/fetch_sources.py：这个脚本是构建过程的起点，用于下载所有必要的源码和依赖。
• CMakeLists.txt：这是CMake的主配置文件，定义了项目的构建过程和依赖。

在启动项目时，通常首先需要设置Python虚拟环境并激活它，然后运行 fetch_sources.py 脚本来获取所有依赖，最后使用CMake来配置和构建项目。

3. 项目的配置文件介绍

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

• -DTHEROCK_AMDGPU_FAMILIES=xxx 或 -DTHEROCK_AMDGPU_TARGETS=xxx：指定AMDGPU的家族或目标。
• -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 用于启用GPU+主机编译器工具链。

配置项目时，可以使用CMake命令行工具，指定上述选项来定制构建过程。配置完成后，可以生成构建系统（如Ninja）并开始构建项目。

TheRock The HIP Environment and ROCm Kit - A lightweight open source build system for HIP and ROCm 项目地址: https://gitcode.com/gh_mirrors/th/TheRock