# PR #1988 完整报告

- 仓库：`THUDM/slime`
- 标题：[docs] optimize docs
- 合并时间：2026-05-30 10:15
- 原文链接：http://prhub.com.cn/THUDM/slime/pull/1988

---

# 执行摘要

- 一句话：大规模重写高级文档，完善低精度训练、PD 分离、容灾等说明
- 推荐动作：推荐所有 slime 用户阅读更新后的文档，尤其是低精度训练和 PD 分离部分。对于新用户，建议从快速入门参考文档。维护者应确保后续代码变更同步更新文档。

# 功能与动机

PR 描述为空，但从变更内容推断，目的是解决原文档在高级主题（低精度训练、PD 分离、容灾）上结构不清晰、配置示例不足的问题，为大规模 MoE RL 用户提供更明确的指导路径。

# 实现拆解

1. **重写低精度训练文档 **(`docs/en/advanced/low-precision.md`)：新增特性成熟度表格，明确 BF16 训练 + FP8 rollout 为稳定生产路径；补充 FP8 KV cache、INT4 QAT 说明；整理命令示例和配置指引。
2. **重写 PD 分离文档 **(`docs/en/advanced/pd-disaggregation.md`)：新增何时使用 PD 的详细指导；区分简单路径 (`--prefill-num-servers`) 和高级路径 (`--sglang-config`)；提供 SGLang Config YAML 示例。
3. **重写容灾文档 **(`docs/en/advanced/fault-tolerance.md`)：重新定义 fault tolerance 范围；补充 health check 参数表；新增 debug/replay 路径 (`--debug-rollout-only` 等 )；提供推荐生产模式。
4. **同步更新中文文档**：对应英文文档的修改同步更新至 `docs/zh/` 目录，保持中英一致。
5. **更新索引和快速入门**：调整 `index.rst` 以反映新文档结构；在 `quick_start.md` 中添加高级功能链接。

关键文件：
- `docs/en/advanced/low-precision.md`（模块 英文文档；类别 docs；类型 documentation）: 英文核心高级文档，最大变动（+75/-65），新增成熟度表格和生产路径推荐
- `docs/zh/advanced/low-precision.md`（模块 中文文档；类别 docs；类型 documentation）: 中文同步更新，与英文保持一致，并适配中文表达
- `docs/en/advanced/pd-disaggregation.md`（模块 英文文档；类别 docs；类型 documentation）: 重写 PD 分离文档，新增配置路径说明和 SGLang Config 示例
- `docs/zh/advanced/pd-disaggregation.md`（模块 中文文档；类别 docs；类型 documentation）: 中文同步更新，结构与英文一致
- `docs/en/advanced/fault-tolerance.md`（模块 英文文档；类别 docs；类型 documentation）: 重写容灾文档，补充 debug/replay 路径和生产建议
- `docs/zh/advanced/fault-tolerance.md`（模块 中文文档；类别 docs；类型 documentation）: 中文同步更新，与英文一致

关键符号：未识别

## 关键源码片段

### `docs/en/advanced/low-precision.md`

英文核心高级文档，最大变动（+75/-65），新增成熟度表格和生产路径推荐

```bash
# Convert BF16 model to FP8 with blockwise quantization
python tools/convert_hf_to_fp8.py \
    --model-dir $BF16_MODEL \
    --save-dir $FP8_MODEL \
    --strategy block --block-size 128 128 \
    --max-workers 4

# 确保转换后的 checkpoint 中 `config.json` 包含正确的 `quantization_config`
# slime 会在权重更新时使用该配置，训练侧保持 BF16，rollout 侧收到 FP8 权重
# 示例用法：
# --hf-checkpoint /path/to/model-fp8-hf

```

# 评论区精华

该 PR 没有 comments 或 review 讨论，属于干净的单人提交。

- 暂无高价值评论线程

# 风险与影响

- 风险：文档变更本身风险较低，主要风险包括：
 1) 配置示例与未来版本代码不同步导致误导；
 2) 部分描述可能过于简化。建议在后续版本中持续维护文档。
 - 影响：对用户学习路径有积极提升，尤其对大规模 MoE RL 的新用户。对系统行为无影响。
 - 风险标记：纯文档变更

# 关联脉络

- 暂无明显关联 PR