mindspore-ai / mindspore-ai/hyper-parallel
docs: faq 与 agent_workflow 文档的 API/工作流描述与当前框架不一致
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 53
- Forks
- 63
- Avg merge
- 23h 45m
- Merged PRs (30d)
- 63
Description
该问题是怎么引起的?
docs/faq.md 与 docs/agent_workflow.md 中部分 API 示例与工作流说明与当前框架实现不一致,用户按文档复制即报错或被误导:
- faq:
PipelineStage示例缺首个必需参数submodule;get_hyper_optimizer、CheckpointPolicy未给正确导入路径;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)。
重现步骤
- 复制
docs/faq.md中优化器、PipelineStage、Activation Swap 的示例运行。 - 阅读
docs/agent_workflow.md关于/test与code-verifier的说明。
报错信息
PipelineStage(stage_index, stage_num):缺少必需参数submodule。- 直接使用
get_hyper_optimizer/CheckpointPolicy:未导入导致NameError。 /test实际不运行 lint,与文档描述不符。
schema_version: 1
source: gitcode
gitcode_repo: mindspore/hyper-parallel
gitcode_issue: 231
source_url: https://gitcode.com/mindspore/hyper-parallel/issues/231
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/faq.md and docs/agent_workflow.md, then inspect the current implementations and entry points for PipelineStage, get_hyper_optimizer, CheckpointPolicy, Activation Swap, /test, and code-verifier. Update the examples and workflow descriptions to match the implementation, and verify the documented examples and test workflow no longer mislead users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 76/100