执行摘要
- 一句话:按 v0.1 清单重写首页 Core features 并同步 Advanced 索引
- 推荐动作:值得文档维护者与产品同学精读:它演示了如何把对外宣传页与版本功能清单做一次严格对齐,并展示了 docs PR 中逐条事实核查的 review 范式(CI 是否每个 PR 都跑、硬件清单是否齐全、性能数字是否可复现、provider 是否都有 in-tree 示例)。若团队依赖首页做售前或上手引导,建议后续为首页 bullet 建立指向功能清单和 examples 目录的核对清单,并顺手修复 FSDP 链接锚点问题。代码与算法团队可跳过。
功能与动机
首页 Core features 区块与 Miles v0.1 功能清单脱节,PR body 明确目标:Rewrite the homepage Core features section to follow the Miles v0.1 feature list。PR body 同时记录了三个口径决策:保留 twenty-plus plug-points 表述(v0.1 清单写 21 个 plug-points,而 docs/user-guide/customization.md 实际记录 26 个 --*-path 钩子,数量不一致);从首页删除未列入 v0.1 清单的 speculative rollout with online MTP-SFT 条目(Speculative Decoding 页面本身保留并仍从 Advanced 标签页和模型页链接);沙箱 provider 只列有 in-tree 示例(examples/experimental/)的 Daytona / E2B / AgentENV,仓库中不存在 Modal 集成。
实现拆解
- 重构首页 Core features 区块(docs/index.md):把原来 8 条扁平 bullet 拆为 Efficiency & stability 与 Design, support & user experience 两个小节,形成 16 条新 bullet,并为每条补上文档链接(Fully Async Rollout、P2P Weight Transfer、Low Precision、INT4 QAT、miles-router、fault-tolerance、Harbor / OpenEnv / NeMo-Gym、customization、Platforms、Dashboard 等)。按 PR body 说明,删除不在 v0.1 清单中的 speculative rollout with online MTP-SFT 条目,但保留 Speculative Decoding 页面本身。
- 同步 Advanced Features 导语(docs/advanced/index.md):把首页指向的枚举从 (FP8 / MXFP8 / INT4 QAT) 扩展为 (FP8 / MXFP8 / NVFP4 / INT4 QAT),并新增 fast weight updates over P2P RDMA 与 fault tolerance 两项,使导语与首页新 bullet 一一对应。
- 按 review 逐轮收口(6 个 commit):删除 recipe 条目中的 SFT 链接;按 examples/experimental/ 目录核对沙箱 provider,最终仅列 Daytona / E2B / AgentENV(仓库无 Modal 集成);tuned 改 optimized、any 改 all;权重更新示例改为参数规模口径(Kimi-K2.6 量级 1 T parameters);硬件清单补 B300 / MI300X;CI bullet 改为 tag 触发的端到端 GPU 训练测试并去掉与其他框架对比的措辞;recipe 条明确 RL (GRPO, PPO)、SFT、on-policy distillation;dashboard 条补充 per-GPU 活动与 token 级轨迹信息。
- 配套改动:无测试、配置、schema 或部署变更;commit ci: retrigger checks(cdabc6a)仅为 CodeQL 超时后的 CI 重跑,与内容无关。
关键文件:
docs/index.md(模块 文档首页;类别 docs;类型 documentation): 首页核心改动:8 条扁平 bullet 重构为两组 16 条 bullet 并逐条加文档链接,是 v0.1 功能清单对齐的主要载体,10 条 review 评论全部落在此文件。
docs/advanced/index.md(模块 高级索引;类别 docs;类型 documentation): Advanced Features 导语同步首页指向,新增 NVFP4、P2P RDMA 权重更新与 fault tolerance,保证首页链接落地页的枚举一致。
关键符号:未识别
评论区精华
- Shi-Dong(作者自审)要求按 in-tree 示例核对沙箱 provider:"Go over the examples in
examples/experimental/ to find other supported examples related to sandboxes, like E2B, Modal, etc.";结论是仓库内无 Modal 集成,最终只列 Daytona / E2B / AgentENV。
- guapisolo 对 CI 表述提出疑问(对比 prime-rl / areal / skyrl 少有综合 CI),Shi-Dong 纠正:"I don't think every pull request runs end-to-end GPU CI: those CIs are tag-based",最终改为 Unit suites run on every pull request, and tag-triggered end-to-end GPU training tests,并去掉 coverage few RL frameworks match 的对比措辞。
- guapisolo 补充硬件清单:"Also b300 and MI300 here",最终加入 B300 与 MI300X。
- Shi-Dong 要求权重更新示例改为参数量口径:"Change 'for a model like...' to 'a model with XX parameters'. Replace XX with the parameter count of Kimi K2.6.",最终为 under 10 seconds for a model with 1 T parameters。
-
guapisolo 对 dashboard bullet 建议措辞:"like fully-async scheduling and token info for each trajectory ?",最终描述为 what every GPU was doing during a step, and what each trajectory contained at the token level。
-
沙箱 provider 枚举范围与 Modal 是否存在 (design): 最终仅列 Daytona / E2B / AgentENV;PR body 说明仓库无 Modal 集成,不写进首页。
- CI 表述:是否每个 PR 都跑端到端 GPU CI (correctness): 最终改为 Unit suites run on every pull request, and tag-triggered end-to-end GPU training tests ...,后续 commit f3df3ba 专门修正此条。
- 权重更新性能声明的口径 (correctness): 最终为 under 10 seconds for a model with 1 T parameters。
- 硬件清单补充 B300 与 MI300X (correctness): 最终硬件 bullet 加入 B300 与 MI300X,形成 GB300 / GB200 / B300 / B200 / H200 / H100 / MI355X / MI300X。
- TITO 与 agentic rollout 措辞微调 (style): 全部落实:agentic rollout 不再强调 router,TITO 表述为 all models and all black-box agent harnesses。
- recipe 与 dashboard bullet 的内容充实 (design): recipe bullet 明确 RL (GRPO, PPO)、SFT、on-policy distillation;dashboard 描述为 what every GPU was doing during a step 与 what each trajectory contained at the token level。
- SFT 链接移除与 speculative rollout 条目取舍 (design): SFT 链接删除(SFT 仍以 recipe 形式保留在 bullet 中);首页不再提及 speculative rollout,Speculative Decoding 页面不受影响。
风险与影响
- 风险:本 PR 为纯文档变更,无代码回归或运行时风险,风险集中在首页声明的事实准确性与后续一致性上:
- 性能声明 under 10 seconds for a model with 1 T parameters 依赖具体硬件、互联与拓扑,营销口径可能被读者当作基准承诺。
- TITO 的 all models and all black-box agent harnesses 是全称断言,后续新模型若不支持会造成口径漂移。
- 首页 bullet 与 v0.1 功能清单、examples/experimental/ 目录需要持续同步;沙箱 provider 已有先例(仓库后续新增 Daytona 示例 #2220 并重构辅助函数 #2274),清单容易过时。
- 链接锚点可能漂移:首页新增 Megatron or FSDP bullet 指向 /developer/experimental-features#fsdp-backend,而 FSDP 后端已在 #2272 迁出 experimental,该锚点未来可能失效。
- PR body 自述 21 plug-points 与 customization.md 中 26 个 hook 的数量不一致,首页用 twenty-plus 规避,属已知未决问题。
- 影响:影响范围为文档站点:docs/index.md 是 Miles 官网首页,承担对外能力宣传与新用户第一印象,本次刷新让能力清单与 v0.1 版本对齐,直接改善潜在用户、决策者与上手用户的认知准确度;docs/advanced/index.md 导语同步后,首页到高级特性的导航链条自洽。对系统与代码无影响。对团队而言,文档维护者需要把首页两个小节与功能清单长期绑定,避免再次脱节;本次已是继 #2271、#2298 之后第三轮首页/快速上手文档刷新,说明该内容已进入持续维护节奏。
- 风险标记:纯文档变更, 性能声明需实测背书, 全称断言易口径漂移, FSDP 链接锚点已漂移, 与功能清单需持续同步
关联脉络
- PR #2271 docs: refresh the homepage supported-models table: 改同一文件 docs/index.md,属同一轮首页刷新系列,且本 PR 的 Day-0 模型 bullet 直接链接到 Supported models 锚点。
- PR #2298 docs: polish the Quick Start page: 文档刷新系列,配套启动脚本默认启用 Miles dashboard,与本 PR dashboard bullet 的能力声明呼应。
- PR #2220 Add the GLM-5.2 744B x terminal-bench-2 Daytona example: 新增 Daytona 沙箱示例,正是首页沙箱 provider 枚举所依据的 in-tree 示例之一。
- PR #2274 refactor(openenv): move duplicated sandbox helpers into the TB2 recipe: 沙箱辅助函数上收共享 recipe,印证首页沙箱 provider 口径(有 in-tree 示例才写入首页)。
- PR #2272 refactor: move the FSDP backend out of experimental: 首页新增 Megatron or FSDP bullet,但链接仍指向 experimental-features#fsdp-backend 锚点,FSDP 已迁出 experimental,存在锚点漂移风险。
参与讨论