README.md

# <div align="center"><strong>vLLM</strong></div>
## 简介
vLLM是一个快速且易于使用的LLM推理和服务库,使用PageAttention高效管理kv内存,Continuous batching传入请求,支持很多Hugging Face模型,如LLaMA & LLaMA-2、Qwen、Chatglm2 & Chatglm3等。

## 暂不支持的官方功能
- **量化推理**:目前不支持marlin的权重量化、kv-cache fp8推理方案
- **模块支持**:目前不支持Sliding window attention


## 支持模型结构列表
| 结构 | 模型 | FP16/BF16 | AWQ | GPTQ |
| :------: | :------: | :------: | :------: |:------: |
| LlamaForCausalLM      | Llama 3.1,Llama 3,Llama 2,Llama,Yi,Codellama,DeepSeek-R1-Distill-Llama     | Yes | Yes | Yes |  
| QWenLMHeadModel       | QWen,Qwen-VL                                                | Yes | Yes | Yes |
| Qwen2ForCausalLM      | QWen2,QWen1.5,CodeQwen1.5,DeepSeek-R1-Distill-Qwen,gte_Qwen2-1.5B-instruct          | Yes | Yes | Yes |
| ChatGLMModel          | glm-4v-9b,chatglm3,chatglm2                                 | Yes | No  | Yes |
| DeepseekForCausalLM   | Deepseek                                                    | Yes | No  | -   |
| DeepseekV2ForCausalLM | DeepSeek-V2                                                 | Yes | No  | -   |
| DeepseekV3ForCausalLM | DeepSeek-V3                                                 | Yes | Yes | -   |
| BaiChuanForCausalLM   | Baichuan2,Baichuan                                          | Yes | Yes | -   |
| BloomForCausalLM      | BLOOM                                                       | Yes | No  | Yes |
| InternLMForCausalLM   | InternLM                                                    | Yes | No  | -   |
| InternLM2ForCausalLM  | InternLM2                                                   | Yes | No  | -   |
| FalconForCausalLM     | falcon                                                      | Yes | No  | Yes |
| TeleChat2ForCausalLM  | TeleChat2                                                   | Yes | No  | -   |
| MiniCPMForCausalLM    | MiniCPM                                                     | Yes | No  | -   |
| MiniCPM3ForCausalLM   | MiniCPM3                                                    | Yes | No  | -   |
| MixtralForCausalLM    | Mixtral-8x7B,Mixtral-8x7B-Instruct                          | Yes | No  | -   |
| Qwen2MoeForCausalLM                 | Qwen2-57B-A14B,Qwen2-57B-A14B-Instruct        | Yes | No  | -   |
| LlavaForConditionalGeneration       | LLaMA,LLaMA-2,LLaMA-3                         | Yes | No  | -   |
| Qwen2VLForConditionalGeneration     | Qwen2-VL                                      | Yes | No  | Yes |
| MiniCPMV                            | MiniCPM-V                                     | Yes | No  | -   |
| Phi3VForCausalLM                    | Phi-3.5-vision                                | Yes | No  | -   |
| BertModel                           | bge-large-zh-v1.5                             | Yes | No  | -   |
| XLMRobertaModel                     | bge-m3                                        | Yes | No  | -   |
| XLMRobertaForSequenceClassification | bge-reranker-v2-m3                            | Yes | No  | -   |


## 安装
vLLM支持
+ Python 3.9.
+ Python 3.10.
+ Python 3.11.
+ Python 3.12.

### 使用源码编译方式安装

#### 编译环境准备
提供2种环境准备方式:

1. 基于光源pytorch2.4.1基础镜像环境:根据pytorch2.4.1、python、dtk及系统下载对应的镜像版本。

2. 基于现有python环境:安装pytorch2.4.1,pytorch whl包下载目录:[https://cancon.hpccube.com:65024/4/main/pytorch](https://cancon.hpccube.com:65024/4/main/pytorch),根据python、dtk版本,下载对应pytorch2.4.1的whl包。安装命令如下:
```shell
pip install torch* (下载的torch的whl包)
pip install setuptools wheel
```

#### 源码编译安装
```shell
git clone http://developer.hpccube.com/codes/OpenDAS/vllm.git # 根据需要的分支进行切换
```
安装依赖:
```shell
pip install -r requirements/rocm.txt
```
- 提供2种源码编译方式(进入vllm目录):
```
1. 编译whl包并安装
VLLM_INSTALL_PUNICA_KERNELS=1 python setup.py bdist_wheel 
cd dist
pip install vllm*

2. 源码编译安装
VLLM_INSTALL_PUNICA_KERNELS=1 python3 setup.py install （若调试，可使用VLLM_INSTALL_PUNICA_KERNELS=1 python3 setup.py develop）
```
若需要添加git号，设置环境变量: export ADD_GIT_VERSION=1

#### 运行基础环境准备
1、使用上面基于光源pytorch2.4.1基础镜像环境

2、根据pytorch2.4.1、python、dtk及系统下载对应的依赖包:
- triton:[https://cancon.hpccube.com:65024/4/main/triton](https://cancon.hpccube.com:65024/4/main/triton/)
- flash_attn: [https://cancon.hpccube.com:65024/4/main/flash_attn](https://cancon.hpccube.com:65024/4/main/flash_attn)
- lmslim: [https://cancon.hpccube.com:65024/4/main/lmslim](https://cancon.hpccube.com:65024/4/main/lmslim)

#### 注意事项
+ 若使用 pip install 下载安装过慢,可添加源:-i https://pypi.tuna.tsinghua.edu.cn/simple/

## 验证
- python -c "import vllm; print(vllm.\_\_version__)",版本号与官方版本同步,查询该软件的版本号,例如0.8.4;

## Known Issue
- 无

## 参考资料
- [README_ORIGIN](README_ORIGIN.md)
- [https://github.com/vllm-project/vllm](https://github.com/vllm-project/vllm)