Prhub

#6825 [doc] chore: add verl extension guide

原始 PR 作者 wuxibin89 合并时间 2026-06-23 21:30 文件变更 2 提交数 1 评论 2 代码增减 +274 / -0

执行摘要

添加 verl 扩展指南文档,介绍自定义组件的方法

PR body 中仅说明 'As title.',即添加 verl 扩展指南。该文档旨在为用户提供扩展 verl 的完整指导,降低自定义组件的门槛。

值得所有希望扩展 verl 的研究人员和开发者阅读,尤其是 Agent Loop 和 Replay Buffer 的自定义示例。建议在后续 PR 中及时更新文档以匹配实际代码接口。

讨论亮点

Gemini Code Assist 的 review 指出了两个文档格式问题:

  • :doc: 指令中链接文本与目标路径之间缺少空格(第21行),可能导致 Sphinx 构建警告。
  • 配置代码块开头有多余的 + 字符(第180行),可能是从 git diff 复制导致,会使用户复制配置时出错。
    这两个建议均未被采纳(PR 已合并时未修复)。

实现拆解

  1. 创建文档文件docs/extend_guide.rst):从零编写 273 行的扩展指南,分为 RL 研究者、Engine 用户两大类读者,覆盖 reward 函数定制、tool 定义、自定义 Agent Loop(如 MyAgentLoop.run)、自定义 Replay Buffer(UserCustomReplayBuffer.sample)、自定义模型引擎(MyAgentLoopManager.create / generate_sequences / _load_vexact_replica)等场景,每部分包含配置示例和代码骨架。
  2. 注册到索引docs/index.rst):在 Programming guide 分类下添加一行 extend_guide 条目,使新文档出现在 Sphinx 文档目录中。
文件 模块 状态 重要度
docs/extend_guide.rst 扩展指南 added 6.12
docs/index.rst 文档索引 modified 1.18

关键符号

MyAgentLoop run UserCustomReplayBuffer sample MyAgentLoopManager create generate_sequences _load_vexact_replica

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

评论区精华

:doc: 指令格式错误 documentation

gemini-code-assist[bot] 指出在 :doc: 指令中链接文本和目标路径之间缺少空格,可能导致 Sphinx 构建警告。

结论:建议修复,但 PR 合并前未采纳。 · unresolved

配置中多余的 '+' 字符 documentation

gemini-code-assist[bot] 指出在配置代码块开头有多余的 '+' 字符,可能来自 git diff,会导致复制粘贴错误。

结论:建议删除该字符。 · unresolved

风险与影响

纯文档变更,无运行时风险。但格式错误(如 :doc: 缺少空格)可能影响 Sphinx 渲染,降低阅读体验;配置示例中的多余字符可能误导用户。

对用户:提供了一站式扩展指南,显著降低自定义组件的学习成本,尤其是 Agent Loop 和 Replay Buffer 部分。对系统:无影响。对团队:需与代码演进保持同步,防止指南过时。

文档格式错误可能误导用户

关联 Issue

未识别关联 Issue

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

完整报告

参与讨论