已关闭
[Documentation|文档反馈]: [AI 识别] 文档找到了一些描述不清晰的问题 #304
StoneChan_创建于  4月8日关闭于  4月9日
StoneChan_
StoneChan_成员
4月8日 创建

Thanks for sending an issue! Please fill in the following template to help quickly solve your problem.

Document Link(文档链接)

docs/下的文档

Issues Section(问题文档片段)

问题 ID 严重级别 关联项 文档位置 / 错误行 问题详细情况描述
P1 High C1 docs/zh/install/quick_install.md:54 Docker 拉取命令中的镜像 tag 写成 8. 5.0-910b-ubuntu22.04-py3.10-ops,中间含多余空格,命令按文档直接执行会报错。
P2 Medium C1 docs/zh/install/quick_install.md:56 x86 Docker 拉取命令同样存在 8. 5.0 空格问题,导致镜像地址无效。
P3 Medium C1 docs/zh/install/quick_install.md:165 小节标题为“检查CANN版本”,但正文未给出实际检查命令或步骤,用户会在环境验证处中断。
P4 High C9, C16 examples/add_example_aicpu/README.md:80 README 声明 AI CPU 示例支持图模式调用,但真实执行 bash build.sh --run_example add_example_aicpu graph cust --vendor_name=scanops 返回 Run graph failed,与文档承诺不一致。
P5 Medium C7 docs/zh/develop/aicpu_develop_guide.md:210 文本写“完整代码参见[add_example]目录”,链接目标实际是 examples/add_example_aicpu,链接文本与内容不一致,容易误导读者把 AI CPU 样例看成 AI Core 样例。
P6 High C13 docs/zh/debug/op_debug_prof.md:162 文档给出的仿真命令 msprof op simulator --output=$PWD/pipeline_auto --kernel-name"AddExample" ./test_aclnn_add_example 语法不成立。实测该写法会报 argument --kernel-name miss value;正确 CLI 顺序应将应用程序放在 simulator 后面。
P7 Medium C13, C14, U6 docs/zh/debug/cann_sim.md:180 图片链接 ../figures/指令流水图%20.png 对应文件存在两份一样的,但是有个有空格有个没空格。
P8 High C14 docs/zh/debug/cann_sim.md:1 当前 910B 环境下 cannsim --help 直接报 /usr/bin/bash: cannsim: command not found。文档正文虽写明 950-only,但对当前仓 README 的“仿真工具”入口来说,在当前环境不可执行。
P9 High C6 examples/add_example/tests/ut/op_host/test_add_example_tiling.cpp:39 真实执行 bash build.sh -u --ophost --ops=add_example --soc=ascend910b 失败。TilingContextPara 的构造调用与当前 tests/ut/common/tiling_context_faker.h 接口不兼容,说明开发文档/样例 UT 已与现代码漂移。
P10 Low C10 docs/zh/develop/aicore_develop_guide.md:124 示例 include 语句写成 #incldue,属于明显拼写错误,复制后会直接编译失败。
P11 Medium C18 docs/README.md:31 文档页自称“项目全量文档如下”,但实际未列出仓库中存在的 docs/QUICKSTART.mddocs/CONTRIBUTING_DOCS.md,目录说明不完整。
P12 Low C18 docs/README.md:26 目录树中写的是 README,实际文件名是 README.md,属于文档树展示不准确。
P13 Medium C19 README.md:50 顶层 README 写明 docs 目录“zh为中文,en为英文”,但实际 docs/ 下仅存在 zh/,没有 en/
P14 Medium C19 docs/zh/install/dir_structure.md:138 目录结构文档声明仓库根目录存在 version.info,当前实际仓库不存在该文件,实际可见的是 version.cmake
P15 Medium U3 README.md:19 “版本配套”只给出 release 仓入口,没有在当前页提供最小可用映射示例;用户需要额外跳转和检索,理解成本较高。

Existing Issues(存在的问题)

问题详情

P1 / P2:Docker 镜像 tag 含非法空格,按文档无法直接执行

  • 位置:docs/zh/install/quick_install.md:54docs/zh/install/quick_install.md:56
  • 文档原文:8. 5.0-910b-ubuntu22.04-py3.10-ops
  • 问题现象:镜像 tag 中 8.5.0 之间存在两个空格,Docker 会把它识别成非法镜像名。
  • 用户影响:按文档复制命令会立即失败,无法进入 Docker 快速部署流程。
  • 建议修复:统一改为 8.5.0-910b-ubuntu22.04-py3.10-ops,并与 docker run 小节保持完全一致。

