Skip to content

docs(mmengine): 迁移 Quick Start 至 Markdown 并接入看护 - #256

Merged
hipudding merged 1 commit into
Ascend:mainfrom
Devin-DC-Huang:feat/mmengine-quick-start
Oct 27, 2026
Merged

hipudding merged 1 commit into
Ascend:mainfrom
Devin-DC-Huang:feat/mmengine-quick-start

Conversation

@Devin-DC-Huang

Copy link
Copy Markdown
Contributor

从 workflows 仓库的 projects/mmengine/docs/Quick-start-Ascend.md 迁移,文档主体(17 段 NPU 冒烟)与 #test 标签原样保留,看护按原验证过的预期输出执行。

  • H1 用项目名,「检查前置是否满足」提升为「前置安装」小节,文末补「外部链接」;conf.py exclude_patterns 排除该 md。
  • 首页新增 mmengine 卡片(图标取 OpenMMLab 官方 avatar),toctree 收进「训练与微调框架」。
  • 接入 tests/mmengine 看护与 .github/workflows/mmengine-quick-start.yml:单卡 a2-1,CANN 9.1.0 镜像(torch 2.9.0 / torch_npu 2.9.0.post2 栈,与 accelerate 一致),60 min 超时。
  • 定时按全仓统一的一天两次方案(PR ci(quick-start): 定时统一为一天两次(间隔 12 小时)并相互错开 #255)取空闲槽位 40 10,22 * * *:与当前 main 的 40 */3(0,3,…,21 时)和 40 */12(0,12 时)不撞,与 PR ci(quick-start): 定时统一为一天两次(间隔 12 小时)并相互错开 #255 槽位表里的 (6,18)/(7,19)/(8,20) 三个 :40 也不撞。

本地验证:契约解析(29 命令 / 21 预期结果)、全部 shell 块 bash -n、python 块语法、Sphinx 构建无警告、pytest / ruff 通过。

github-actions Bot pushed a commit that referenced this pull request Oct 26, 2026
@github-actions

github-actions Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

📖 文档预览已随本 PR 关闭而清理。

github-actions Bot pushed a commit that referenced this pull request Oct 26, 2026
github-actions Bot pushed a commit that referenced this pull request Oct 26, 2026
github-actions Bot pushed a commit that referenced this pull request Oct 26, 2026
github-actions Bot pushed a commit that referenced this pull request Oct 27, 2026
把 workflows 仓库的 projects/mmengine/docs/Quick-start-Ascend.md 迁移到
sources/mmengine/quick_start.md,文档主体(17 段 NPU 冒烟:设备抽象 /
配置系统 / 注册表 / 数据集 / Runner 训练 / Hook / AMP / 学习率调度 /
评估 / 检查点续训 / MessageHub / 可视化 / 文件 IO / torch_npu 融合
优化器 / NPUProfilerHook)原样保留,#test / #test-setup / #test-result
标签不动,看护按原验证过的预期输出执行。

按 torchtitan / torchvision 的惯例与用户视角做了如下整理:

- H1 用项目名;「检查前置是否满足」提升为「前置安装」小节;文末补
  「外部链接」;conf.py exclude_patterns 排除该 md。
- 首页新增 mmengine 卡片(图标取 OpenMMLab 官方 avatar),toctree 收进
  「训练与微调框架」。
- 开篇 9 条 API 罗列收缩为 4 条用户视角能力;删除「原生支持」实现细节、
  「补丁状态:零源码补丁」整节与「小结」;各节十余处机制说明 / 结果
  解读类 Note 删掉(均不含 #test 块)。
- 安装与校验对齐:mmengine 不绑定版本(预期输出用 fuzzy 占位,版本表写
  最新 release);源码安装后的检查从 git pristine 改为打印安装版本;
  构建约束合并为 printf | uv pip install --build-constraints - 一行;
  pip 安装一节的卸载命令改为隐藏的 #test-setup,安装与版本校验合并成
  一个 #test 块;opencv 一节的 apt 安装与 cv2 校验合并成一个 #test 块
  (apt 输出 >/dev/null 丢弃——dpkg 的安装明细走 stdout,会污染比对)。
- 接入 tests/mmengine 看护与 .github/workflows/mmengine-quick-start.yml:
  单卡 a2-1,CANN 9.1.0 镜像(torch 2.9.0 / torch_npu 2.9.0.post2 栈),
  60 min 超时;定时按全仓统一的一天两次方案取空闲槽位 '40 10,22 * * *'
  (与 PR Ascend#255 的槽位表及现有节奏均不冲突)。
@Devin-DC-Huang
Devin-DC-Huang force-pushed the feat/mmengine-quick-start branch from 671b21f to bd236a5 Compare October 27, 2026 02:37
github-actions Bot pushed a commit that referenced this pull request Oct 27, 2026
@hipudding
hipudding merged commit b424cfa into Ascend:main Oct 27, 2026
5 checks passed
github-actions Bot added a commit that referenced this pull request Oct 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants