执行摘要
- 一句话:router_replay 文档配置键路径修正
- 推荐动作:该 PR 属于常规文档维护,改动量小且正确性明确,无需深度阅读。但可以注意:文档与代码结构同步更新是良好的实践。
功能与动机
PR 描述指出:router_replay configuration key has been moved under megatron key, but the documentation hasn't reflected this correctly. 因此需要同步更新文档以避免用户使用错误的配置路径。
实现拆解
- 修正 R2 模式 YAML 示例:在
examples/router_replay/README.md 中,将原来顶层的 router_replay 移至 actor.megatron 下,使 YAML 片段与实际配置结构一致。
- 修正 R2 模式 CLI 示例:将
actor_rollout_ref.actor.router_replay.mode 改为 actor_rollout_ref.actor.megatron.router_replay.mode。
- 修正 R3 模式 YAML 示例:将 actor 部分的
router_replay 嵌套到 actor.megatron 下,同时补全 rollout 部分的父级键 rollout:,确保 enable_rollout_routing_replay 正确放置在 rollout 下。
- 修正 R3 模式 CLI 示例:将
actor_rollout_ref.actor.router_replay.mode 改为 actor_rollout_ref.actor.megatron.router_replay.mode。
关键文件:
examples/router_replay/README.md(模块 文档;类别 docs;类型 documentation): 唯一变更文件,修正了 router_replay 配置键的文档示例,使其与实际代码中的 megatron 嵌套结构对齐。
关键符号:未识别
评论区精华
Review 中 gemini-code-assist[bot] 指出 R3 模式的 YAML 示例中 enable_rollout_routing_replay 缺少父级 rollout 键,可能导致配置错误。Copilot 建议 YAML 示例应从 actor_rollout_ref 根级开始以与 CLI 示例一致,但作者 HollowMan6 回复 “adjusted” 后未进一步调整。最终 reviewer wuxibin89 批准了 PR。
- R3 模式 YAML 示例缺少 rollout 父级键 (correctness): 作者 HollowMan6 回复 'adjusted',PR 最终合并时已修正该问题。
- YAML 示例根级不完整 (design): 未完全采纳,PR 仍合并。可能认为当前示例对于熟悉配置的用户已足够清晰。
风险与影响
- 风险:此 PR 仅为文档变更,不涉及代码逻辑,因此没有回归、性能、安全或兼容性风险。但若文档示例仍存在歧义(如 YAML 根级不完整),用户可能仍会配置错误。
- 影响:影响范围:仅影响阅读
examples/router_replay/README.md 的用户。影响程度:低。用户若使用过时的配置路径会遇到错误,更新文档后能正确配置。
- 风险标记:缺少父级键曾被遗漏, 文档示例根级不完整
关联脉络
参与讨论