Pull Request已成功合入, 合并人@CANN-robot
(感谢 sunhao_hw 的贡献)变更摘要
本次 PR 是对部分文档样例关于 Ascend 950 支持情况的描述更新。主要包含两类改动:一是在快速入门文档中明确强调名称不带 ascend950 的样例仅支持 Atlas A2/A3 平台;二是补充 67_ascend950_batched_matmul 样例 README 中缺失的 Ascend 950 对应编译选项说明。
主要改动
- 快速入门文档补充平台限制说明:在
01_quick_start相关文档中新增说明,强调示例名称中未包含ascend950的样例仅支持 Atlas A2/A3,帮助用户避免在 Ascend 950 平台上错误使用不兼容的样例。 - 补充 Ascend 950 编译选项:为
67_ascend950_batched_matmul样例的 README 文档补齐了 Ascend 950 对应的编译选项,使文档描述与实际构建配置保持一致。


代码审查
经过全面审查,我对本次 diff 中全部 3 个文件的变更进行了分析。以下是审查结论:
审查结论
文件 1: docs/zh/1_Practice/01_quick_start.md
- 变更:第 51 行将"其他样例支持"改为"其他样例仅支持",强调非 ascend950 样例仅支持 Atlas A2/A3 产品。
- 评估:文档措辞优化,使语义更加精准,与下文架构标签说明一致。无安全问题、无误导性命令。
文件 2: examples/67_ascend950_batched_matmul/README.md
- 变更:第 19 行编译命令补充了缺失的
-DCATLASS_ARCH=3510参数。 - 评估:这是必要的修复——其他 ascend950 样例(62、56、73、74)的 README 中均已包含此编译选项,且
01_quick_start.md第 69 行和第 78 行均明确说明 ascend950 样例需要-DCATLASS_ARCH=3510。此变更使文档与代码行为一致,是一个正确的文档补全。无安全问题。
文件 3: examples/75_symm/README.md
- 变更:Markdown 格式化优化——为代码块添加
text语言标识符、将代码块正确缩进到有序列表项下、移除多余空行、将参数说明并入列表上下文。 - 评估:纯格式化改动,使 Markdown 渲染更规范。未引入任何不安全命令或错误信息。无问题。
总结
| 优先级 | 问题数 |
|---|---|
| P0 | 0 |
| P1 | 0 |
| P2 | 0 |
| P3 | 0 |
整体风险判断:无风险。 本次 diff 为纯文档更新,包含一处措辞澄清、一处缺失编译参数的补全、以及一处 Markdown 格式化优化。三个文件均无安全性、正确性或可靠性问题。
| 类型 | 数量 |
|---|---|
| 🔴 阻塞 | 0 |
| 🟡 建议 | 1 |
💬 仅评论


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/catlass | ✅ yuantao_, longjihui (2/2) | ✅ yuantao_ (1/1) |
💡 Tip:
- Committer can comment
/approveor/lgtm- Commenting
/approveimplies both code review (lgtm) and intent to merge (approve)
CLA Signature Pass
sunhao_hw, thanks for your pull request. All authors of the commits have signed the CLA. 👍


🟡 Medium Priority
此 diff 将第 51 行从"其他样例支持Atlas A2/Atlas A3产品"改为"其他样例仅支持Atlas A2/Atlas A3产品",使得非 ascend950 样例的声明变为排他性。然而,第 78 行(本次未修改)仍然写道:"以basic_matmul样例编译过程为例,执行下述指令(若为Ascend950,需要添加-DCATLASS_ARCH=3510)"——basic_matmul 的名称中不含"ascend950",按照新政策属于"其他样例"类别。第 78 行的旁注暗示 basic_matmul 可以在 Ascend950 上运行,这与第 51 行新增的"仅支持"排他性声明直接矛盾。用户阅读时会产生困惑:非 ascend950 样例到底能否在 Ascend950 上编译运行?
建议:将第 78 行的旁注移除或调整表述以与新政策保持一致。例如移除"(若为Ascend950,需要添加-DCATLASS_ARCH=3510)",或改为说明该选项仅适用于名称含 ascend950 的样例。


| 阶段 | 任务名 | 状态 | 详情 |
|---|---|---|---|
| 编译构建 | Build_arm | 🟨 | >>> |
| 恶意代码检查 | Antipoison | 🟨 | >>> |
| 编码安全与规范检查 | CodeCheck_pre-commit | ✅ | >>> |
| 开源片段检查 | SCA | ✅ | >>> |
| pre-commit | pre-commit | ✅ | >>> |
| static_check_markdownlint | 🟨 | >>> | |
| static_check_link_validity | 🟨 | >>> | |
| static_check_resource_check | 🟨 | >>> | |
| static_check_codespell_check | 🟨 | >>> | |
| static_check_tag_closed_check | 🟨 | >>> | |
| 开发者测试 | UT_arm | 🟨 | >>> |
| 流水线 | PR-pipeline_catlass | 🟨 | >>> |


文档检查门禁结果:


| 阶段 | 任务名 | 状态 | 详情 |
|---|---|---|---|
| 编译构建 | Build_arm | ✅ | >>> |
| 恶意代码检查 | Antipoison | ✅ | >>> |
| 编码安全与规范检查 | CodeCheck_pre-commit | ✅ | >>> |
| 开源片段检查 | SCA | ✅ | >>> |
| pre-commit | pre-commit | ✅ | >>> |
| static_check_markdownlint | ✅ | >>> | |
| static_check_link_validity | ✅ | >>> | |
| static_check_resource_check | ✅ | >>> | |
| static_check_codespell_check | ✅ | >>> | |
| static_check_tag_closed_check | ✅ | >>> | |
| 开发者测试 | UT_arm | ✅ | >>> |
| 流水线 | PR-pipeline_catlass | ✅ | >>> |


/lgtm
/approve


/lgtm


Pull Request 已合并或已关闭。
If you want to solve this problem, you can click here to do it in the FAQs.


描述
关联的Issue
原因
测试
文档更新
类型标签