已开启
[docs] 修正 AICPU AllGatherAdd README 中与 main.asc 不一致的函数名 #239
[docs] 修正 AICPU AllGatherAdd README 中与 main.asc 不一致的函数名 #239
已开启
NUAA_wqy创建于 2 天前
NUAA_wqy
NUAA_wqy
2 天前

描述

examples/aicpu/aicpu_builtin/02_allgather_add/ 的中文 README.md 和英文 README_en.md 中,流程图和步骤说明把 host 侧两个函数写成 HcclGetUnfoldThread 和 HcclStreamAcquireWithThread,但同一目录的 main.asc:110 和 main.asc:136 实际定义的是 GetUnfoldThread 和 AcquireUnfoldStream。用户按 README 把函数名复制进自己的 host 代码会找不到符号。

本 PR 将中英文 README 的流程图箭头和第 5 步说明中的函数名替换为与 main.asc 一致的 GetUnfoldThread / AcquireUnfoldStream,共 6 处(中文 3 处、英文 3 处)。其它内容不变。

变更类型

关联的Issue

#52

测试

已完成的测试用例和场景:

  1. rg -n 'HcclGetUnfoldThread|HcclStreamAcquireWithThread' examples/aicpu/aicpu_builtin/02_allgather_add/ 修复后 0 匹配;
  2. rg -n 'GetUnfoldThread|AcquireUnfoldStream' 修复后在 README.md / README_en.md / main.asc 三处出现且名称一致;
  3. 抽查 main.asc:191-192 的 HCCLCHECK(GetUnfoldThread(...)) / HCCLCHECK(AcquireUnfoldStream(...)) 调用点,与 README 修正后的函数名一致。

补充的UT用例:
NA(纯文档改动)

文档更新

本 PR 即文档修复。

合入检查

likedislike
合并受阻
NUAA_wqyNUAA_wqy
2 天前 创建了 pull request,commit 9783e3fa
NUAA_wqyNUAA_wqy
2 天前 关联了issue:[Documentation|文档反馈]: 修正 AICPU AllGatherAdd 文档函数名
atomgit-bot
atomgit-bot
2 天前 评论:

变更摘要

本 PR 为纯文档修正,聚焦 examples/aicpu/aicpu_builtin/02_allgather_add/ 目录下中文 README.md 与英文 README_en.md 中 host 侧函数名与同目录 main.asc 不一致的问题。原文在流程图箭头及第 5 步说明中使用的 HcclGetUnfoldThread、HcclStreamAcquireWithThread 替换为与 main.asc:110、main.asc:136 定义一致的 GetUnfoldThread 与 AcquireUnfoldStream,共修正 6 处,避免用户按文档复制后找不到符号。除函数名外其余内容保持不变。

主要改动

  • 修正中文 README.md 函数名: 将流程图箭头与第 5 步说明中的 HcclGetUnfoldThread、HcclStreamAcquireWithThread 改为 GetUnfoldThread、AcquireUnfoldStream,与 main.asc 定义及调用点一致。
  • 同步修正英文 README_en.md 函数名: 对英文文档中对应的流程图箭头与第 5 步说明做相同替换,保证中英文文档表述一致。
  • 统一文档与代码的接口命名: 修正后 README.md、README_en.md 与 main.asc 三处的函数名统一,消除文档示例无法匹配实际符号的问题。
likedislike
不准确?
atomgit-bot
atomgit-bot
2 天前 评论:

🤖 本次改动均为数据 / 生成 / 二进制文件(如测试用例、锁文件、媒体资源),没有可审查的代码逻辑,已跳过 AI 代码审查。

likedislike
不准确?
CANN-robot
CANN-robot成员
2 天前 评论:

Hi @NUAA_wqy, welcome to submitting your first PR to asc-comm!

PR Merge Steps

1. CLA Signing

If the current PR label includes cann-cla/yes, it means you have signed the CLA and can proceed to the next step. If the label includes cann-cla/no, please sign the CLA first. If you have any questions, please refer to the FAQ.

2. CI Check

Please comment /compile to trigger the CI pipeline check. If the CI run is successful, the PR will be tagged with ci-pipeline-passed and you can proceed to the next step. If the CI run fails, the PR will be tagged with ci-pipeline-failed, please check the CI logs to fix the issues in the PR. If you have any questions, please refer to the FAQ.

3. Code Review

After CI passes, please refer to the PR Approval Progress and proactively @ the committers in the table to review the code. After approval, committers will comment /lgtm and /approve. Once the lgtm and approved labels are successfully added, the PR will be merged automatically.

likedislike
CANN-robotCANN-robot成员
2 天前 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
2 天前 评论:

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.
You can self-configure the PR merge rules for this repository. For more details, please refer to Here.
For more, you also can visit HICANN.


PR Approval Progress

⚠️ This PR does not yet meet the following requirements:lgtm (requires ≥ 2 person(s) per module)、approve (requires ≥ 1 person(s) per module)

Module Approval Details

module lgtm status approve status
examples ❌ (0/2)(You can also ask: 诸葛洵, chenma, zhanghao_0689, jiangxinyu3, 黄金华) ❌ (0/1)(You can also ask: 肖婷, 闫庆尚, jiangxinyu3, bluesky901, qin437231)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

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

likedislike