已合并
docs: 修正ATB_BUILD_DEPENDENCY_PATH及ABI判断说明(含README/FAQ/测试框架指南) #2136
docs: 修正ATB_BUILD_DEPENDENCY_PATH及ABI判断说明(含README/FAQ/测试框架指南) #2136
已合并
zouyanlong创建于 6月24日
zouyanlong成员
6月24日

描述

修正ATB_BUILD_DEPENDENCY_PATH及ABI判断说明(含README/FAQ/测试框架指南)

checklist

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 zouyanlong 的贡献)
CANN-robotCANN-robot成员
6月24日 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
6月24日 评论:

CLA Signature Pass

ninihihi, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robot
CANN-robot成员
6月24日 评论:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here
You can get sig-info at here


PR Approval Progress

Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
repo-cann/ascend-transformer-boost goodpeople233, 尹祺然 (2/2) 尹祺然 (1/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)
likedislike
CANN-robotCANN-robot成员
6月24日 添加了label:needs-issue
Zzouyanlong成员
6月24日 关联了issue:[Documentation]: [AI 识别] 文档未明确说明如何确定正确的cxx_abi版本(cxx_abi_0或cxx_abi_1),ATB_BUILD_DEPENDENCY_PATH示例中使用占位符cxx_abi_{cxx_abi_version},但缺乏判断方法说明。构建脚本默认输出到cxx_abi_1目录,若用户按示例设置错误的ABI路径会导致编译失败,需要通过试错才能确定正确版本
CANN-robot
CANN-robot成员
6月24日 评论:

Linking Issue Notice

@ninihihi , the pull request must be linked to at least one issue.
If an issue has already been linked, but the needs-issue label remains, you can remove the label by commenting /check-issue .

likedislike
CANN-robotCANN-robot成员
6月24日 删除了label:needs-issue
zouyanlong成员
6月24日 评论:

compile#openlibing

likedislike
zouyanlong成员
6月24日 评论:

compile

likedislike
CANN-robotCANN-robot成员
6月24日 添加了label:ci-pipeline-running
atomgit-bot
atomgit-bot
6月24日 评论:

变更摘要

此 PR 主要对 ATB 项目中与 ATB_BUILD_DEPENDENCY_PATH 环境变量及 ABI(CXX ABI)判断相关的文档说明进行修正和补充,涉及 README.mddocs/常见问题与回答.mddocs/测试框架指南.md 三份文档。变更聚焦于澄清 nnal 依赖路径的正确设置方式、ABI 版本(cxx_abi_0 / cxx_abi_1)的判定逻辑(结合 PyTorch 的 torch.compiled_with_cxx11_abi()),以及 ABI 切换后需执行 --clean-first 全量重编译的注意事项,确保用户能够正确配置编译环境并避免链接错误。

主要改动

  • 修正 ATB_BUILD_DEPENDENCY_PATH 设置说明:在 README.mddocs/常见问题与回答.md 中,明确了 nnal 安装在默认路径(/usr/local/Ascend/nnal/...)时无需手动设置该变量、脚本会自动匹配 ABI;非默认路径时须手动指向正确的 cxx_abi_{0|1} 子目录。
  • 补充 ABI 版本判定方法:在 docs/常见问题与回答.md 中新增了基于 PyTorch 安装状态的 ABI 判定流程——未安装 PyTorch 时默认使用 cxx_abi_1,已安装时通过 torch.compiled_with_cxx11_abi() 返回值确定 cxx_abi_0cxx_abi_1
  • 新增 ABI 切换后重编译警告:在 README.md(第 143 行)和 docs/测试框架指南.md(第 79 行)中分别补充了说明:切换 ABI 或 PyTorch 环境变更导致 ABI 判别结果改变时,必须重新设置 ATB_BUILD_DEPENDENCY_PATH 并执行 bash scripts/build.sh --clean-first 全量重编译,否则 CMake 缓存残留会导致链接错误。
  • 完善测试框架指南的编译失败排查表:在 docs/测试框架指南.md 的“常见编译失败”表格中修正了 libatb.so: undefined reference 错误的解决方案描述,明确指向 CXX ABI 版本一致性检查。
likedislike
atomgit-bot
atomgit-bot
6月24日 评论:

代码审查

✅ 未发现问题

likedislike
CANN-robotCANN-robot成员
6月24日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
6月24日 添加了label:ci-pipeline-passed
CANN-robot
CANN-robot成员
6月24日 评论:
流水线 PR-pipeline_ascend-transformer-boost#911 [ commitID:3e464bc8 ] 已完成
阶段 任务名 状态 详情
编译构建 Build_x86 >>>
Build_arm >>>
恶意代码检查 Antipoison >>>
编码安全与规范检查 CodeCheck >>>
开源片段检查 SCA >>>
开发者测试 UT_310P_x86 >>>
UT_910B_ARM >>>
流水线 PR-pipeline_ascend-transformer-boost >>>
likedislike
zouyanlong成员
6月24日 评论:

compile#openlibing

likedislike
CANN-robot
CANN-robot成员
6月24日 评论:

libing-pipeline创建中,请等待……

likedislike
CANN-robotCANN-robot成员
6月24日 添加了label:SC-START
CANN-robotCANN-robot成员
6月24日 删除了label:SC-START
CANN-robotCANN-robot成员
6月24日 添加了label:SC-RUNNING
CANN-robotCANN-robot成员
6月24日 删除了label:SC-RUNNING
CANN-robotCANN-robot成员
6月24日 添加了label:SC-RUNNING
CANN-robotCANN-robot成员
6月24日 删除了label:SC-RUNNING
CANN-robotCANN-robot成员
6月24日 添加了label:SC-SUCC
nino888成员
6月24日 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
6月24日 添加了label:approved
goodpeople233成员
6月24日 评论:

/lgtm

likedislike
CANN-robotCANN-robot成员
6月24日 添加了label:lgtm
CANN-robotCANN-robot成员
6月24日 合入了pull request