Closed
[Documentation|文档反馈]: 修改大模型扫描文档问题:opbase 接口文档错别字/标点/多字修正(26处) #586
liujing987913Add on  11 days agoClosed at  10 days ago
liujing987913
11 days ago Create

Document Link(文档链接)

opbase 仓 docs/zh/api/nnopbase/opdev/ 下 23 个文档(接口列表、常用宏和类、common_types、format_utils、op_executor、small_vector、tensor_view_utils、shape_utils、L0 等)

Issues Section(问题文档片段)

【问题片段】(原文 → 修改后,共 26 处,节选)

  1. 必需要调用此宏创建 → 需要调用此宏创建(多字)
  2. 判断float类型数值x是不是非正常数 → 是不是非数(NaN)(多字)
  3. 他们组装为一个aclTensorList → 它们组装为一个aclTensorList(同音字)
  4. 中"ge命名空间 > DataType"。→ 中"ge命名空间 > DataType"。(引号未成对)

Existing Issues(存在的问题)

【存在的问题】
大模型扫描发现 opbase 接口文档 26 处问题,已修正:多字错误 16 处、同音字错误 5 处、标点引号未成对 5 处;修改为确定性文本替换,不影响文档结构。具体清单见关联 PR。

likedislike
Lliujing987913
11 days ago Associated pull request
CANN-robotCANN-robotCollaborators
10 days ago Close issue
CANN-robotCANN-robotCollaborators
10 days ago Added label: resolved
ren-botaoCollaborators
6 days ago Comments:
likedislike
CANN-robotCANN-robotCollaborators
6 days ago Assign liujing987913 as responsible person
CANN-robotCANN-robotCollaborators
6 days ago changed custom state from 进行中 to 已完成
liujing987913
6 days ago Comments:

本次涉及的文档改动:
修正多余字符与重复用词:如 1_opdev_api_introduction.md 中 TransData 描述删除多余的“j”,Reshape.md 删除“算子”,OP_ATTR_NAMES.md 将“属性名字”改为“属性名”,small_vector.md 修正 push_back、InitStorage 的冗余表述。
修正同音字误用:将“他们”统一改为“它们”(AllocScalarList.md、AllocTensorList.md、BroadcastInferShape.md),“他的”改为“它的”(IsEmpty.md),“在初始化内存”改为“再初始化内存”(small_vector.md)。
补全并修正引用中的引号:GetOriginalShape.md、GetStorageShape.md、GetViewShape.md、GetStorageFormat.md、SetData.md 中的文档链接说明统一改为成对的中文引号,并修正 GetStorageFormat.md 中重复的加粗标记与冒号。
统一术语与参数表述:float_isnan 的说明改为“非数(NaN)”,GetPrimaryFormat.md 中参数描述由“原始目标数据格式”改为“原始数据格式”,AbandonCache.md 中“aclnn cache缓存功能”改为“aclnn cache功能”,Transpose.md 中“dim维度”改为“维度”。
示例注释语句通顺性调整:ADD_TO_LAUNCHER_LIST_AICPU.md 删除示例注释中重复的属性参数说明,IsContiguous.md 修正注释中多余的“当”字。
修复改动已经上库。

likedislike