Star0
0
Code
Code
Issues
Pull Requests
Actions
Discussion
Wiki
Analysis
Star0
0
cann-robotcann-robotdocs: 订正 bitwise_not、cholesky、cummin、topk 等 8 个算子资料及头文件注释
b7fe8ad8Add on 12 days agoHistory
FilesLast commitLast update
aclnnBitwiseNot.md
docs: 订正 bitwise_not、cholesky、cummin、topk 等 8 个算子资料及头文件注释 Co-authored-by: Nice_try<zhangzhiwei108@huawei.com> # message auto-generated for no-merge-commit merge: !6781 merge sync-1028 into master docs: 订正 bitwise_not、cholesky、cummin、topk 等 8 个算子资料及头文件注释 Created-by: Nice_try Commit-by: Nice_try Merged-by: cann-robot Description: ## 描述 本 PR 订正 8 个算子资料与头文件注释中与实现、产品支持情况不一致的描述。改动全部为文档（zh/en）与头文件注释，不涉及代码逻辑。 ### 改动原因 资料与头文件注释存在与实现、错误码表或产品支持情况互相矛盾的描述：dtype 列表漏项、产品支持范围与参数表结论不一致、参数语义描述错误、公式求和区间端点错误、退化点取值未声明等，逐条见「关联的Issue」。 ### 改动方法 1. **bitwise_not**（docs/aclnnBitwiseNot.md、aclnnBitwiseNot_en.md）：self、out 补充数据类型支持描述，与资料及实现对齐（#3950）。 2. **bitwise_or**（docs/aclnnBitwiseOrScalar&aclnnInplaceBitwiseOrScalar.md、_en.md）：self、other、selfRef补充数据类型支持描述，消除与产品支持情况分组的矛盾（#3995）。 3. **cdist_grad**（docs/aclnnCdistBackward.md、_en.md）：新增说明——上述闭式仅在 cdist > 0 时适用；当 cdist = 0（x1 与 x2 在该点对上完全重合）时，该点对对 x1 的梯度贡献按 0 处理（#3956）。 4. **cholesky**（docs/aclnnLinalgCholesky.md、_en.md）：产品支持情况中 Ascend 950PR&950DT 系列产品由「不支持」改为「支持」；self、out 的数据类型由「FLOAT、BFLOAT16」补充为「FLOAT、FLOAT16、BFLOAT16」（#3957）。 5. **cummin**（docs/aclnnCummin.md、_en.md）：self、valuesOut 的 dtype 约束由统一规则改为「具体数据类型关系见下方产品支持情况」，并在产品支持情况新增两条分组说明——Ascend 950PR&950DT 系列产品下 self 为 INT8/UINT8/BOOL 时 valuesOut 可为不同的可转换数据类型，其余数据类型需与 self 一致；Atlas A3/A2、Atlas 200I/500 A2、Atlas 推理、Atlas 训练系列产品下 self 的数据类型需能转换为 valuesOut 的数据类型（#3969）。 6. **grouped_bias_add_grad**（docs/aclnnGroupedBiasAddGrad.md、_en.md）：groupIdx 求和区间上端点由 groupIdxOptional(j) 改为不含端点的 groupIdxOptional(j)-1，j=0 分支同步改为 groupIdxOptional(0)-1；无可选输入时求和区间由 0 至 C 改为 0 至 C-1；文字说明中明确 groupIdxOptional(j) 表示第 j 组的结束位置（不包含）（#3948）。 7. **pow**（op_api/aclnn_pow.h 头文件注释）：out 的数据类型要求由「数据类型、数据格式和shape与self一致」改为「数据格式和shape需与self一致，数据类型需为self与exponent推导后可转换的数据类型」（#3959）。 8. **topk、topkV2**（docs/aclnnTopk.md、aclnnTopk_en.md、aclnnTopkV2.md、aclnnTopkV2_en.md 共 4 个文件）：largest 由「计算维度上的结果排序方式」改为「选取最大还是最小的 k 个值」；sorted 删除「当前该参数仅支持取 True」，改为 False 表示不要求输出有序，并明确不保证输出顺序及等值元素的索引稳定性（#3971）。 ## 关联的Issue https://gitcode.com/cann/ops-math/issues/3995 https://gitcode.com/cann/ops-math/issues/3971 https://gitcode.com/cann/ops-math/issues/3969 https://gitcode.com/cann/ops-math/issues/3959 https://gitcode.com/cann/ops-math/issues/3957 https://gitcode.com/cann/ops-math/issues/3956 https://gitcode.com/cann/ops-math/issues/3950 https://gitcode.com/cann/ops-math/issues/3948 ## 测试 - 本 PR 仅修改资料与头文件注释，不涉及代码逻辑，未做代码测试； - 资料改动需通过仓库资料门禁/评审校验。 ## 文档更新 - math/bitwise_not/docs/aclnnBitwiseNot.md、aclnnBitwiseNot_en.md - math/bitwise_or/docs/aclnnBitwiseOrScalar&aclnnInplaceBitwiseOrScalar.md、aclnnBitwiseOrScalar&aclnnInplaceBitwiseOrScalar_en.md - math/cdist_grad/docs/aclnnCdistBackward.md、aclnnCdistBackward_en.md - math/cholesky/docs/aclnnLinalgCholesky.md、aclnnLinalgCholesky_en.md - math/cummin/docs/aclnnCummin.md、aclnnCummin_en.md - math/grouped_bias_add_grad/docs/aclnnGroupedBiasAddGrad.md、aclnnGroupedBiasAddGrad_en.md - math/topk/docs/aclnnTopk.md、aclnnTopk_en.md、aclnnTopkV2.md、aclnnTopkV2_en.md - 头文件注释：math/bitwise_not/op_api/aclnn_bitwise_not.h、math/pow/op_api/aclnn_pow.h ## 类型标签 - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他，请描述： See merge request: cann/ops-math!6781
12 days ago
aclnnBitwiseNot_en.md
docs: 订正 bitwise_not、cholesky、cummin、topk 等 8 个算子资料及头文件注释 Co-authored-by: Nice_try<zhangzhiwei108@huawei.com> # message auto-generated for no-merge-commit merge: !6781 merge sync-1028 into master docs: 订正 bitwise_not、cholesky、cummin、topk 等 8 个算子资料及头文件注释 Created-by: Nice_try Commit-by: Nice_try Merged-by: cann-robot Description: ## 描述 本 PR 订正 8 个算子资料与头文件注释中与实现、产品支持情况不一致的描述。改动全部为文档（zh/en）与头文件注释，不涉及代码逻辑。 ### 改动原因 资料与头文件注释存在与实现、错误码表或产品支持情况互相矛盾的描述：dtype 列表漏项、产品支持范围与参数表结论不一致、参数语义描述错误、公式求和区间端点错误、退化点取值未声明等，逐条见「关联的Issue」。 ### 改动方法 1. **bitwise_not**（docs/aclnnBitwiseNot.md、aclnnBitwiseNot_en.md）：self、out 补充数据类型支持描述，与资料及实现对齐（#3950）。 2. **bitwise_or**（docs/aclnnBitwiseOrScalar&aclnnInplaceBitwiseOrScalar.md、_en.md）：self、other、selfRef补充数据类型支持描述，消除与产品支持情况分组的矛盾（#3995）。 3. **cdist_grad**（docs/aclnnCdistBackward.md、_en.md）：新增说明——上述闭式仅在 cdist > 0 时适用；当 cdist = 0（x1 与 x2 在该点对上完全重合）时，该点对对 x1 的梯度贡献按 0 处理（#3956）。 4. **cholesky**（docs/aclnnLinalgCholesky.md、_en.md）：产品支持情况中 Ascend 950PR&950DT 系列产品由「不支持」改为「支持」；self、out 的数据类型由「FLOAT、BFLOAT16」补充为「FLOAT、FLOAT16、BFLOAT16」（#3957）。 5. **cummin**（docs/aclnnCummin.md、_en.md）：self、valuesOut 的 dtype 约束由统一规则改为「具体数据类型关系见下方产品支持情况」，并在产品支持情况新增两条分组说明——Ascend 950PR&950DT 系列产品下 self 为 INT8/UINT8/BOOL 时 valuesOut 可为不同的可转换数据类型，其余数据类型需与 self 一致；Atlas A3/A2、Atlas 200I/500 A2、Atlas 推理、Atlas 训练系列产品下 self 的数据类型需能转换为 valuesOut 的数据类型（#3969）。 6. **grouped_bias_add_grad**（docs/aclnnGroupedBiasAddGrad.md、_en.md）：groupIdx 求和区间上端点由 groupIdxOptional(j) 改为不含端点的 groupIdxOptional(j)-1，j=0 分支同步改为 groupIdxOptional(0)-1；无可选输入时求和区间由 0 至 C 改为 0 至 C-1；文字说明中明确 groupIdxOptional(j) 表示第 j 组的结束位置（不包含）（#3948）。 7. **pow**（op_api/aclnn_pow.h 头文件注释）：out 的数据类型要求由「数据类型、数据格式和shape与self一致」改为「数据格式和shape需与self一致，数据类型需为self与exponent推导后可转换的数据类型」（#3959）。 8. **topk、topkV2**（docs/aclnnTopk.md、aclnnTopk_en.md、aclnnTopkV2.md、aclnnTopkV2_en.md 共 4 个文件）：largest 由「计算维度上的结果排序方式」改为「选取最大还是最小的 k 个值」；sorted 删除「当前该参数仅支持取 True」，改为 False 表示不要求输出有序，并明确不保证输出顺序及等值元素的索引稳定性（#3971）。 ## 关联的Issue https://gitcode.com/cann/ops-math/issues/3995 https://gitcode.com/cann/ops-math/issues/3971 https://gitcode.com/cann/ops-math/issues/3969 https://gitcode.com/cann/ops-math/issues/3959 https://gitcode.com/cann/ops-math/issues/3957 https://gitcode.com/cann/ops-math/issues/3956 https://gitcode.com/cann/ops-math/issues/3950 https://gitcode.com/cann/ops-math/issues/3948 ## 测试 - 本 PR 仅修改资料与头文件注释，不涉及代码逻辑，未做代码测试； - 资料改动需通过仓库资料门禁/评审校验。 ## 文档更新 - math/bitwise_not/docs/aclnnBitwiseNot.md、aclnnBitwiseNot_en.md - math/bitwise_or/docs/aclnnBitwiseOrScalar&aclnnInplaceBitwiseOrScalar.md、aclnnBitwiseOrScalar&aclnnInplaceBitwiseOrScalar_en.md - math/cdist_grad/docs/aclnnCdistBackward.md、aclnnCdistBackward_en.md - math/cholesky/docs/aclnnLinalgCholesky.md、aclnnLinalgCholesky_en.md - math/cummin/docs/aclnnCummin.md、aclnnCummin_en.md - math/grouped_bias_add_grad/docs/aclnnGroupedBiasAddGrad.md、aclnnGroupedBiasAddGrad_en.md - math/topk/docs/aclnnTopk.md、aclnnTopk_en.md、aclnnTopkV2.md、aclnnTopkV2_en.md - 头文件注释：math/bitwise_not/op_api/aclnn_bitwise_not.h、math/pow/op_api/aclnn_pow.h ## 类型标签 - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他，请描述： See merge request: cann/ops-math!6781
12 days ago