执行摘要
本 PR 修复了 docs/advance/ppo_lora.rst 教程文档中一处引用了已弃用配置键的错误,将其更新为代码库中当前推荐的写法 fsdp_config.ulysses_sequence_parallel_size,确保了用户文档的准确性与代码行为同步。
功能与动机
此变更旨在修正文档与实际代码配置之间的不一致。根据 PR body 描述,顶级配置键 actor_rollout_ref.actor.ulysses_sequence_parallel_size 已在 verl/trainer/config/actor/dp_actor.yaml 中被标记为弃用,其功能已迁移至 actor.fsdp_config 下。然而,ppo_lora.rst 文档中的示例命令仍使用旧键,可能导致用户按文档操作时配置失败或产生困惑。更新文档是为了提供正确、现代的配置指导。
实现拆解
- 变更定位:变更集中于一个文件
docs/advance/ppo_lora.rst 的“Best Practices and Notes”章节。
- 具体修改:在该章节列出的示例配置参数中,将第7行(约第197行)的
actor_rollout_ref.actor.ulysses_sequence_parallel_size=1 替换为 actor_rollout_ref.actor.fsdp_config.ulysses_sequence_parallel_size=1。
- 配套验证:作者在提交前已确认:
dp_actor.yaml 中对旧键的弃用标记。
- 示例脚本
examples/tuning/lora/run_qwen3_8b_fsdp.sh 已在使用新键。
- 影响评估:此变更仅涉及文档字符串,不引入任何代码逻辑、测试或配置文件的变动。
不适用。本次变更仅为配置键字符串在文档中的引用替换,不包含需要展示的核心实现片段。
评论区精华
审核过程无争议。审核者 HollowMan6 直接批准了变更,其评论仅为 “Thank you!”,表明该修复简单明了,意图正确,无需进一步讨论。
风险与影响
- 风险:风险极低。变更仅限于一个文档文件,不影响任何运行时代码或系统配置,因此无回归、性能或安全风险。
- 影响:这是一个积极的维护性变更。
- 用户影响:为遵循 LoRA 教程的用户提供了准确的配置信息,提升了文档的可靠性和用户体验。
- 团队影响:消除了文档债务,保持了教程与代码库演进的一致性。
关联脉络
该 PR 是仓库文档维护工作的一部分,与近期对配置和示例脚本的清理趋势一致(例如近期 PR #7678 更新了 GRPO 示例参数)。它确保了用户指南(特别是涉及配置的教程)与代码库的实际状态保持同步,这在项目持续迭代和功能重构(如配置路径迁移)过程中非常重要。
参与讨论