P3:环境验证章节存在标题无内容的断点

  • 位置:docs/zh/install/quick_install.md:165
  • 问题现象:有“检查CANN版本”标题,但标题下没有命令、示例输出或说明。
  • 用户影响:用户无法判断应该查看 toolkit 版本、ops 版本,还是环境变量中的安装信息;验证链路中断。
  • 建议修复:补充至少一条可复制命令,并说明预期输出,例如读取 toolkit/ops 安装信息文件或版本命令。

P4:AI CPU 图模式样例与 README 承诺不一致

  • 位置:examples/add_example_aicpu/README.md:80
  • 文档承诺:README 调用说明表格中声明支持“图模式调用”。
  • 实际执行命令:bash build.sh --run_example add_example_aicpu graph cust --vendor_name=scanops
  • 实际结果摘要:命令返回码 255,日志末尾为 Run graph failed
  • 关键日志:
Start to run examples,name:add_example_aicpu mode:graph
Start compile and run examples file: ../examples/add_example_aicpu/examples/test_geir_add_example.cpp
INFO - [XIR]: Start to run ir compute graph
INFO - [XIR]: Run graph failed
  • 用户影响:开发者会按 README 认为 AI CPU graph 可直接验证,但真实环境无法跑通,属于高阻断问题。
  • 建议修复:
    • 若功能本就不支持,删除 README 中图模式承诺;
    • 若应支持,则需要补齐 graph 侧实现或修正样例工程。

P5:AI CPU 开发指南中的样例引用名错误

  • 位置:docs/zh/develop/aicpu_develop_guide.md:210
  • 问题现象:文案写“完整代码参见[add_example]目录”,但链接跳转目标实际是 examples/add_example_aicpu
  • 用户影响:阅读时容易把 AI CPU 样例和 AI Core 样例混淆,尤其在搜索目录时会误入 examples/add_example
  • 建议修复:链接文本和目录名保持一致,直接写成 add_example_aicpu

P6:仿真命令写法错误,实测会直接报参数错误

  • 位置:docs/zh/debug/op_debug_prof.md:162
  • 文档命令:
msprof op simulator --output=$PWD/pipeline_auto --kernel-name"AddExample" ./test_aclnn_add_example
  • 实际执行现象:该写法会被 CLI 解析成 --kernel-name 无值。
  • 实际报错:
2026-04-08 14:30:07 [ERROR] argument --kernel-name miss value
  • 进一步验证:改成 msprof op simulator ./test_aclnn_add_example --output="$PWD/pipeline_auto_scan" --kernel-name AddExample 后,命令可被正确解析,但当前环境继续报 simulator 库加载失败,说明文档至少存在“命令格式错误”这一明确问题。
  • 用户影响:用户第一步就无法成功启动仿真流程。
  • 建议修复:
    • 先修正文档命令顺序与参数空格;
    • 再补充 simulator 环境变量前置条件和适用芯片说明。

P7:仿真文档图片坏链

  • 位置:docs/zh/debug/cann_sim.md:180
  • 链接目标:../figures/指令流水图%20.png
  • 实际情况:docs/zh/figures/ 下存在 指令流水图.png指令流水图 .png,但不存在 URL 编码后的 指令流水图%20.png
  • 用户影响:页面中关键示意图无法展示,仿真结果查看说明不完整。
  • 建议修复:将链接改成实际存在的文件名,并避免文件名中出现尾空格版本的图片资源。

P8:仿真工具入口在当前 910B 环境不可执行

  • 位置:docs/zh/debug/cann_sim.md:1
  • 实际执行命令:cannsim --help
  • 实际结果:
/usr/bin/bash: cannsim: command not found
  • 说明:文档正文有写“仅支持 Ascend950PR”,但仓库 README 仍把“仿真工具”作为通用学习入口呈现,用户从 README 进入后很容易默认可在当前环境直接尝试。
  • 用户影响:对 910B/A2/A3 用户存在明显误导。
  • 建议修复:在 README 入口或标题中前置标注“仅 Ascend950PR 适用”。

