已开启
docs: faq 与 agent_workflow 文档的 API/工作流描述与当前框架不一致 #231
xuxinglei创建于  6月17日
xuxinglei成员
6月17日 创建

该问题是怎么引起的?

docs/faq.mddocs/agent_workflow.md 中部分 API 示例与工作流说明与当前框架实现不一致,用户按文档复制即报错或被误导:

  • faq:PipelineStage 示例缺首个必需参数 submoduleget_hyper_optimizerCheckpointPolicy 未给正确导入路径;Activation Swap 的 policy_fn 大激活分支返回 None,与“只 swap 大激活”的描述矛盾。
  • agent_workflow:/test 被描述为会跑 code-style/pylint/lint(实际仅 pytest tests/ut,lint 由 autogit check/pre-commit 负责);code-verifier 被当作 skill(实际是 agent)。

重现步骤

  1. 复制 docs/faq.md 中优化器、PipelineStage、Activation Swap 的示例运行。
  2. 阅读 docs/agent_workflow.md 关于 /testcode-verifier 的说明。

报错信息

  • PipelineStage(stage_index, stage_num):缺少必需参数 submodule
  • 直接使用 get_hyper_optimizer / CheckpointPolicy:未导入导致 NameError
  • /test 实际不运行 lint,与文档描述不符。
likedislike
Xxuxinglei成员
6月24日 关联了pull request:docs: correct API and workflow details in faq and agent_workflow