Star176
383
代码
代码
Issues77
Pull Requests137
Actions
项目讨论
Wiki
分析
Star176
383
已合并
docs: 按新目录结构重组 docs/zh #3175
犀牛创建于 13 天前
docs: 按新目录结构重组 docs/zh #3175
已合并
犀牛创建于 13 天前
从liuxi_/MindSpeed-MMdoc_reorg合入到Ascend/MindSpeed-MMmaster
犀牛
犀牛成员
13 天前

What this PR does / why we need it?

内容: docs/zh 按 introduction / guides / features / reference / tools 重新分类, 63 个文档调整位置
调整说明参考关联issue

一、目录结构

目录 内容
docs/zh/introduction 简介、目录结构、支持的模型、特性总览、快速实践
docs/zh/guides installation / practices / development / tuning / troubleshooting
docs/zh/features parallel / memory / optimization / training_mode / data / other
docs/zh/tools 权重转换、性能分析、评测等工具文档
docs/zh/reference 配置与参数说明(上游已有, 本次未动)

调整后 docs/zh/pytorch 目录移除, 其下文档按用途分别归入 introduction、guides 和 tools。

原中文名的两个文档一并改用英文文件名, 内容未改动:

原文件名 新文件名
docs/zh/快速实践.md docs/zh/introduction/quick_practice.md
docs/zh/features/特性总览.md docs/zh/introduction/feature_overview.md

二、内容或含义有变化的文档

原路径 修改方式 新路径 修改内容
docs/zh/introduction.md 修改文档 docs/zh/introduction/overview.md 「双后端支持」一节去掉中英文之间多余的空格, 与文档其余部分写法保持一致
docs/zh/dir_structure.md 修改文档 docs/zh/introduction/dir_structure.md 目录树中 docs/zh 一节按新结构更新; 移除已不存在的 UserGuide 条目
docs/zh/index.md 修改文档 原地 toctree 的 12 个条目改指新路径, 导航条数和顺序不变
docs/zh/pytorch/install_guide.md 修改文档 docs/zh/guides/installation/install_guide.md --msid 参数说明中「商用分支」改为「release版本」

其余 59 个文档为纯位置调整, 内容未改动。

另修正两处 master 既有的格式错误, 不涉及含义变化:

文档 问题 修正
docs/zh/features/feature_list.md 「并行特性」实际 9 行却写为 rowspan="10", 导致「显存优化」起整行错列 改为 rowspan="9"
docs/zh/guides/installation/install_guide.md 两处 <term> 标签前多一个 <; A3 段第二行误用 950 的镜像标签 去掉多余尖括号; 改为 a3 标签

Does this PR introduce any user-facing change?

文档在仓库中的路径变化, RTD 导航结构与条目不变。指向被移动文档的链接已全部同步更新, 包括 examples 下 35 个 README、仓库根 README、.agents 技能文档和 checkpoint/vlm_model/config.py。docs/en 本次不涉及, 仅更新其中指向 zh 被移动文档的 1 处路径。

How was this patch tested?

  • 已 rebase 到最新 master(c6558bf3), 上游在该区间内对 17 个文档的修改已全部保留, 逐文件比对无正文差异
  • 以映射表为基准做机械校验: 映射执行到位、docs/zh 无计划外增删、被移动文档除链接外逐字节未改、686 条链接解析目标不变、全仓无旧路径残留
  • 全仓链接可达性检查: docs/zh 断链 0 条(master 同口径为 10 条, 均指向已下线的示例目录, 本次改为指向 26.1.0 分支的固定地址); 剩余 12 条全部位于 docs/en, 与 master 一致, 非本次引入
  • sphinx 本地构建通过, 警告 119 条, 与 master 同口径构建的条数和类型完全一致; 导航 22 条且标题顺序与 master 一致
  • 指向已下线示例的 11 条绝对地址逐条核对, 目标目录在 26.1.0 分支上均真实存在
  • feature_list.md 表格按 rowspan 模拟格子占用, 35 行全部占满 3 列, 修正前有 1 行错列
  • 保留各文件原有换行符, 未产生无关的全文件改动
likedislike
Pull Request已成功合入, 合并人@ascend-robot
（感谢 犀牛 的贡献）
犀牛犀牛成员
13 天前 创建了 pull request，commit 33dd6461
atomgit-bot
atomgit-bot
13 天前 评论：

变更摘要

本次变更主要是对 docs/zh 目录按 introduction / guides / features / reference / tools 进行重新分类，共调整 63 个文档的位置，并同步更新指向被移动文档的引用路径。仓库中仅有 checkpoint/vlm_model/config.py 一处代码随文档位置变化而更新，其改动限于 docstring 中对 docs/zh/features/... 参考路径的指向调整。

主要改动

  • config.py 中 vpp 切分配置的参考路径前缀调整: docs/zh/features/ 下的文档路径统一增加 parallel/ 子目录，以匹配文档重新分类后的新目录结构。
  • llm_pp_layers 字段文档引用更新: 该字段 docstring 中的 vpp 切分配置参考路径由 docs/zh/features/virtual_pipeline_parallel.md 改为 docs/zh/features/parallel/virtual_pipeline_parallel.md。
  • vit_pp_layers 字段文档引用更新: 该字段 docstring 中的参考路径同步改为 docs/zh/features/parallel/virtual_pipeline_parallel.md。
  • audio_pp_layers 字段文档引用更新: 该字段 docstring 中的参考路径同步改为 docs/zh/features/parallel/virtual_pipeline_parallel.md。
likedislike
不准确？
atomgit-bot
atomgit-bot
13 天前 评论：

代码审查

✅ 未发现问题

likedislike
不准确？
ascend-robot
ascend-robot成员
13 天前 评论：
ascend-robotascend-robot成员
13 天前 添加了label：stat/needs-squash
此处折叠了150条消息 查看更多
犀牛犀牛成员
11 天前 关联了issue：[RFC]: 仓库文档优化
H
htwang成员
11 天前 评论：

同意合入

likedislike
H
htwang成员
11 天前 评论：

/approve

likedislike
ascend-robotascend-robot成员
11 天前 添加了label：approved
ascend-robotascend-robot成员
11 天前 合入了pull request