7d4833bce9
### What this PR does / why we need it? This PR refactors the tutorial documentation by restructuring it into three categories: Models, Features, and Hardware. This improves the organization and navigation of the tutorials, making it easier for users to find relevant information. - The single `tutorials/index.md` is split into three separate index files: - `docs/source/tutorials/models/index.md` - `docs/source/tutorials/features/index.md` - `docs/source/tutorials/hardwares/index.md` - Existing tutorial markdown files have been moved into their respective new subdirectories (`models/`, `features/`, `hardwares/`). - The main `index.md` has been updated to link to these new tutorial sections. This change makes the documentation structure more logical and scalable for future additions. ### Does this PR introduce _any_ user-facing change? Yes, this PR changes the structure and URLs of the tutorial documentation pages. Users following old links to tutorials will encounter broken links. It is recommended to set up redirects if the documentation framework supports them. ### How was this patch tested? These are documentation-only changes. The documentation should be built and reviewed locally to ensure all links are correct and the pages render as expected. - vLLM version: v0.15.0 - vLLM main: https://github.com/vllm-project/vllm/commit/v0.15.0 Signed-off-by: wangxiyuan <wangxiyuan1007@gmail.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/feature_guide/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
|
|
:::
|