已合并
【docs】【9.1.0】调整基础API部分目录层级 #4552
Chen Ning创建于 7月23日
【docs】【9.1.0】调整基础API部分目录层级 #4552
已合并
Chen Ning创建于 7月23日
Chen Ning
Chen Ning成员
7月23日

描述

资料存在不能超过5级目录的约束,需要调整多个基础api资料目录的层级,并同步修改引用链接,包括https链接

关联的Issue

测试

文档更新

类型标签

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 Chen Ning 的贡献)
Chen NingChen Ning成员
7月23日 添加了label:documentation
Chen NingChen Ning成员
7月23日 创建了 pull request,commit 3834a669
atomgit-bot
atomgit-bot
7月23日 评论:

变更摘要

本次 PR 主要针对基础 API 文档进行目录层级调整,以解决文档目录深度超过 5 级的约束问题。变更涉及 348 个文件,通过移动/重命名文档文件来压缩目录层级,并同步更新所有受影响的内部引用链接及外部 HTTPS 链接,确保文档链接的有效性和一致性。

主要改动

  • 目录层级压缩:将基础 API 文档中超过 5 级深度的目录进行合并或上移,使整体目录结构符合"不超过 5 级"的约束要求,涉及大量文档文件的位置调整。
  • 内部引用链接同步更新:所有因文件移动而失效的内部交叉引用链接均已修正,确保文档内部的跳转关系保持一致。
  • HTTPS 链接同步修正:与目录结构调整相关的 HTTPS 外部链接也一并更新,避免因路径变更导致的外部链接失效。
likedislike
不准确?
atomgit-bot
atomgit-bot
7月23日 评论:

代码审查

审查总结

综述:本次 diff 对 docs/api/SIMD-API/基础API/ 目录进行了大规模的重构,主要是将 LocalTensor和GlobalTensor定义/ 中间层级删除(LocalTensor/GlobalTensor 提升到 数据结构/ 下),将 辅助数据结构/ 从 数据结构/ 下提升到 基础API/ 顶层,将 NumericLimits 从 工具接口/数学计算/ 重命名为 工具接口/数值边界/,将 CeilDivision 从 工具接口/数学计算/ 移动到 标量计算/。涉及 348 个文件的路径更新和 3 个文件的删除。

按优先级统计:

  • P0: 0
  • P1: 0
  • P2: 1(外部交叉引用断裂)
  • P3: 1(双斜杠路径修复, 非阻塞确认)

各文件审查结果:已逐文件审查所有 346 个变更文件。docs/api/ 范围内的所有相对链接均已正确更新至新的目录层级,索引文件(README.md / 基础API.md / 基础API列表.md / 数据结构.md / 工具接口.md / 标量计算.md 等)全部与新目录结构一致。大量重命名文件的内容无变更(如 LocalTensor/GlobalTensor 各子文件仅路径变更)。唯一发现的 P2 问题为 docs/guide/ 目录下的外部交叉引用尚未同步更新,需后续处理。

整体风险评估:中等。docs/api/ 内的重构是正确的,但对外部引用者(docs/guide/)有断裂风险。如果文档发布流水线支持重定向或后续有配套 PR 更新 docs/guide/,则此风险可控。

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

💬 仅评论

likedislike
不准确?
CANN-robotCANN-robot成员
7月23日 添加了label:cann-cla/yes
此处折叠了68条消息 查看更多
CANN-robot
CANN-robot成员
7月23日 评论:

流水线任务触发成功
任务链接 [777695779da647af87832599620f2972][流水线指导]

任务名称状态日志下载链接
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
pre_comment ✅ SUCCESS >>>>>
PreSmoke_A900_npupool ✅ SUCCESS >>>>>

[2026-07-23 19:10:12]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
7月23日 评论:

流水线任务触发成功
任务链接 [920a321cdf8f4c2680884ae6ce5071ca][流水线指导]

任务名称状态日志下载链接
pre_comment ✅ SUCCESS >>>>>
UT_Test_adv_test_one ✅ SUCCESS
UT_Test_adv_test_two ✅ SUCCESS
UT_Test_basic_test_two ✅ SUCCESS
UT_Test_basic_test_three ✅ SUCCESS
UT_Test_basic_test_four ✅ SUCCESS
UT_Test_basic_test_five ✅ SUCCESS
UT_Test_arm ✅ SUCCESS
UT_Test_report ✅ SUCCESS >>>>>

[2026-07-23 19:11:57]    CI执行结束

likedislike
CANN-robotCANN-robot成员
7月23日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
7月23日 添加了label:ci-pipeline-passed
CANN-robotCANN-robot成员
7月23日 合入了pull request