已关闭
[Documentation|文档反馈]: [AI 识别] 文档找到了一些描述不清晰的问题 #304
StoneChan_创建于 4月8日关闭于 4月9日
4月8日 修改了issue 的描述
4月8日 修改了issue 的描述
4月8日 修改标题为 “[Documentation|文档反馈]: 文档找到了一些描述不清晰的问题”,原标题为“[Documentation|文档反馈]: quick_install.md问题”
4月8日 修改标题为 “[Documentation|文档反馈]: 文档找到了一些描述不清晰的问题”,原标题为“[Documentation|文档反馈]: quick_install.md问题”
4月8日 修改了issue 的描述
4月8日 修改了issue 的描述
4月8日 将 liu-wei 设为负责人
4月8日 关联了pull request:fix desctiption issues.
4月9日 关闭了 issue
4月9日 添加了label:resolved
4月13日 修改标题为 “[Documentation|文档反馈]: [ai analysis] 文档找到了一些描述不清晰的问题”,原标题为“[Documentation|文档反馈]: 文档找到了一些描述不清晰的问题”
4月13日 修改标题为 “[Documentation|文档反馈]: [ai analysis] 文档找到了一些描述不清晰的问题”,原标题为“[Documentation|文档反馈]: 文档找到了一些描述不清晰的问题”
4月13日 修改标题为 “[Documentation|文档反馈]: [AI 识别] 文档找到了一些描述不清晰的问题”,原标题为“[Documentation|文档反馈]: [ai analysis] 文档找到了一些描述不清晰的问题”
4月13日 修改标题为 “[Documentation|文档反馈]: [AI 识别] 文档找到了一些描述不清晰的问题”,原标题为“[Documentation|文档反馈]: [ai analysis] 文档找到了一些描述不清晰的问题”
Thanks for sending an issue! Please fill in the following template to help quickly solve your problem.
Document Link(文档链接)
docs/下的文档
Issues Section(问题文档片段)
docs/zh/install/quick_install.md:548. 5.0-910b-ubuntu22.04-py3.10-ops,中间含多余空格,命令按文档直接执行会报错。docs/zh/install/quick_install.md:568. 5.0空格问题,导致镜像地址无效。docs/zh/install/quick_install.md:165examples/add_example_aicpu/README.md:80bash build.sh --run_example add_example_aicpu graph cust --vendor_name=scanops返回Run graph failed,与文档承诺不一致。docs/zh/develop/aicpu_develop_guide.md:210examples/add_example_aicpu,链接文本与内容不一致,容易误导读者把 AI CPU 样例看成 AI Core 样例。docs/zh/debug/op_debug_prof.md:162msprof op simulator --output=$PWD/pipeline_auto --kernel-name"AddExample" ./test_aclnn_add_example语法不成立。实测该写法会报argument --kernel-name miss value;正确 CLI 顺序应将应用程序放在simulator后面。docs/zh/debug/cann_sim.md:180../figures/指令流水图%20.png对应文件存在两份一样的,但是有个有空格有个没空格。docs/zh/debug/cann_sim.md:1cannsim --help直接报/usr/bin/bash: cannsim: command not found。文档正文虽写明 950-only,但对当前仓 README 的“仿真工具”入口来说,在当前环境不可执行。examples/add_example/tests/ut/op_host/test_add_example_tiling.cpp:39bash build.sh -u --ophost --ops=add_example --soc=ascend910b失败。TilingContextPara的构造调用与当前tests/ut/common/tiling_context_faker.h接口不兼容,说明开发文档/样例 UT 已与现代码漂移。docs/zh/develop/aicore_develop_guide.md:124#incldue,属于明显拼写错误,复制后会直接编译失败。docs/README.md:31docs/QUICKSTART.md、docs/CONTRIBUTING_DOCS.md,目录说明不完整。docs/README.md:26README,实际文件名是README.md,属于文档树展示不准确。README.md:50docs目录“zh为中文,en为英文”,但实际docs/下仅存在zh/,没有en/。docs/zh/install/dir_structure.md:138version.info,当前实际仓库不存在该文件,实际可见的是version.cmake。README.md:19Existing Issues(存在的问题)
问题详情
P1 / P2:Docker 镜像 tag 含非法空格,按文档无法直接执行
docs/zh/install/quick_install.md:54、docs/zh/install/quick_install.md:568. 5.0-910b-ubuntu22.04-py3.10-ops8.与5.0之间存在两个空格,Docker 会把它识别成非法镜像名。8.5.0-910b-ubuntu22.04-py3.10-ops,并与docker run小节保持完全一致。P3:环境验证章节存在标题无内容的断点
docs/zh/install/quick_install.md:165P4:AI CPU 图模式样例与 README 承诺不一致
examples/add_example_aicpu/README.md:80bash build.sh --run_example add_example_aicpu graph cust --vendor_name=scanops255,日志末尾为Run graph failed。P5:AI CPU 开发指南中的样例引用名错误
docs/zh/develop/aicpu_develop_guide.md:210examples/add_example_aicpu。examples/add_example。add_example_aicpu。P6:仿真命令写法错误,实测会直接报参数错误
docs/zh/debug/op_debug_prof.md:162msprof op simulator --output=$PWD/pipeline_auto --kernel-name"AddExample" ./test_aclnn_add_example--kernel-name无值。msprof op simulator ./test_aclnn_add_example --output="$PWD/pipeline_auto_scan" --kernel-name AddExample后,命令可被正确解析,但当前环境继续报 simulator 库加载失败,说明文档至少存在“命令格式错误”这一明确问题。P7:仿真文档图片坏链
docs/zh/debug/cann_sim.md:180../figures/指令流水图%20.pngdocs/zh/figures/下存在指令流水图.png和指令流水图 .png,但不存在 URL 编码后的指令流水图%20.png。P8:仿真工具入口在当前 910B 环境不可执行
docs/zh/debug/cann_sim.md:1cannsim --helpP9:AddExample 的 op_host UT 与当前公共测试接口不兼容
examples/add_example/tests/ut/op_host/test_add_example_tiling.cpp:39bash build.sh -u --ophost --ops=add_example --soc=ascend910btest_add_example_tiling.cpp中构造gert::TilingContextPara的参数顺序/签名仍是旧接口写法,而tests/ut/common/tiling_context_faker.h当前接口已变化。TilingContextPara构造签名。P10:迁移附录存在可复制即失败的拼写错误
docs/zh/develop/aicore_develop_guide.md:124#incldue拼写错误。#include。P11 / P12:docs 目录索引文档与实际内容不一致
docs/README.md:26、docs/README.md:31README,不是README.md;docs/QUICKSTART.md、docs/CONTRIBUTING_DOCS.md。docs/README.md进入时,用户会漏看 QuickStart 和文档贡献规范这两个高价值入口。P13 / P14:README 与目录结构文档都落后于实际仓结构
README.md:50、docs/zh/install/dir_structure.md:138docs下有en,但实际只有zh;version.info,仓库实际不存在该文件。P15:版本配套说明可理解但不够直达
README.md:19release-management仓查关系,没有给出最小示例或当前常见版本映射方式。