| Files | Last commit | Last update |
|---|---|---|
docs: 重写Log1p/Rsqrt/Sin/MaskedScale/RsqrtGrad算子README为算子级文档,去除与aclnn API文档重复内容;修正RsqrtGrad复制自SqrtGrad未改名问题,fix#3606 Co-authored-by: ywx1080114<yuanbin22@huawei.com> # message auto-generated for no-merge-commit merge: !6402 merge doc-readme-dedup-fix into master docs: 重写Log1p/Rsqrt/Sin/MaskedScale/RsqrtGrad算子README为算子级文档,去除与aclnn API文档重复内容;修正RsqrtGrad复制自SqrtGrad未改名问题,fix#3606 Created-by: yuanbin_22 Commit-by: ywx1080114 Merged-by: cann-robot Description: ## 描述 将 5 个算子的 README 重写为算子级文档(功能说明/参数说明/约束说明/调用说明),去除与 docs/ 下 aclnn API 文档重复的函数原型、两段式接口参数说明、返回值与错误码内容(fix #3606);并修正 RsqrtGrad README 复制自 SqrtGrad 未改名的问题。 ### 1. README 重写为算子级文档(去除与 aclnn API 文档重复内容) - **math/log1p/README.md**(+44 -85):标题 aclnnLog1p&aclnnInplaceLog1p → Log1p;删除函数原型与 aclnnLog1p/aclnnInplaceLog1p 两段式接口详细说明;新增参数说明表(x/y:FLOAT、FLOAT16、BFLOAT16,与 log1p_def.cpp 一致);调用说明指向 examples 与 docs/aclnnLog1p&aclnnInplaceLog1p.md。 - **math/rsqrt/README.md**(+43 -85):同上模式重写,计算公式 y = 1/√x,参数 x/y:FLOAT、FLOAT16、BFLOAT16。 - **math/sin/README.md**(+4 -75):参数名规范化(self→x、out→y);删除 aclnnSin/aclnnInplaceSin 两段式接口详细说明;保留 BFLOAT16 支持范围备注。 - **math/masked_scale/README.md**(+56 -50):新增参数说明表(x/y:FLOAT16、BFLOAT16、FLOAT;mask:INT8、UINT8、FLOAT16、FLOAT;scale 属性:FLOAT);公式变量名与参数表对齐(self→x、out→y)。 - **math/rsqrt_grad/README.md**(+15 -13):重写为算子级文档并修正复制错误(见下)。 ### 2. 修正 RsqrtGrad 复制自 SqrtGrad 未改名问题 - **README.md**: - 标题 SqrtGrad → RsqrtGrad;算子功能「完成梯度平方根计算」→「Rsqrt算子的反向梯度计算」 - 计算公式 z = dy * 0.5 / y → z = -0.5 × dy × y³(y 为 Rsqrt 前向输出) - 参数数据类型由 SqrtGrad 的 DT_FLOAT/DT_FLOAT_16/DT_COMPLEX128/DT_COMPLEX64/DT_DOUBLE 修正为 BFLOAT16、FLOAT16、FLOAT、INT8、INT32(与 rsqrt_grad_def.cpp 的 DataType 声明一致) - 产品支持修正为 Ascend 950PR&950DT √ / Atlas A3 × / Atlas A2 ×(rsqrt_grad_def.cpp 仅 AddConfig ascend950/ascend350) - 算子 IR 链接由 ../sqrt_grad/op_graph/sqrt_grad_proto.h 修正为 ../op_graph/rsqrt_grad_proto.h - **examples/test_geir_sqrt_grad.cpp → test_geir_rsqrt_grad.cpp**(重命名,R095):include 的 proto 头文件、宏内变量名 sqrtGrad→rsqrtGrad 等同步修正。 ## 关联的Issue - #3606 ## 测试 - 纯文档与示例代码改名变更,无算子逻辑修改,不涉及编译与功能测试 - 已核对 log1p_def.cpp / rsqrt_grad_def.cpp 的 DataType 与 AICore AddConfig 声明,确认 README 中数据类型与产品支持情况与代码一致 ## 文档更新 - math/log1p/README.md - math/rsqrt/README.md - math/sin/README.md - math/masked_scale/README.md - math/rsqrt_grad/README.md - math/rsqrt_grad/examples/test_geir_sqrt_grad.cpp → test_geir_rsqrt_grad.cpp(重命名) ## 类型标签 - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他,请描述: See merge request: cann/ops-math!6402 | 30 days ago |