Prhub

#7267 [Docs] Update docs for release/2.5

原始 PR 作者 Jiang-Jia-Jun 合并时间 2026-04-09 16:07 文件变更 4 提交数 4 评论 23 代码增减 +52 / -46

执行摘要

更新 FastDeploy v2.5 发布文档,同步中英文版本并修复安装指南。

根据PR body和评论,原始提交仅更新了中文文档,英文文档仍引用v2.4版本,且安装指南中残留旧版本号(如paddlepaddle-gpu==3.3.0)。作者Jiang-Jia-Jun在评论中表示:“这个PR仅修改了中文文档,请帮忙修改英文文档,同时帮忙Review仓库中是否有其它没有更新新版本号的文档”,目标是确保文档与v2.5发布同步,提供准确的用户指南。

本PR为文档更新,无需深读代码,但可关注安装指南的澄清部分(如--extra-index-url说明),这对用户正确部署有直接帮助。建议文档维护者参考此次同步流程,确保未来版本发布时中英文文档同时更新。

讨论亮点

review讨论聚焦于文档一致性和清晰度:1. 中英文Docker镜像说明不一致:英文版已更新支持SM 80/86/89/90,中文版仍保留旧说明,fastdeploy-bot和Copilot指出后,在提交中同步更新。2. 安装命令澄清:Copilot指出--extra-index-url使用可能误导用户,作者Jiang-Jia-Jun回应“补充说明下extra-index-url只用下依赖下载吧”,随后Copilot在提交中添加说明。3. 格式规范:fastdeploy-bot建议补充PR标题标签和描述,Copilot指出代码块缺少语言标识等小问题,均已解决。

实现拆解

实现分为四个文件:1. README_CN.md和README_EN.md:新增v2.5发布条目(支持Qwen3-VL MoE、W4AFP8量化等),调整v2.4条目格式。2. docs/get_started/installation/nvidia_gpu.md(英文)和docs/zh/get_started/installation/nvidia_gpu.md(中文):更新Docker镜像版本至2.5.0(支持SM80/86/89/90 GPU),更新paddlepaddle-gpu至3.3.1并增加CUDA 12.9选项,更新fastdeploy-gpu至2.5.0并简化安装命令(不再按GPU架构区分包源),添加说明澄清--extra-index-url仅用于依赖下载。

文件 模块 状态 重要度
README_CN.md Documentation modified 3.0
README_EN.md Documentation modified 3.0
docs/get_started/installation/nvidia_gpu.md Installation modified 4.0
docs/zh/get_started/installation/nvidia_gpu.md Installation modified 4.0

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

评论区精华

中英文 Docker 镜像说明不一致 documentation

fastdeploy-bot 指出英文版已更新为支持 SM 80/86/89/90,但中文版第 17 行仍保留旧说明,可能导致用户误操作。作者 Jiang-Jia-Jun 回应并请求 Copilot 更新。

结论:在提交中同步更新中文版说明,保持一致。 · 已解决

安装命令中 --extra-index-url 澄清 documentation

Copilot 指出安装命令使用 --extra-index-url 可能让用户误解 fastdeploy-gpu 从 PyPI 安装,建议明确其仅用于依赖下载。作者 Jiang-Jia-Jun 同意并请求补充说明。

结论:Copilot 在提交中添加说明,澄清 --extra-index-url 用途。 · 已解决

风险与影响

风险较低,主要为文档相关:1. 不一致风险:若未完全同步中英文文档,可能导致用户困惑(如Docker镜像支持范围),但review中已识别并修复。2. 误导风险:安装命令中--extra-index-url若不澄清,用户可能误从PyPI安装fastdeploy-gpu,但提交中已添加明确说明。3. 回归风险:无代码变更,不影响系统功能。

影响范围涉及所有FastDeploy用户:1. 用户影响:确保用户获取准确的v2.5发布信息和安装指南,提升部署体验。2. 系统影响:无运行时影响,纯文档更新。3. 团队影响:维护文档一致性,减少后续支持成本。影响程度为低,仅文档层面。

文档不一致风险 安装误导风险

关联 Issue

未识别关联 Issue

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

完整报告

执行摘要

本PR同步了FastDeploy v2.5版本的中英文文档,更新了README发布信息和NVIDIA GPU安装指南,修复了残留的旧版本引用并澄清安装命令细节。作为纯文档变更,风险较低,但确保了用户能准确获取部署信息,维护了文档一致性。

功能与动机

为什么做:FastDeploy v2.5发布后,原始提交仅更新了中文文档,导致英文文档仍引用v2.4版本,且安装指南中存在错误版本号(如paddlepaddle-gpu==3.3.0)。作者Jiang-Jia-Jun在评论中明确指出:“这个PR仅修改了中文文档,请帮忙修改英文文档”,目标是消除版本不一致,提供准确的用户安装指引。

实现拆解

改动按文件拆解如下:
| 文件 | 关键变更 | 影响 |
|------|----------|------|
| README_CN.mdREADME_EN.md | 新增v2.5发布条目(支持Qwen3-VL MoE、W4AFP8量化等),调整v2.4条目格式 | 用户获取最新发布信息 |
| docs/get_started/installation/nvidia_gpu.md(英文) | 更新Docker镜像至2.5.0,支持SM80/86/89/90;更新paddlepaddle-gpu至3.3.1,增加CUDA 12.9选项;更新fastdeploy-gpu至2.5.0,简化安装命令;添加说明澄清--extra-index-url仅用于依赖下载 | 英文用户安装指南 |
| docs/zh/get_started/installation/nvidia_gpu.md(中文) | 同步以上变更,修复残留版本引用 | 中文用户安装指南 |

关键代码逻辑示例(从patch中提取):

**Notice**: The pre-built image supports SM80/86/89/90 GPUs (e.g. A800/H800/L20/L40/4090).

评论区精华

review讨论中,最有价值的交锋围绕文档一致性和清晰度:

  • 中英文不一致:fastdeploy-bot指出:“英文版已将Docker镜像的Notice更新为支持SM 80/86/89/90架构,但中文版第17行的注意说明仍保留旧内容”,这会导致用户误操作。作者及时响应,Copilot在提交中同步更新。
  • 安装命令澄清:Copilot评论:“文案强调‘不要通过pypi源安装’,但命令里又使用了--extra-index-url...这会让读者误解”,作者Jiang-Jia-Jun回复:“这个说得很对,补充说明下extra-index-url只用下依赖下载吧”。随后提交添加了明确说明,提升了文档可读性。

风险与影响

技术风险

  1. 文档不一致:若中英文文档未同步,用户可能基于错误信息部署(如误判GPU支持范围),但review过程已捕获并修复。
  2. 误导风险:安装命令中--extra-index-url若不澄清,用户可能误从PyPI安装fastdeploy-gpu,导致版本冲突;提交中的说明已缓解此风险。

影响分析

  • 用户:所有FastDeploy用户受益于准确的v2.5文档,减少安装错误。
  • 系统:无运行时影响,纯文档变更。
  • 团队:维护文档一致性,降低后续支持开销。

关联脉络

与近期PR 7278(添加DeepSeek-V3.2文档)类似,本PR是FastDeploy文档维护工作流的一部分,反映团队在版本发布后及时同步文档的实践。从历史PR看,文档更新常伴随发布周期(如v2.5),旨在确保用户指南与代码演进同步。

参与讨论