Files
xc-llm-ascend/docs/source/index.md
Shanshan Shen 2a678141d4 [Doc] Add vllm-ascend usage doc & fix doc format (#53)
### What this PR does / why we need it?
1. Add vllm-ascend tutorial doc for Qwen/Qwen2.5-7B-Instruct model
serving doc
2. fix format of files in `docs` dir, e.g. format tables, add underline
for links, add line feed...

### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such
as API, interface or other behavior changes.
Documentation-only updates are not considered user-facing changes.
-->

no.

### How was this patch tested?
doc CI passed

---------

Signed-off-by: Shanshan Shen <87969357+shen-shanshan@users.noreply.github.com>
2025-02-17 18:37:29 +08:00

1.8 KiB

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

vLLM Ascend Plugin

<script async defer src="https://buttons.github.io/buttons.js"></script> Star Watch Fork

:::

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, 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-Expert, 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 :::

% What does vLLM Ascend Plugin support? :::{toctree} :caption: Features :maxdepth: 1 features/suppoted_features features/supported_models :::

% How to contribute to the vLLM project :::{toctree} :caption: Developer Guide :maxdepth: 1 developer_guide/contributing developer_guide/versioning_policy :::