Prhub

#2359 docs: dashboard advanced features and example visualization

原始 PR 作者 Zhichenzzz 合并时间 2026-08-12 01:33 文件变更 19 提交数 4 评论 0 代码增减 +301 / -227

执行摘要

dashboard 文档配六张真实运行截图并重构视图章节

PR body 明确指出旧文档的缺陷:The dashboard doc named every panel but showed none of them, so the only way to find out what a view looks like was to go run it against a dump(文档只点名面板、不给画面,读者想知道视图长相只能自己对着 dump 跑一遍)。第二次提交进一步指出结构问题:旧文档用 145 行架构描述开场,读者要先穿越存储布局才能看到工具本身。因此动机是双重的——补齐可视化参考,并把叙事重心从架构移到屏幕上实际有什么。此外 sglang 分类在数据源、x 轴、图例交互上的三点差异,旧文本从未提及,属于真实存在的知识缺口。

值得快速浏览而非精读:无代码逻辑,但有两个方法论值得借鉴——用同一真实运行喂全部截图、让正文数字可对照查验,以及视图优先于架构的叙事重构,对后续 dashboard 文档和其它功能文档有示范意义。合入后建议人工检查文档站各截图是否正常渲染,并关注 #2353 的合并顺序与 README 图片链接的最终落地状态。

讨论亮点

评审过程干净利落:Shi-Dong 直接 APPROVED,仓库内零评论、零 review 讨论线程。唯一需要协调的内容写在 PR body 里:作者主动披露 #2353 同时在编辑 dashboard.md(追加 Model FLOPs utilization 章节到 Compute Utilization 之后),与本 PR 的 Views 重写重叠,后合入方需要做一次小规模手动合并,并明确声明图片文件无重叠。另外提交信息中还记录了一个技术取舍:根 README 的 logo 改用指向 main 分支的 raw.githubusercontent.com 绝对 URL,因为 README 会在仓库之外渲染,代价是合并前该链接会 404,作者承认这是移动文件必然的代价。

实现拆解

  1. 重写 Views 章节并配六张截图docs/user-guide/dashboard.md(+292/−221)为每个视图配一张 1600×1200 截图,正文围绕画面组织。新增的关键语义说明包括:sglang 分类与其它指标的三点差异(数据来自引擎 scrape 而非 metrics.jsonl、x 轴是墙钟时间而非 rollout/step、Engines 图例每引擎一个复选框且取消勾选会连同 y 轴缩放一起剔除该引擎);Compute Utilization 按集群总览 → 每步 wait-ratio 条带 → 每 lane 细节自上而下拆解;Batch anatomy 的橙色随 weight version 变化、绿色为工具调用阻塞时间、按墙钟跨度排序找长尾;Groups 页红行表示组内样本同分导致 advantage 全零、无梯度贡献(图中 8 组有 6 组红);头部 瓦片表示该列缺失而非零。
  2. 重构页面结构为视图优先:新结构按 What it shows(三个视图与截图)→ 如何开启 → 工作原理排列,开头放问题 → 打开哪个视图的速查表(Is the run learning? → Metrics;Why is a step slow? → Compute Utilization),正文改用更平实的短句,sglang 差异从长从句改为编号列表。
  3. 图片资产按主题建目录:新增 docs/assets/images/dashboard/(六张截图,去掉引擎 schema 里必须的 dashboard- 前缀)与 docs/assets/images/brand/(logo/favicon),并同步更新三处引用:docs/docs.json 的 logo/favicon 路径、docs/assets/stylesheets/extra.css 的背景图路径、根 README.md 的 logo 链接;删除 imgs/ 下四个与 docs/assets 字节完全一致的重复文件(arch.pngmiles_logo.pngmiles_square.pngp2p_vs_nccl_scaling.png),docs/assets 成为图片唯一仓库。
  4. 把资产约定写进文档docs/README.md 新增规则——一个主题超过一张图就建子目录、目录名用页面或区域名,单张孤图留在顶层。
  5. 验证与配套:所有事实数字(6/8 零标准差组、32+32 GPU、4 引擎、100 步 11.2 h、无 eval 分类)都通过该次运行的 API 核对而非凭记忆书写。无源码、测试或部署配套改动;与 #2353 的 dashboard.md 编辑存在重叠区间,需按合入顺序做一次小手动合并。
文件 模块 状态 重要度
docs/user-guide/dashboard.md 仪表盘文档 modified 4.8
docs/docs.json 文档配置 modified 3.37
docs/assets/images/dashboard/metrics-rollout.png 仪表盘截图 added 2.17
docs/assets/images/brand/miles_logo_light.png 品牌图片 renamed 2.17
docs/assets/stylesheets/extra.css 样式资源 modified 2.31
docs/README.md 文档约定 modified 1.96
imgs/arch.png 废弃资源 removed 1.77
README.md 仓库首页 modified 1.32

分析完成后,这里会展示 LLM 生成的相对完整源码片段和详细注释。

评论区精华

没有提炼出高价值讨论线程

当前评论区没有形成足够清晰的争议点或结论,后续有更多讨论时会体现在这里。

风险与影响

资源路径迁移风险:logo、favicon、CSS 背景图路径全部变更,任何未覆盖的引用方都会破图;已确认 docs.json、extra.css、README.md 三处引用同步更新,imgs/ 删除后仓库外历史链接会失效但本 PR 内无法验证。合并冲突风险:#2353 与本 PR 共同编辑 dashboard.md,后合入方必须手动合并,处理不当会丢 Model FLOPs utilization 章节或本 PR 的截图引用。链接可用性风险:README 图片 URL 指向 main 分支,合并前 404、合并后生效,若分支回滚或改名会长期失效。文档时效性风险:文中具体数字(reward 0.3→0.9、prefix_cache_hit_rate 0.96→0.94 等)绑定 GLM-5.2 某一次特定运行,dashboard 行为演进后可能过时,但 瓦片语义、sglang 三点差异等结构性说明长期有效。

对用户:首次能在文档中看到 dashboard 各视图的真实长相与读图方式,显著降低必须跑一次 dump 才能理解面板的上手成本;sglang 差异与 Groups 红行说明直接帮助训练中诊断(优势消失、无梯度贡献)。对系统:零运行时影响(纯文档与静态资源),但文档站构建依赖新图片路径,docs.json 与 extra.css 引用不一致会导致破图或构建告警。对团队:确立图片资产组织约定(主题子目录),后续配图有章可循;资产从 imgs/ + docs/assets 双份收敛为单一仓库,减少重复维护。整体影响面集中在文档站与开发者阅读体验,程度中等偏低。

文档资产路径迁移 与 #2353 合并冲突 README 图片链接合并前 404 文档数字绑定单次运行

关联 Issue

未识别关联 Issue

当前没有检测到明确关联的 Issue 链接,后续同步到相关引用后会出现在这里。

完整报告

参与讨论