Closed
[Documentation|文档反馈]: 39个算子proto.h注释存在拼写与语法错误 #3234
sun-yibo1Add on Sep 18Closed at 14 days ago
Sep 20 Assign sun-yibo1 as responsible person
陈思
16 days ago Comments：
16 days ago Comments：
您好，感谢反馈！
已核对 cann/ops-math 提交 b19eaee4f58e5e1e3cb3b2ecbfed2d02c11c820a：SelectV2 原型注释仍有 condittion，AxpyV2 注释仍有 opratioan；Mul 的约束说明也将输入不兼容写成了约束条件。这些表述会影响原型资料的准确性，应区分纯拼写修正与约束语义修正。
已关联的 PR !5815 涉及 39 个原型文件，实际修改包括 condition、operation、Supports、An ND 等拼写/语法，以及将 Mul 约束明确为输入形状和类型必须兼容。该 PR 当前仍未合入；此单按资料一致性问题继续跟踪，涉及算子支持范围的说明仍以相应注册和实现为依据。
14 days ago Close issue
14 days ago Added label: resolved
一、文档链接 （必填）
以下 39 个算子原型注释文件（cann/ops-math master，基线 5a833dca6）：
math/{add,sub,mul,muls,div,real_div,floor_div,div_no_nan,pow,minimum,maximum,signbit,less,less_equal,greater,greater_equal,not_equal,equal,bias_add,squared_difference,lerp,logical_and,logical_or,bitwise_or,bitwise_and,bitwise_xor,tanh_grad,axpy,axpy_v2,addcmul,addcdiv,select,select_v2,mod,floor_mod,ger,gcd}/op_graph/*_proto.hconversion/clip_by_value/op_graph/clip_by_value_proto.h、conversion/clip_by_value_v2/op_graph/clip_by_value_v2_proto.h二、问题文档片段 （必填）
1. 拼写错误（4 处）
math/select_v2/op_graph/select_v2_proto.h:28：If condittion is true, outputs will be set as then. If condittion is false, ...（condittion → condition，2 处）math/axpy_v2/op_graph/axpy_v2_proto.h:34：whose shape is generated after 'x1', 'x2' broadcast opratioan.（opratioan → operation）conversion/clip_by_value/op_graph/clip_by_value_proto.h:27：... float32, float16, int16，（英文 dtype 列表中混入全角逗号）2. 系统性语法错误（历史模板复制扩散）
@brief ... Support broadcasting operations.（应为 Supports）：27 个文件A ND Tensor / A ND tensor（ND 以元音发音，应为 An ND）：33 个文件 97 处3. 单文件语法错误（约 71 处，节选）
The input x1 and x2 has to be a 1D vector.Inputs include:multiply the result by the scalar value and add it to...value: An required attribute.Returns the truth value of (x = y)y: A ND tensor with the same dtype of start's.A 1D tensor with size the C dimension of x:Returns x1 and x2 greatest common divisor element-wise.aicore accuracy is not guaranteedin the mini form./in the mini platform"x1" and "x2" have incompatible shapes or types.types:float16/"x1".The shapesCompatible with TensorFlow operator ...Elementwise computesthe Torch operator Gcd💡 存在的问题
以上均为注释（文档）缺陷，无代码逻辑影响；但 proto.h 注释会进入算子原型文档/接口说明生成链路，拼写与语法错误直接影响对外文档质量。修复 PR 见下方关联。
关联 PR：https://gitcode.com/cann/ops-math/pulls/5815