Prhub

#23052 [diffusion] doc: update doc

sgl-project/sglang · 作者 mickqian · 合并时间 2026-04-17 16:23

分析状态 已生成
文件变更 7提交数 1 · 评论 1
代码增减 +136 / -27
documentation diffusion run-ci

执行摘要

更新扩散模型文档,新增 API 示例、环境变量和平台支持信息。

根据review评论,PR旨在显著扩展SGLang Diffusion的文档,覆盖新功能如image-to-video生成、新环境变量和平台支持,以提升用户体验和文档实用性。

建议工程师和用户阅读更新后的文档,以了解扩散功能的新API、配置选项和平台支持,重点关注API示例和环境变量部分。

讨论亮点

review中仅有一个语法建议:在docs/diffusion/compatibility_matrix.md中,reviewer建议将'uses'改为'use'以保持主谓一致,该建议被接受并已应用,无其他争议。

实现拆解

  1. 更新OpenAI API文档:在docs/diffusion/api/openai_api.md中添加image-to-video API示例,支持multipart form upload和reference URL两种方式,扩展了API功能描述。
  2. 扩展环境变量文档:修改docs/diffusion/environment_variables.md,新增运行时和平台特定环境变量(如SGLANG_DIFFUSION_TARGET_DEVICESGLANG_USE_ROCM_VAE),并补充量化相关变量,帮助用户配置扩散推理。
  3. 更新模型兼容性矩阵:在docs/diffusion/compatibility_matrix.md中添加新模型(如Wan2.1 Fun、Helios系列),并修正LTX模型注释语法,确保文档准确性。
  4. 补充attention backends文档:修改docs/diffusion/performance/attention_backends.md,添加新attention backend(如sla_attn)和平台支持(如Intel XPU、MUSA),更新支持矩阵。
  5. 添加安装指南:在docs/diffusion/installation.md中新增Intel XPU安装步骤,扩展平台支持。
  6. 更新CLI文档:在docs/diffusion/api/cli.md中添加--image-path参数说明,支持image-to-video和image-to-image生成。
  7. 微调索引文件:对docs/diffusion/index.md进行微小调整,保持文档一致性。所有变更均为文档更新,无测试或代码配套改动。
文件 模块 状态 重要度
docs/diffusion/api/openai_api.md 扩散文档 modified 3.7
docs/diffusion/environment_variables.md 扩散文档 modified 3.66
docs/diffusion/compatibility_matrix.md 扩散文档 modified 3.08
docs/diffusion/performance/attention_backends.md 扩散文档 modified 2.93
docs/diffusion/installation.md 扩散文档 modified 2.1
docs/diffusion/api/cli.md 扩散文档 modified 1.79
docs/diffusion/index.md 扩散文档 modified 1.32

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

评论区精华

语法修正 documentation

reviewer 建议在 docs/diffusion/compatibility_matrix.md 中将 'uses' 改为 'use',以修正主谓一致问题。

结论:建议被接受并应用,PR 已合并。 · 已解决

风险与影响

文档变更主要风险在于准确性,需确保更新内容与代码实现一致,但无代码执行、性能或安全风险。例如,环境变量描述错误可能导致用户配置错误,但影响限于使用体验。

影响所有使用SGLang扩散功能的用户,提供更全面的文档指导,减少使用障碍,有助于用户高效配置和使用新功能(如image-to-video生成、多平台支持)。对系统无直接技术影响,但提升团队文档维护质量。

文档准确性风险

关联 Issue

未识别关联 Issue

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

完整报告

执行摘要

本次PR全面更新了SGLang扩散模型的文档,涵盖OpenAI API示例、环境变量、模型兼容性、attention backends和平台安装指南,旨在提升文档完整性和用户体验,无代码变更,风险较低。

功能与动机

PR动机是扩展SGLang Diffusion的文档覆盖,以支持新功能如image-to-video生成、多平台环境配置和模型更新。根据review评论,本次变更“显著扩展了文档”,帮助用户更好地使用扩散功能。

实现拆解

  1. API文档更新:在docs/diffusion/api/openai_api.md中新增image-to-video API示例,支持multipart form upload和reference URL两种方式,示例代码如下:
    ```markdown
    Create a video (image-to-video)

For I2V or TI2V models (e.g., Wan2.1 I2V, LTX-2.3 two-stage), pass an input image via multipart form upload or a reference URL.

Curl Example (multipart form upload):

bash curl -sS -X POST "http://localhost:30010/v1/videos" \ -H "Authorization: Bearer sk-proj-1234567890" \ -F "prompt=A cat playing a piano" \ -F "input_reference=@input_image.png" \ -F "size=1280x720"

Curl Example (reference URL):

bash curl -sS -X POST "http://localhost:30010/v1/videos" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer sk-proj-1234567890" \ -d '{ "prompt": "A cat playing a piano", "reference_url": "https://example.com/input_image.png", "size": "1280x720" }'
`` 2. **环境变量扩展**:修改docs/diffusion/environment_variables.md,新增运行时变量(如SGLANG_DIFFUSION_TARGET_DEVICE)和平台特定变量(如ROCm、量化相关),组织为结构化表格。 3. **模型兼容性矩阵**:更新docs/diffusion/compatibility_matrix.md,添加Wan2.1 Fun、Helios系列等新模型,并修正LTX模型注释语法。 4. **attention backends文档**:在docs/diffusion/performance/attention_backends.md中补充新backend(如sla_attn)和平台支持(Intel XPU、MUSA),更新支持矩阵。 5. **安装指南补充**:在docs/diffusion/installation.md中添加Intel XPU安装步骤,扩展多平台支持。 6. **CLI参数更新**:在docs/diffusion/api/cli.md中新增--image-path参数说明,用于image-to-video和image-to-image生成。 7. **索引微调**:对docs/diffusion/index.md`进行微小调整,确保文档一致性。所有变更均为纯文档更新,无测试或代码配套改动。

评论区精华

review中仅有一个讨论线程:reviewer建议修正docs/diffusion/compatibility_matrix.md中的语法错误,将“uses”改为“use”以保持主谓一致。该建议被接受并应用,无其他争议或深度技术讨论。

风险与影响

风险主要在于文档准确性,如环境变量描述错误可能导致用户配置失误,但无代码执行、性能或安全风险。影响方面,本次更新全面覆盖扩散功能文档,帮助用户更高效地使用新API、配置环境和平台,提升用户体验和团队文档质量。

关联脉络

与近期PR #23028(“[codex] Update diffusion skills”)相关,同为扩散模型文档更新,共同完善扩散文档生态。历史PR中多次涉及diffusion模块(如PR 22952、23028),显示团队持续优化扩散功能支持,本PR是这一趋势的文档补充部分。

参与讨论