Merged
docs: 修正 masked_softmax_with_rel_pos_bias 算子 aclnn 接口文档中 attenMaskOptional 可空性与 161001 错误码描述矛盾 #13934
docs: 修正 masked_softmax_with_rel_pos_bias 算子 aclnn 接口文档中 attenMaskOptional 可空性与 161001 错误码描述矛盾 #13934
Merged
aiteerAdd on 13 days ago
aiteer
aiteerCollaborators
13 days ago

描述

修正 masked_softmax_with_rel_pos_bias 算子的 aclnn 接口文档,统一了中英文两个版本 aclnnMaskedSoftmaxWithRelPosBias.md / aclnnMaskedSoftmaxWithRelPosBias_en.md 中关于入参 attenMaskOptional 可空性的说明,使其与该接口的 161001(ACLNN_ERR_PARAM_NULLPTR)错误码描述保持一致,解决原文档中“允许为空”与“空指针会报错”之间的矛盾。

关联的Issue

#7390

测试

纯文档更新。

文档更新

更新了aclnnMaskedSoftmaxWithRelPosBias.md / aclnnMaskedSoftmaxWithRelPosBias_en.md文件。

类型标签

AI/Agent生成声明

likedislike
Pull Request has been successfully merged by CANN-robot.
(Thank you for aiteer's contribution.)
aiteeraiteerCollaborators
13 days ago Created pull request, commit eddfad12
aiteeraiteerCollaborators
13 days ago Associated issue: [Documentation|文档反馈]: aclnnMaskedSoftmaxWithRelPosBias 错误码表把 attenMaskOptional 空指针列为 161001,与同文档「mask 可不存在」矛盾
atomgit-bot
atomgit-bot
13 days ago Comments:

变更摘要

本 PR 为 norm/masked_softmax_with_rel_pos_bias 模块下的 aclnn 接口文档修正,统一了中英文两个版本 aclnnMaskedSoftmaxWithRelPosBias.md / aclnnMaskedSoftmaxWithRelPosBias_en.md 中关于入参 attenMaskOptional 可空性的说明,使其与该接口的 161001(ACLNN_ERR_PARAM_NULLPTR)错误码描述保持一致,解决原文档中“允许为空”与“空指针会报错”之间的矛盾。

主要改动

  • attenMaskOptional 参数说明补充可空语义:在参数表中该输入的 shape 描述后增加“允许传 nullptr,传 nullptr 时按无 mask 计算”(英文版为 "passing nullptr is allowed, which is equivalent to computing without a mask"),明确该输入为可选参数。
  • ACLNN_ERR_PARAM_NULLPTR(161001)触发条件收窄:将该错误码的说明由“传入的 x、attenMaskOptional、relativePosBias 或 out 是空指针”修改为“传入的 x、relativePosBias 或 out 是空指针”,移除 attenMaskOptional,消除与参数可空性描述的矛盾。
  • 中英文文档同步更新:上述两处修改在中文版与英文版文档中保持一致,保证两种语言文档的接口说明一致。

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

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

代码审查

✅ 未发现问题


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

likedislike
Incorrect?
CANN-robotCANN-robotCollaborators
13 days ago Added label: cann-cla/yes
CANN-robot
CANN-robotCollaborators
13 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
*/*/docs/acl*.md ✅ 陈娇, 上官秦南 (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

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

likedislike
CANN-robotCANN-robotCollaborators
13 days ago Set zengjuan,u010470851,chaotang233,kevin_huang1234,crystalhu,yangyang016,fanqirui,gitee-duhuiping,wangrui_,renruhai,su-yueming,zhajianqing123,yourealize,chenqi317,wang-xing001,liubo75,tangweiwei2,gitcode-chenjiao,chenxingyu18,liujie12345678,east_yang,pingchuantang,Chen_HaoWen,qianzehong,fengying555682,caiwenwen,yanglu-1 as approver
CANN-robotCANN-robotCollaborators
13 days ago Set gitee-duhuiping,gitcode-chenjiao,fengying555682,caiwenwen,yanglu-1 as approver
aiteer
aiteerCollaborators
13 days ago Comments:

compile

likedislike
aiteeraiteerCollaborators
13 days ago Pre merge succeeded (commit_id: 7fb0a105847b9a566ed7cfcbd473b67d25fb8a13)
CANN-robot
CANN-robotCollaborators
13 days ago Comments:
🚀 CI 流水线已启动
📋 执行详情: 点击查看流水线
likedislike
CANN-robotCANN-robotCollaborators
13 days ago Added label: ci-pipeline-running
CANN-robotCANN-robotCollaborators
13 days ago Removed label: ci-pipeline-running
CANN-robotCANN-robotCollaborators
13 days ago Added label: ci-pipeline-passed
aiteeraiteerCollaborators
13 days ago Modify description of pull request
yuning_chen
yuning_chenCollaborators
13 days ago Comments:

您好,pr合入已准备就绪,请尽快联系committer进行检视,谢谢!
@qianzehong @u010470851 @zengjuan @wangrui_ @yanglu-1 @gitcode-chenjiao @gitee-duhuiping @fengying555682 @caiwenwen

likedislike
aiteeraiteerCollaborators
12 days ago Change title to "docs: 修正 masked_softmax_with_rel_pos_bias 算子 aclnn 接口文档中 attenMaskOptional 可空性与 161001 错误码描述矛盾", originally titled "docs(masked_softmax_with_rel_pos_bias): 修正attenMaskOptional可空性与161001描述矛盾".
chenjiao
chenjiaoCollaborators
12 days ago Comments:

/approve

likedislike
CANN-robotCANN-robotCollaborators
12 days ago Added label: approved
sgqt12
sgqt12Collaborators
12 days ago Comments:

/lgtm

likedislike
CANN-robotCANN-robotCollaborators
12 days ago Added label: lgtm
CANN-robotCANN-robotCollaborators
12 days ago Closed associated issue
CANN-robotCANN-robotCollaborators
12 days ago Merged pull request