执行摘要
本PR同步了FastDeploy v2.5版本的中英文文档,更新了README发布信息和NVIDIA GPU安装指南,修复了残留的旧版本引用并澄清安装命令细节。作为纯文档变更,风险较低,但确保了用户能准确获取部署信息,维护了文档一致性。
功能与动机
为什么做:FastDeploy v2.5发布后,原始提交仅更新了中文文档,导致英文文档仍引用v2.4版本,且安装指南中存在错误版本号(如paddlepaddle-gpu==3.3.0)。作者Jiang-Jia-Jun在评论中明确指出:“这个PR仅修改了中文文档,请帮忙修改英文文档”,目标是消除版本不一致,提供准确的用户安装指引。
实现拆解
改动按文件拆解如下:
| 文件 | 关键变更 | 影响 |
|------|----------|------|
| README_CN.md 和 README_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只用下依赖下载吧”。随后提交添加了明确说明,提升了文档可读性。
风险与影响
技术风险:
- 文档不一致:若中英文文档未同步,用户可能基于错误信息部署(如误判GPU支持范围),但review过程已捕获并修复。
- 误导风险:安装命令中
--extra-index-url若不澄清,用户可能误从PyPI安装fastdeploy-gpu,导致版本冲突;提交中的说明已缓解此风险。
影响分析:
- 用户:所有FastDeploy用户受益于准确的v2.5文档,减少安装错误。
- 系统:无运行时影响,纯文档变更。
- 团队:维护文档一致性,降低后续支持开销。
关联脉络
与近期PR 7278(添加DeepSeek-V3.2文档)类似,本PR是FastDeploy文档维护工作流的一部分,反映团队在版本发布后及时同步文档的实践。从历史PR看,文档更新常伴随发布周期(如v2.5),旨在确保用户指南与代码演进同步。
参与讨论