[Doc][Misc] Comprehensive documentation cleanup and grammatical fixes (#8073)
What this PR does / why we need it? This pull request performs a comprehensive cleanup of the vLLM Ascend documentation. It fixes numerous typos, grammatical errors, and phrasing issues across community guidelines, developer documents, hardware tutorials, and feature guides. Key improvements include correcting hardware names (e.g., Atlas 300I), fixing broken links, cleaning up code examples (removing duplicate flags and trailing commas), and improving the clarity of technical explanations. These changes are necessary to ensure the documentation is professional, accurate, and easy for users to follow. Does this PR introduce any user-facing change? No, this PR contains documentation-only updates. How was this patch tested? The changes were manually reviewed for accuracy and grammatical correctness. No functional code changes were introduced. --------- Signed-off-by: herizhen <1270637059@qq.com> Signed-off-by: herizhen <59841270+herizhen@users.noreply.github.com>
This commit is contained in:
@@ -20,12 +20,12 @@ msgstr ""
|
||||
"Plural-Forms: nplurals=1; plural=0;\n"
|
||||
"Generated-By: Babel 2.17.0\n"
|
||||
|
||||
#: ../../developer_guide/feature_guide/index.md:1
|
||||
#: ../../developer_guide/feature_guide/index.md:5
|
||||
msgid "Feature Guide"
|
||||
msgstr "功能指南"
|
||||
#: ../../developer_guide/Design_Documents/index.md:1
|
||||
#: ../../developer_guide/Design_Documents/index.md:5
|
||||
msgid "Design Documents"
|
||||
msgstr "设计文档"
|
||||
|
||||
#: ../../developer_guide/feature_guide/index.md:3
|
||||
#: ../../developer_guide/Design_Documents/index.md:3
|
||||
msgid ""
|
||||
"This section provides an overview of the features implemented in vLLM "
|
||||
"Ascend. Developers can refer to this guide to understand how vLLM Ascend "
|
||||
@@ -20,11 +20,11 @@ msgstr ""
|
||||
"Plural-Forms: nplurals=1; plural=0;\n"
|
||||
"Generated-By: Babel 2.17.0\n"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:1
|
||||
#: ../../developer_guide/Design_Documents/patch.md:1
|
||||
msgid "Patch in vLLM Ascend"
|
||||
msgstr "在 vLLM Ascend 中的补丁"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:3
|
||||
#: ../../developer_guide/Design_Documents/patch.md:3
|
||||
msgid ""
|
||||
"vLLM Ascend is a platform plugin for vLLM. Due to the release cycle of vLLM "
|
||||
"and vLLM Ascend is different, and the hardware limitation in some case, we "
|
||||
@@ -33,17 +33,17 @@ msgstr ""
|
||||
"vLLM Ascend 是 vLLM 的一个平台插件。由于 vLLM 和 vLLM Ascend "
|
||||
"的发布周期不同,并且在某些情况下存在硬件限制,我们需要对 vLLM 进行一些代码补丁,以使其能够兼容 vLLM Ascend。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:5
|
||||
#: ../../developer_guide/Design_Documents/patch.md:5
|
||||
msgid ""
|
||||
"In vLLM Ascend code, we provide a patch module `vllm_ascend/patch` to "
|
||||
"address the change for vLLM."
|
||||
msgstr "在 vLLM Ascend 代码中,我们提供了一个补丁模块 `vllm_ascend/patch` 用于应对 vLLM 的变更。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:7
|
||||
#: ../../developer_guide/Design_Documents/patch.md:7
|
||||
msgid "Principle"
|
||||
msgstr "原理"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:9
|
||||
#: ../../developer_guide/Design_Documents/patch.md:9
|
||||
msgid ""
|
||||
"We should keep in mind that Patch is not the best way to make vLLM Ascend "
|
||||
"compatible. It's just a temporary solution. The best way is to contribute "
|
||||
@@ -53,29 +53,29 @@ msgstr ""
|
||||
"我们需要记住,Patch 不是让 vLLM 兼容 Ascend 的最佳方式,这只是一个临时的解决方案。最好的方法是将修改贡献到 vLLM 项目中,从而让"
|
||||
" vLLM 原生支持 Ascend。对于 vLLM Ascend,我们对 Patch 策略有一个基本原则:"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:11
|
||||
#: ../../developer_guide/Design_Documents/patch.md:11
|
||||
msgid "Less is more. Please do not patch unless it's the only way currently."
|
||||
msgstr "少即是多。请不要打补丁,除非这是目前唯一的方法。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:12
|
||||
#: ../../developer_guide/Design_Documents/patch.md:12
|
||||
msgid ""
|
||||
"Once a patch is added, it's required to describe the future plan for "
|
||||
"removing the patch."
|
||||
msgstr "一旦补丁被添加,必须说明将来移除该补丁的计划。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:13
|
||||
#: ../../developer_guide/Design_Documents/patch.md:13
|
||||
msgid "Anytime, clean the patch code is welcome."
|
||||
msgstr "任何时候,欢迎清理补丁代码。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:15
|
||||
#: ../../developer_guide/Design_Documents/patch.md:15
|
||||
msgid "How it works"
|
||||
msgstr "工作原理"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:17
|
||||
#: ../../developer_guide/Design_Documents/patch.md:17
|
||||
msgid "In `vllm_ascend/patch`, you can see the code structure as follows:"
|
||||
msgstr "在 `vllm_ascend/patch` 目录中,你可以看到如下代码结构:"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:33
|
||||
#: ../../developer_guide/Design_Documents/patch.md:33
|
||||
msgid ""
|
||||
"**platform**: The patch code in this directory is for patching the code in "
|
||||
"vLLM main process. It's called by "
|
||||
@@ -85,7 +85,7 @@ msgstr ""
|
||||
"**platform**:此目录下的补丁代码用于修补 vLLM 主进程中的代码。当 vLLM 初始化时,会在很早的阶段由 "
|
||||
"`vllm_ascend/platform::NPUPlatform::pre_register_and_update` 调用。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:34
|
||||
#: ../../developer_guide/Design_Documents/patch.md:34
|
||||
msgid ""
|
||||
"For online mode, vLLM process calls the platform patch here "
|
||||
"`vllm/vllm/engine/arg_utils.py::AsyncEngineArgs.add_cli_args` when parsing "
|
||||
@@ -94,7 +94,7 @@ msgstr ""
|
||||
"对于在线模式,vLLM 进程在解析命令行参数时,会在 "
|
||||
"`vllm/vllm/engine/arg_utils.py::AsyncEngineArgs.add_cli_args` 这里调用平台补丁。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:35
|
||||
#: ../../developer_guide/Design_Documents/patch.md:35
|
||||
msgid ""
|
||||
"For offline mode, vLLM process calls the platform patch here "
|
||||
"`vllm/vllm/engine/arg_utils.py::EngineArgs.create_engine_config` when "
|
||||
@@ -103,7 +103,7 @@ msgstr ""
|
||||
"对于离线模式,vLLM 进程在解析输入参数时,会在此处调用平台补丁 "
|
||||
"`vllm/vllm/engine/arg_utils.py::EngineArgs.create_engine_config`。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:36
|
||||
#: ../../developer_guide/Design_Documents/patch.md:36
|
||||
msgid ""
|
||||
"**worker**: The patch code in this directory is for patching the code in "
|
||||
"vLLM worker process. It's called by "
|
||||
@@ -113,7 +113,7 @@ msgstr ""
|
||||
"**worker**:此目录中的补丁代码用于修补 vLLM worker 进程中的代码。在初始化 vLLM worker 进程时,会被 "
|
||||
"`vllm_ascend/worker/worker::NPUWorker::__init__` 调用。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:37
|
||||
#: ../../developer_guide/Design_Documents/patch.md:37
|
||||
msgid ""
|
||||
"For both online and offline mode, vLLM engine core process calls the worker "
|
||||
"patch here `vllm/vllm/worker/worker_base.py::WorkerWrapperBase.init_worker` "
|
||||
@@ -122,13 +122,13 @@ msgstr ""
|
||||
"无论是在线还是离线模式,vLLM 引擎核心进程在初始化 worker 进程时,都会在这里调用 worker "
|
||||
"补丁:`vllm/vllm/worker/worker_base.py::WorkerWrapperBase.init_worker`。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:39
|
||||
#: ../../developer_guide/Design_Documents/patch.md:39
|
||||
msgid ""
|
||||
"In both **platform** and **worker** folder, there are several patch modules."
|
||||
" They are used for patching different version of vLLM."
|
||||
msgstr "在 **platform** 和 **worker** 文件夹中都有一些补丁模块。它们用于修补不同版本的 vLLM。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:41
|
||||
#: ../../developer_guide/Design_Documents/patch.md:41
|
||||
msgid ""
|
||||
"`patch_0_9_2`: This module is used for patching vLLM 0.9.2. The version is "
|
||||
"always the nearest version of vLLM. Once vLLM is released, we will drop this"
|
||||
@@ -138,22 +138,22 @@ msgstr ""
|
||||
"`patch_0_9_2`:此模块用于修补 vLLM 0.9.2。该版本始终对应于 vLLM 的最近版本。一旦 vLLM "
|
||||
"发布新版本,我们将移除此补丁模块并升级到新版本。例如,`patch_0_9_2` 就是用于修补 vLLM 0.9.2 的。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:42
|
||||
#: ../../developer_guide/Design_Documents/patch.md:42
|
||||
msgid ""
|
||||
"`patch_main`: This module is used for patching the code in vLLM main branch."
|
||||
msgstr "`patch_main`:该模块用于修补 vLLM 主分支代码。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:43
|
||||
#: ../../developer_guide/Design_Documents/patch.md:43
|
||||
msgid ""
|
||||
"`patch_common`: This module is used for patching both vLLM 0.9.2 and vLLM "
|
||||
"main branch."
|
||||
msgstr "`patch_common`:此模块用于同时修补 vLLM 0.9.2 版本和 vLLM 主分支。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:45
|
||||
#: ../../developer_guide/Design_Documents/patch.md:45
|
||||
msgid "How to write a patch"
|
||||
msgstr "如何撰写补丁"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:47
|
||||
#: ../../developer_guide/Design_Documents/patch.md:47
|
||||
msgid ""
|
||||
"Before writing a patch, following the principle above, we should patch the "
|
||||
"least code. If it's necessary, we can patch the code in either **platform** "
|
||||
@@ -163,19 +163,19 @@ msgstr ""
|
||||
"在编写补丁之前,遵循上述原则,我们应尽量修改最少的代码。如果有必要,我们可以修改 **platform** 和 **worker** "
|
||||
"文件夹中的代码。下面是一个在 vLLM 中修改 `distributed` 模块的示例。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:49
|
||||
#: ../../developer_guide/Design_Documents/patch.md:49
|
||||
msgid ""
|
||||
"Decide which version of vLLM we should patch. For example, after analysis, "
|
||||
"here we want to patch both 0.9.2 and main of vLLM."
|
||||
msgstr "决定我们应该修补哪个版本的 vLLM。例如,经过分析后,这里我们想要同时修补 vLLM 的 0.9.2 版和主分支(main)。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:50
|
||||
#: ../../developer_guide/Design_Documents/patch.md:50
|
||||
msgid ""
|
||||
"Decide which process we should patch. For example, here `distributed` "
|
||||
"belongs to the vLLM main process, so we should patch `platform`."
|
||||
msgstr "决定我们应该修补哪个进程。例如,这里 `distributed` 属于 vLLM 主进程,所以我们应该修补 `platform`。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:51
|
||||
#: ../../developer_guide/Design_Documents/patch.md:51
|
||||
#, python-brace-format
|
||||
msgid ""
|
||||
"Create the patch file in the right folder. The file should be named as "
|
||||
@@ -185,11 +185,11 @@ msgstr ""
|
||||
"在正确的文件夹中创建补丁文件。文件应命名为 `patch_{module_name}.py`。此处的示例是 "
|
||||
"`vllm_ascend/patch/platform/patch_common/patch_distributed.py`。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:52
|
||||
#: ../../developer_guide/Design_Documents/patch.md:52
|
||||
msgid "Write your patch code in the new file. Here is an example:"
|
||||
msgstr "在新文件中编写你的补丁代码。以下是一个示例:"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:62
|
||||
#: ../../developer_guide/Design_Documents/patch.md:62
|
||||
msgid ""
|
||||
"Import the patch file in `__init__.py`. In this example, add `import "
|
||||
"vllm_ascend.patch.platform.patch_common.patch_distributed` into "
|
||||
@@ -199,13 +199,13 @@ msgstr ""
|
||||
"vllm_ascend.patch.platform.patch_common.patch_distributed` 添加到 "
|
||||
"`vllm_ascend/patch/platform/patch_common/__init__.py` 中。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:63
|
||||
#: ../../developer_guide/Design_Documents/patch.md:63
|
||||
msgid ""
|
||||
"Add the description of the patch in `vllm_ascend/patch/__init__.py`. The "
|
||||
"description format is as follows:"
|
||||
msgstr "在 `vllm_ascend/patch/__init__.py` 中添加补丁的描述。描述格式如下:"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:77
|
||||
#: ../../developer_guide/Design_Documents/patch.md:77
|
||||
msgid ""
|
||||
"Add the Unit Test and E2E Test. Any newly added code in vLLM Ascend should "
|
||||
"contain the Unit Test and E2E Test as well. You can find more details in "
|
||||
@@ -214,11 +214,11 @@ msgstr ""
|
||||
"添加单元测试和端到端(E2E)测试。在 vLLM Ascend 中新增的任何代码也应包含单元测试和端到端测试。更多详情请参见 "
|
||||
"[测试指南](../contribution/testing.md)。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:80
|
||||
#: ../../developer_guide/Design_Documents/patch.md:80
|
||||
msgid "Limitation"
|
||||
msgstr "限制"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:81
|
||||
#: ../../developer_guide/Design_Documents/patch.md:81
|
||||
msgid ""
|
||||
"In V1 Engine, vLLM starts three kinds of process: Main process, EngineCore "
|
||||
"process and Worker process. Now vLLM Ascend only support patch the code in "
|
||||
@@ -232,7 +232,7 @@ msgstr ""
|
||||
"进程整体打补丁,入口代码在 `vllm.v1.engine.core`。请完全重写 `EngineCoreProc` 和 "
|
||||
"`DPEngineCoreProc`。"
|
||||
|
||||
#: ../../developer_guide/feature_guide/patch.md:82
|
||||
#: ../../developer_guide/Design_Documents/patch.md:82
|
||||
msgid ""
|
||||
"If you are running an edited vLLM code, the version of the vLLM may be "
|
||||
"changed automatically. For example, if you runs an edited vLLM based on "
|
||||
Reference in New Issue
Block a user