Refeactor installatio docn

Yikun · Yikun · commit 8fdb89fa0a1c · 2025-02-17T21:56:41.000+08:00
Signed-off-by: Yikun Jiang &lt;yikunkero@gmail.com&gt;
diff --git a/README.md b/README.md
@@ -68,7 +68,8 @@ Run the following command to start the vLLM server with the [Qwen/Qwen2.5-0.5B-I
 vllm serve Qwen/Qwen2.5-0.5B-Instruct
 curl http://localhost:8000/v1/models
 ```
-**Please refer to [official docs](https://vllm-ascend.readthedocs.io/en/latest/) for more details.**
+
+Please refer to [QuickStart](https://vllm-ascend.readthedocs.io/en/latest/quick_start.html) and [Installation](https://vllm-ascend.readthedocs.io/en/latest/installation.html) for more details.
 
 ## Contributing
 See [CONTRIBUTING](docs/source/developer_guide/contributing.md) for more details, which is a step-by-step guide to help you set up development environment, build and test.
diff --git a/README.zh.md b/README.zh.md
@@ -69,7 +69,7 @@ vllm serve Qwen/Qwen2.5-0.5B-Instruct
 curl http://localhost:8000/v1/models
 ```
 
-**请参阅 [官方文档](https://vllm-ascend.readthedocs.io/en/latest/)以获取更多详细信息**
+请查看[快速开始](https://vllm-ascend.readthedocs.io/en/latest/quick_start.html)和[安装指南](https://vllm-ascend.readthedocs.io/en/latest/installation.html)了解更多.
 
 ## 分支
 
diff --git a/docs/source/installation.md b/docs/source/installation.md
@@ -17,43 +17,30 @@ This document describes how to install vllm-ascend manually.
 
 ## Configure a new environment
 
-Before installing the package,  you need to make sure firmware/driver and CANN is installed correctly.
+Before installing, you need to make sure firmware/driver and CANN is installed correctly.
 
 ### Install firmwares and drivers
 
-To verify that the Ascend NPU firmware and driver were correctly installed, run `npu-smi info`.
-
-> Tips: Refer to [Ascend Environment Setup Guide](https://ascend.github.io/docs/sources/ascend/quick_install.html) for more details.
-
-### Install CANN (optional)
-
-The installation of CANN wouldn’t be necessary if you are using a CANN container image, you can skip this step.If you want to install vllm-ascend on a bare environment by hand, you need install CANN first.
+To verify that the Ascend NPU firmware and driver were correctly installed, run:
 
 ```bash
-# Create a virtual environment
-python -m venv vllm-ascend-env
-source vllm-ascend-env/bin/activate
-
-# Install required python packages.
-pip3 install -i https://pypi.tuna.tsinghua.edu.cn/simple attrs numpy==1.24.0 decorator sympy cffi pyyaml pathlib2 psutil protobuf scipy requests absl-py wheel typing_extensions
-
-# Download and install the CANN package.
-wget https://ascend-repo.obs.cn-east-2.myhuaweicloud.com/CANN/CANN%208.0.0/Ascend-cann-toolkit_8.0.0_linux-aarch64.run
-sh Ascend-cann-toolkit_8.0.0_linux-aarch64.run --full
-wget https://ascend-repo.obs.cn-east-2.myhuaweicloud.com/CANN/CANN%208.0.0/Ascend-cann-kernels-910b_8.0.0_linux-aarch64.run
-sh Ascend-cann-kernels-910b_8.0.0_linux-aarch64.run --full
+npu-smi info
 ```
 
-Once it's done, you can read either **Set up using Python** or **Set up using Docker** section to install and use vllm-ascend.
+Refer to [Ascend Environment Setup Guide](https://ascend.github.io/docs/sources/ascend/quick_install.html) for more details.
+
+### Install CANN
 
-## Set up using Python
+:::::{tab-set}
+:sync-group: install
 
-> Notes: If you are installing vllm-ascend on an arch64 machine, The `-f https://download.pytorch.org/whl/torch/` command parameter in this section can be omitted. It's only used for find torch package on x86 machine.
+::::{tab-item} Using pip
+:selected:
+:sync: pip
 
-Please make sure that CANN is installed. It can be done by **Configure a new environment** step. Or by using an CANN container directly:
+The easiest way to prepare your CANN environment is using container directly:
 
 ```bash
-# Setup a CANN container using docker
 # Update DEVICE according to your device (/dev/davinci[0-7])
 DEVICE=/dev/davinci7
 
@@ -71,58 +58,75 @@ docker run --rm \
     -it quay.io/ascend/cann:8.0.0.beta1-910b-ubuntu22.04-py3.10 bash
 ```
 
-Then you can install vllm-ascend from **pre-built wheel** or **source code**.
+You can also install CANN manually:
 
-### Install from Pre-built wheels (Not support yet)
+```bash
+# Create a virtual environment
+python -m venv vllm-ascend-env
+source vllm-ascend-env/bin/activate
 
-1. Install vllm
+# Install required python packages.
+pip3 install -i https://pypi.tuna.tsinghua.edu.cn/simple attrs numpy==1.24.0 decorator sympy cffi pyyaml pathlib2 psutil protobuf scipy requests absl-py wheel typing_extensions
 
-    Since vllm on pypi is not compatible with cpu, we need to install vllm from source code.
+# Download and install the CANN package.
+wget https://ascend-repo.obs.cn-east-2.myhuaweicloud.com/CANN/CANN%208.0.0/Ascend-cann-toolkit_8.0.0_linux-aarch64.run
+sh Ascend-cann-toolkit_8.0.0_linux-aarch64.run --full
+wget https://ascend-repo.obs.cn-east-2.myhuaweicloud.com/CANN/CANN%208.0.0/Ascend-cann-kernels-910b_8.0.0_linux-aarch64.run
+sh Ascend-cann-kernels-910b_8.0.0_linux-aarch64.run --full
+```
 
-    ```bash
-    git clone --depth 1 --branch v0.7.1 https://github.com/vllm-project/vllm
-    cd vllm
-    VLLM_TARGET_DEVICE=empty pip install . -f https://download.pytorch.org/whl/torch/
-    ```
+::::
 
-2. Install vllm-ascend
+::::{tab-item} Using Docker
+:sync: docker
+No more extra step if you are using `vllm-ascend` image.
+::::
+:::::
 
-    ```bash
-    pip install vllm-ascend -f https://download.pytorch.org/whl/torch/
-    ```
+Once it's done, you can start to set up `vllm` and `vllm-ascend`.
 
-### Install from source code
+## Setup vllm and vllm-ascend
 
-1. Install vllm
+:::::{tab-set}
+:sync-group: install
 
-    ```bash
-    git clone https://github.com/vllm-project/vllm
-    cd vllm
-    VLLM_TARGET_DEVICE=empty pip install . -f https://download.pytorch.org/whl/torch/
-    ```
+::::{tab-item} Using pip
+:selected:
+:sync: pip
 
-2. Install vllm-ascend
+You can install `vllm` and `vllm-ascend` from **pre-built wheel**:
 
-    ```bash
-    git clone https://github.com/vllm-project/vllm-ascend.git
-    cd vllm-ascend
-    pip install -e . -f https://download.pytorch.org/whl/torch/
-    ```
+```bash
+pip install vllm vllm-ascend -f https://download.pytorch.org/whl/torch/
+```
 
-## Set up using Docker
+or build from **source code**:
+
+```bash
+git clone https://github.com/vllm-project/vllm
+cd vllm
+VLLM_TARGET_DEVICE=empty pip install . -f https://download.pytorch.org/whl/torch/
+
+git clone https://github.com/vllm-project/vllm-ascend.git
+cd vllm-ascend
+pip install -e . -f https://download.pytorch.org/whl/torch/
+```
 
-> Tips: CANN, torch, torch_npu, vllm and vllm_ascend are pre-installed in the Docker image already.
+::::
 
-### Pre-built images (Not support yet)
+::::{tab-item} Using docker
+:sync: docker
 
-Just pull the image and run it with bash.
+You can just pull the **prebuilt image** and run it with bash.
 
 ```bash
-docker pull quay.io/ascend/vllm-ascend:latest
+
 
 # Update DEVICE according to your device (/dev/davinci[0-7])
 DEVICE=/dev/davinci7
-
+# Update the vllm-ascend image
+IMAGE=quay.io/ascend/vllm-ascend:main
+docker pull $IMAGE
 docker run --rm \
     --name vllm-ascend-env \
     --device $DEVICE \
@@ -134,35 +138,20 @@ docker run --rm \
     -v /usr/local/Ascend/driver/lib64/:/usr/local/Ascend/driver/lib64/ \
     -v /usr/local/Ascend/driver/version.info:/usr/local/Ascend/driver/version.info \
     -v /etc/ascend_install.info:/etc/ascend_install.info \
-    -it quay.io/ascend/vllm-ascend:0.7.1rc1 bash
+    -it $IMAGE bash
 ```
 
-### Build image from source
-
-If you want to build the docker image from main branch, you can do it by following steps:
+or build IMAGE from **source code**:
 
 ```bash
 git clone https://github.com/vllm-project/vllm-ascend.git
 cd vllm-ascend
-
 docker build -t vllm-ascend-dev-image:latest -f ./Dockerfile .
+```
 
-# Update DEVICE according to your device (/dev/davinci[0-7])
-DEVICE=/dev/davinci7
+::::
 
-docker run --rm \
-    --name vllm-ascend-env \
-    --device $DEVICE \
-    --device /dev/davinci_manager \
-    --device /dev/devmm_svm \
-    --device /dev/hisi_hdc \
-    -v /usr/local/dcmi:/usr/local/dcmi \
-    -v /usr/local/bin/npu-smi:/usr/local/bin/npu-smi \
-    -v /usr/local/Ascend/driver/lib64/:/usr/local/Ascend/driver/lib64/ \
-    -v /usr/local/Ascend/driver/version.info:/usr/local/Ascend/driver/version.info \
-    -v /etc/ascend_install.info:/etc/ascend_install.info \
-    -it vllm-ascend-dev-image:latest bash
-```
+:::::
 
 ## Extra information
 
