Merged
docs(apply_adam_v2): 补充 ACLNN 接口文档和调用示例 #14498
docs(apply_adam_v2): 补充 ACLNN 接口文档和调用示例 #14498
Merged
陈展熹Add on 6 days ago
陈展熹
陈展熹Collaborators
6 days ago

描述

为已启用的 ApplyAdamV2 ACLNN 接口补齐文档,承接已合入的 #14078。

  • 新增 optim/apply_adam_v2/docs/aclnnApplyAdamV2.md,说明两段式接口、参数顺序、varRef/mRef/vRef 原地更新、可选输入默认行为、产品支持、计算公式和使用约束。
  • 新增 test_aclnn_apply_adam_v2.cpp,给出完整的资源申请、接口调用、同步、结果读取及释放流程。
  • 在算子 README、ACLNN 目录和接口列表中增加入口。
  • 按当前源码注册范围说明 Ascend 950PR&950DT系列产品的接口支持,明确本表仅适用于本仓提供的 aclnnApplyAdamV2,其他调用方式参见算子说明。

关联的Issue

关联 #6540:[apply_adam_v2] 算子质量加固问题修复记录。

本PR补齐已合入PR #14078 的ACLNN接口文档和调用示例。

测试

  • 已更新到主线 67d7bc3c8642381e490641783d33a6edc3628caa。
  • 两个函数原型与自动生成的 aclnn_apply_adam_v2.h 逐参数核对一致。
  • 按文档写作规范核对产品命名、过滤标签、标题、表格、术语、LaTeX公式、编码及目录入口;13处新增仓内链接和锚点检查通过。
  • 内嵌C++示例与独立样例一致,两份源码均使用CANN 9.2公共头文件和此前构建的生成接口库,以 g++ -std=c++11 -Wall -Wextra -Werror 编译、链接通过。
  • 对原有5个文件及补充的英文README执行pre-commit,通过适用检查,包括 clang-format、codespell、OAT、空白及冲突标记检查;git diff --check 通过。
  • 使用 cann/.gitcode/actions/check-pr/dist/check_md_files.py 和配套白名单验证:旧提交复现缺少1个配对文件;本次修复后5个Markdown文件全部通过。中英文README的9组块级公式一致。
  • 本次未执行样例的设备运行,未将既有设备测试记录作为本次样例运行结果。

文档更新

  • 新增 ACLNN API 文档和完整 C++ 调用样例。
  • 更新算子 README、docs/zh/menu_aclnn_api.md、docs/zh/op_api_list.md。
  • 规范产品名称与术语,补充README中的标量 [] shape,说明梯度裁剪开关与可选步长,移除无法承诺的长期精度保证。
  • 同步 optim/apply_adam_v2/README_en.md,覆盖本PR的接口入口、支持范围、公式和约束修改,修复流水线run#19770的双语配对检查失败。

类型标签

AI/Agent生成声明

likedislike
Pull Request has been successfully merged by CANN-robot.
(Thank you for 陈展熹's contribution.)
陈展熹陈展熹Collaborators
6 days ago Created pull request, commit e4dfaf0a
atomgit-bot
atomgit-bot
6 days ago Comments:

变更摘要

本 PR 为已启用的 ApplyAdamV2 ACLNN 接口补齐文档交付件,承接此前合入的 #14078。主要新增 optim/apply_adam_v2/docs/aclnnApplyAdamV2.md 接口文档与 test_aclnn_apply_adam_v2.cpp 调用样例,说明两段式接口调用方式、参数顺序、varRef/mRef/vRef 原地更新语义、可选输入默认行为、产品支持范围、计算公式与使用约束,并在算子 README、docs/zh/menu_aclnn_api.md、docs/zh/op_api_list.md 中补充入口,使该接口具备可检索、可参照的文档与示例。

主要改动

  • 新增完整调用样例: 新增 optim/apply_adam_v2/examples/test_aclnn_apply_adam_v2.cpp,演示从 aclInit、aclrtSetDevice、aclrtCreateStream 到调用接口、同步取回结果并验证输出的端到端流程。
  • 明确接口入参与调用次序: 样例按 var、m、v、lr、beta1、beta2、epsilon、grad、maxGradNorm、globalGradNorm、weightDecay、stepSize 依次传入 12 个输入张量,并以 adamMode 字符串指定模式,调用 aclnnApplyAdamV2GetWorkspaceSize 与 aclnnApplyAdamV2 两段式接口。
  • 体现 workspace 与资源管理方式: 通过 workspaceSize 判断是否需要申请 workspace,并由 Resources 结构体的析构函数统一完成流同步、aclDestroyTensor、aclrtFree、aclrtDestroyStream、aclrtResetDevice 与 aclFinalize 的释放动作,样例内以 CheckStatus 统一处理返回状态。
  • 新增接口文档: 新增 aclnnApplyAdamV2.md,覆盖两段式接口说明、参数顺序、varRef/mRef/vRef 原地更新、可选输入默认行为、产品支持、计算公式与使用约束。
  • 补充文档索引入口: 在算子 README、docs/zh/menu_aclnn_api.md 与 docs/zh/op_api_list.md 中增加该接口文档的入口,并按当前主线注册范围说明 ascend950、ascend350 的 ACLNN 支持情况。

🧩 本次 Review 已使用自定义 Skill:

likedislike
Incorrect?
atomgit-bot
atomgit-bot
6 days ago Comments:

代码审查

✅ 未发现问题


🧩 本次 Review 已使用自定义 Skill:

likedislike
Incorrect?
CANN-robotCANN-robotCollaborators
6 days ago Added label: cann-cla/yes
CANN-robot
CANN-robotCollaborators
6 days ago Comments:

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

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

Module Approval Details

module lgtm status approve status
*/*/README.md ✅ 陈琦, 钱泽洪, 杨露 (3/2) ✅ 杨露 (1/1)
*/*/docs/acl*.md ✅ 杨露, 陈琦, 钱泽洪 (3/2) ✅ 杨露 (1/1)
docs ✅ 杨露, 陈琦 (2/2) ✅ 杨露 (1/1)
optim ✅ 陈琦, 钱泽洪 (2/2) ✅ 钱泽洪 (1/1)

💡 Tip:

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

CLA Signature Pass

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

likedislike
82 messages are collapsed here。 See more
陈展熹
陈展熹Collaborators
4 days ago Comments:
likedislike
qianzehong
qianzehongCollaborators
4 days ago Comments:

/lgtm
/approve

likedislike
CANN-robotCANN-robotCollaborators
4 days ago Added label: lgtmapproved
CANN-robotCANN-robotCollaborators
4 days ago Merged pull request
CANN-robot
CANN-robotCollaborators
4 days ago Comments:

Pull Request 已合并或已关闭。

If you want to solve this problem, you can click here to do it in the FAQs.

likedislike