P9:AddExample 的 op_host UT 与当前公共测试接口不兼容

  • 位置:examples/add_example/tests/ut/op_host/test_add_example_tiling.cpp:39
  • 实际执行命令:bash build.sh -u --ophost --ops=add_example --soc=ascend910b
  • 实际结果:UT 构建失败,未进入执行阶段。
  • 关键编译日志:
no known conversion for argument 5 from ‘AddExampleCompileInfo*’ to ‘const std::vector<unsigned int>&’
make[3]: *** ... test_add_example_tiling.cpp.o] Error 1
make[2]: *** ... cv_op_tiling_ut_cases_obj.dir/all] Error 2
make[1]: *** ... cv_op_host_ut.dir/rule] Error 2
make: *** [Makefile:1242: cv_op_host_ut] Error 2
  • 根因判断:test_add_example_tiling.cpp 中构造 gert::TilingContextPara 的参数顺序/签名仍是旧接口写法,而 tests/ut/common/tiling_context_faker.h 当前接口已变化。
  • 用户影响:开发指南中把该样例作为参考实现,但开发者按样例补 UT 时会直接编译失败。
  • 建议修复:同步更新样例 UT,使其匹配当前 TilingContextPara 构造签名。

P10:迁移附录存在可复制即失败的拼写错误

  • 位置:docs/zh/develop/aicore_develop_guide.md:124
  • 问题内容:#incldue 拼写错误。
  • 用户影响:用户如果直接复制示例 include 语句,会立即编译失败。
  • 建议修复:更正为 #include

P11 / P12:docs 目录索引文档与实际内容不一致

  • 位置:docs/README.md:26docs/README.md:31
  • 问题现象:
    • 目录树写的是 README,不是 README.md
    • 自称“项目全量文档如下”,但未列出 docs/QUICKSTART.mddocs/CONTRIBUTING_DOCS.md
  • 用户影响:从 docs/README.md 进入时,用户会漏看 QuickStart 和文档贡献规范这两个高价值入口。
  • 建议修复:补齐所有一级文档入口,并保证目录树与实际文件名完全一致。

P13 / P14:README 与目录结构文档都落后于实际仓结构

  • 位置:README.md:50docs/zh/install/dir_structure.md:138
  • 问题现象:
    • README 仍宣称 docs 下有 en,但实际只有 zh
    • 目录结构文档声明存在 version.info,仓库实际不存在该文件。
  • 用户影响:新用户按文档检索目录时会找不到对应路径,降低对文档准确性的信任。
  • 建议修复:按当前仓库一次性刷新 README 与目录结构文档,避免多处结构描述各自漂移。

P15:版本配套说明可理解但不够直达

  • 位置:README.md:19
  • 问题现象:当前只告诉用户去 release-management 仓查关系,没有给出最小示例或当前常见版本映射方式。
  • 用户影响:首次进入项目的用户往往不知道应看 branch、tag,还是 release 页面,存在认知断点。
  • 建议修复:在 README 直接补一段“如何查找配套 tag”的操作说明,哪怕只给 2~3 步示例也会明显改善体验。
likedislike
StoneChan_StoneChan_成员
4月8日 修改了issue 的描述
StoneChan_StoneChan_成员
4月8日 修改了issue 的描述
StoneChan_StoneChan_成员
4月8日 修改标题为 “[Documentation|文档反馈]: 文档找到了一些描述不清晰的问题”,原标题为“[Documentation|文档反馈]: quick_install.md问题”
StoneChan_StoneChan_成员
4月8日 修改了issue 的描述
StoneChan_StoneChan_成员
4月8日 修改了issue 的描述
liu-weiliu-wei成员
4月8日 将 liu-wei 设为负责人
liu-weiliu-wei成员
4月8日 关联了pull request:fix desctiption issues.
CANN-robotCANN-robot成员
4月9日 关闭了 issue
CANN-robotCANN-robot成员
4月9日 添加了label:resolved
StoneChan_StoneChan_成员
4月13日 修改标题为 “[Documentation|文档反馈]: [ai analysis] 文档找到了一些描述不清晰的问题”,原标题为“[Documentation|文档反馈]: 文档找到了一些描述不清晰的问题”
StoneChan_StoneChan_成员
4月13日 修改标题为 “[Documentation|文档反馈]: [AI 识别] 文档找到了一些描述不清晰的问题”,原标题为“[Documentation|文档反馈]: [ai analysis] 文档找到了一些描述不清晰的问题”