Closed
[Documentation|文档反馈]: 修复 ops-nn QUICKSTART.md 文档扫描问题(11处) #8705
liujing987913Add on  9 days agoClosed at  4 days ago
liujing987913
liujing987913Collaborators
9 days ago Create

【文档链接】
https://gitcode.com/cann/ops-nn/blob/master/docs/QUICKSTART.md

【问题片段】
AIDD/文档质量扫描发现 ops-nn 仓 docs/QUICKSTART.md 存在 11 处文档问题,均已按"原文→修正"逐条核对并修改:

分类 修改前 修改后
Cod-3 代码块语言标签 编译成功回显块 ```bash ```output
参数名/括号 --vendor_name(可选):vendorname --vendor_name(可选):vendor_name
Con-4 行内代码标记 安装在${ASCEND_HOME_PATH}/opp/vendors 安装在${ASCEND_HOME_PATH}/opp/vendors
引导句缺冒号 请参见如下指导。 请参见如下指导:
引导句缺冒号 若提示如下信息,说明编译成功。 若提示如下信息,说明编译成功:
引导句缺冒号 取值如下,请按实际场景传参。(两处) ...传参:
漏字 确保运行时能够找到。 确保运行时能够找到对应库文件。
术语大小写 核心kernel实现文件 核心Kernel实现文件
术语大小写 构造相应的输入、输出tensor。 构造相应的输入、输出Tensor。
术语大小写 对应host侧数据vector的长度 对应Host侧数据Vector的长度

【存在的问题】
均为确定性低错(标点/术语/行内代码格式类),已核对修改,无功能/接口变更。

likedislike
liujing987913liujing987913Collaborators
9 days ago Added label: documentation
liujing987913liujing987913Collaborators
9 days ago Associated pull request
liujing987913
liujing987913Collaborators
9 days ago Comments:
likedislike
CANN-robotCANN-robotCollaborators
9 days ago Assign liujing987913 as responsible person
liujing987913liujing987913Collaborators
9 days ago Associated pull request
yuning_chen
yuning_chenCollaborators
5 days ago Comments:

文档与实际行为不一致,问题成立。建议以实际行为为准收敛资料(dtype/平台/约束/错误码),中英文与 README、aclnn 文档三处对齐,同族文档一并核对。

本条要点:【文档链接】

likedislike
liujing987913
liujing987913Collaborators
4 days ago Comments:
liujing987913
liujing987913Collaborators
4 days ago Comments:
likedislike
liujing987913liujing987913Collaborators
4 days ago changed custom state from 待办的 to 已完成
liujing987913liujing987913Collaborators
4 days ago Close issue