已合并
fix: Modify the AIDD docs issue #8149
zwj223创建于 7月31日
fix: Modify the AIDD docs issue #8149
已合并
zwj223创建于 7月31日
zwj223
7月31日

描述

修改AIDD扫描的核心资料问题

关联的Issue

#3939

文档更新

类型标签

AI/Agent生成声明

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 zwj223 的贡献)
Zzwj223
7月31日 创建了 pull request,commit de96671f
Zzwj223
7月31日 关联了issue:[Documentation|文档反馈]: nn仓doc tools和aidd内容修改合入9.1.0专项
atomgit-bot
atomgit-bot
7月31日 评论:

变更摘要

该 PR 为一次文档更新(类型标签标记为「文档更新」),目标是修改 AIDD 扫描的核心资料问题,并关联 issue #3939。任务中未附带具体文件的补丁内容,无法定位到逐行的改动细节,以下摘要仅基于 PR 标题、PR 描述与类型标签得出,未对未提供的改动内容作任何推断。

主要改动

  • 核心资料问题修正:根据 PR 描述,本次修改针对 AIDD 扫描的核心资料问题进行修正,并关联 issue #3939。
  • 文档更新定位:PR 类型标签为「文档更新」,改动面向资料类内容,不涉及功能代码、接口或配置的逻辑变更。
  • 改动性质:从变更统计看,新增与删除行数大致相当,说明本次属于对既有文档内容的修订调整,而非新增章节或模块。
likedislike
atomgit-bot
atomgit-bot
7月31日 评论:

代码审查

关闭总结

发现统计

  • P1:1 个docs/zh/develop/torch_extension_develop_guide.md 第 159–163 行遗留未解决的 Git 合并冲突标记(<<<<<<< HEAD / ======= / >>>>>>> f7f0d44...),并重复了两条 pip install 指令,属于交付物数据一致性回归。
  • P2:1 个docs/zh/op_api_list.md 第 407 行误删了仍存在的 aclnnSleep 接口条目,与 docs/zh/menu_aclnn_api.mdcontrol/sleep 实际实现产生跨文件不一致。
  • P3:0 个

各文件审查结论

文件 结论
CHANGELOG.md no issues(语法/链接文字修正,正确)
SECURITY.md no issues(权限模式 700=rwx------ 修正正确;install_deps.sh 来源描述不精确但非安全问题,未报告)
codearts_check_rule_config.md no issues(中英文描述错位互换修正、错字、代码块外移,均正确)
docs/CONTRIBUTING_DOCS.md no issues
docs/QUICKSTART.md no issues(路径改为仓库相对路径,与文档其余引用一致,且文件真实存在)
docs/zh/context/aclnn_return_code.md no issues
docs/zh/context/compile_and_run_sample.md no issues
docs/zh/context/data_format.md no issues
docs/zh/context/non_contiguous_tensor.md no issues(引号样式变化,非问题)
docs/zh/debug/cann_sim.md no issues(bash 块内说明行加 # 注释,正确)
docs/zh/debug/op_debug_prof.md no issues(printf("%s", ...) 修正了格式串安全写法;路径与代码块一致)
docs/zh/develop/aicore_develop_guide.md no issues(#incldue#includeinputGMXinputGMX_(与类成员声明一致)、JSON 去除尾逗号(变为合法 JSON)、链接换行合并且路径存在,均正确)
docs/zh/develop/aicpu_develop_guide.md no issues(int32_t/kParamInvalid 与真实示例 add_example_aicpu.cpp 一致;${vendor_name}_nn 与文档自身 216/249–250 行一致)
docs/zh/develop/cross_platform_migration_guide.md no issues(repeatTimes 与循环体用法一致,属修正)
docs/zh/develop/graph_develop_guide.md no issues
docs/zh/develop/torch_extension_develop_guide.md P1:合并冲突标记
docs/zh/install/build.md no issues
docs/zh/install/dir_structure.md no issues
docs/zh/install/quick_install.md no issues
docs/zh/invocation/quick_op_invocation.md no issues(CMake 代码块语言标记由 bash 改为 cmake,正确)
docs/zh/op_api_list.md P2:aclnnSleep 行被删(其余改动如 BECLoss→BCELoss、LayerNormBackward 描述、TopKTopPSampleV2 列值均无法确认有误)
docs/zh/op_list.md no issues(<td>✓</td>0 乱字符删除、fast_gelu_v2/quant_max/grouped_quant_max/bidirection_lstmv2 显示名与目录一致、adaptive_max_pool2d 3维→2维正确、AddRmsNormDynamicQuant 描述与公式语义一致,均正确)

总体风险评估

本次 PR 是一次纯文档修订(修复 AIDD 扫描的格式/拼写/链接问题),绝大多数改动正确且有价值(修复了 printf 格式串写法、JSON 尾逗号、错别字、链接换行等)。但存在一处必须合入前修复的严重回归torch_extension_develop_guide.md 中遗留的 Git 合并冲突标记——这直接违背了本 PR 自身"修复扫描问题"的目标,且会让用户按文档执行命令失败;此外 op_api_list.md 误删 aclnnSleep 造成文档间不一致。整体风险中等,合入前应先解决冲突标记问题。

类型 数量
🔴 阻塞 1
🟡 建议 0

⛔ 需要修改

likedislike
CANN-robotCANN-robot成员
7月31日 添加了label:stat/needs-squash
此处折叠了113条消息 查看更多
chenqi317成员
29 天前 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
29 天前 添加了label:lgtm
CANN-robotCANN-robot成员
29 天前 解决了最后一个问题
CANN-robotCANN-robot成员
29 天前 合入了pull request
CANN-robot
CANN-robot成员
29 天前 评论:

Pull Request 已合并或已关闭。

If you want to solve this problem, you can click here to do it in the FAQs.

likedislike