Pull Request has been successfully merged by CANN-robot.
(Thank you for 陈展熹's contribution.)变更摘要
本 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:




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
/approveor/lgtm- Commenting
/approveimplies 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. 👍


/lgtm
/approve


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


描述
为已启用的 ApplyAdamV2 ACLNN 接口补齐文档,承接已合入的 #14078。
optim/apply_adam_v2/docs/aclnnApplyAdamV2.md,说明两段式接口、参数顺序、varRef/mRef/vRef原地更新、可选输入默认行为、产品支持、计算公式和使用约束。test_aclnn_apply_adam_v2.cpp,给出完整的资源申请、接口调用、同步、结果读取及释放流程。aclnnApplyAdamV2,其他调用方式参见算子说明。关联的Issue
关联 #6540:[apply_adam_v2] 算子质量加固问题修复记录。
本PR补齐已合入PR #14078 的ACLNN接口文档和调用示例。
测试
67d7bc3c8642381e490641783d33a6edc3628caa。aclnn_apply_adam_v2.h逐参数核对一致。g++ -std=c++11 -Wall -Wextra -Werror编译、链接通过。git diff --check通过。cann/.gitcode/actions/check-pr/dist/check_md_files.py和配套白名单验证:旧提交复现缺少1个配对文件;本次修复后5个Markdown文件全部通过。中英文README的9组块级公式一致。文档更新
docs/zh/menu_aclnn_api.md、docs/zh/op_api_list.md。[]shape,说明梯度裁剪开关与可选步长,移除无法承诺的长期精度保证。optim/apply_adam_v2/README_en.md,覆盖本PR的接口入口、支持范围、公式和约束修改,修复流水线run#19770的双语配对检查失败。类型标签
AI/Agent生成声明