0d1424d81a
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>
74 lines
2.3 KiB
Markdown
74 lines
2.3 KiB
Markdown
# Welcome to vLLM Ascend Plugin
|
|
|
|
:::{figure} ./logos/vllm-ascend-logo-text-light.png
|
|
:align: center
|
|
:alt: vLLM
|
|
:class: no-scaled-link
|
|
:width: 70%
|
|
:::
|
|
|
|
:::{raw} html
|
|
<p style="text-align:center">
|
|
<strong>vLLM Ascend Plugin
|
|
</strong>
|
|
</p>
|
|
|
|
<p style="text-align:center">
|
|
<script async defer src="https://buttons.github.io/buttons.js"></script>
|
|
<a class="github-button" href="https://github.com/vllm-project/vllm-ascend" data-show-count="true" data-size="large" aria-label="Star">Star</a>
|
|
<a class="github-button" href="https://github.com/vllm-project/vllm-ascend/subscription" data-icon="octicon-eye" data-size="large" aria-label="Watch">Watch</a>
|
|
<a class="github-button" href="https://github.com/vllm-project/vllm-ascend/fork" data-icon="octicon-repo-forked" data-size="large" aria-label="Fork">Fork</a>
|
|
</p>
|
|
:::
|
|
|
|
vLLM Ascend plugin (vllm-ascend) is a community-maintained hardware plugin for running vLLM on the Ascend NPU.
|
|
|
|
This plugin is the recommended approach for supporting the Ascend backend within the vLLM community. It adheres to the principles outlined in the [[RFC]: Hardware pluggable](https://github.com/vllm-project/vllm/issues/11162), providing a hardware-pluggable interface that decouples the integration of the Ascend NPU with vLLM.
|
|
|
|
By using vLLM Ascend plugin, popular open-source models, including Transformer-like, Mixture-of-Experts, Embedding, Multi-modal LLMs can run seamlessly on the Ascend NPU.
|
|
|
|
## Documentation
|
|
|
|
% How to start using vLLM on Ascend NPU?
|
|
:::{toctree}
|
|
:caption: Getting Started
|
|
:maxdepth: 1
|
|
quick_start
|
|
installation
|
|
tutorials/models/index
|
|
tutorials/features/index
|
|
tutorials/hardwares/index
|
|
faqs
|
|
:::
|
|
|
|
% What does vLLM Ascend Plugin support?
|
|
:::{toctree}
|
|
:caption: User Guide
|
|
:maxdepth: 1
|
|
user_guide/support_matrix/index
|
|
user_guide/configuration/index
|
|
user_guide/feature_guide/index
|
|
user_guide/deployment_guide/index
|
|
user_guide/release_notes
|
|
:::
|
|
|
|
% How to contribute to the vLLM Ascend project
|
|
:::{toctree}
|
|
:caption: Developer Guide
|
|
:maxdepth: 1
|
|
developer_guide/contribution/index
|
|
developer_guide/Design_Documents/index
|
|
developer_guide/evaluation/index
|
|
developer_guide/performance_and_debug/index
|
|
:::
|
|
|
|
% How to involve vLLM Ascend
|
|
:::{toctree}
|
|
:caption: Community
|
|
:maxdepth: 1
|
|
community/governance
|
|
community/contributors
|
|
community/versioning_policy
|
|
community/user_stories/index
|
|
:::
|