README.md 4.93 KB
Newer Older
Zhuohan Li's avatar
Zhuohan Li committed
1
2
<p align="center">
  <picture>
Zhuohan Li's avatar
Zhuohan Li committed
3
4
    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vllm-project/vllm/main/docs/source/assets/logos/vllm-logo-text-dark.png">
    <img alt="vLLM" src="https://raw.githubusercontent.com/vllm-project/vllm/main/docs/source/assets/logos/vllm-logo-text-light.png" width=55%>
Zhuohan Li's avatar
Zhuohan Li committed
5
6
  </picture>
</p>
Woosuk Kwon's avatar
Woosuk Kwon committed
7

Zhuohan Li's avatar
Zhuohan Li committed
8
9
10
<h3 align="center">
Easy, fast, and cheap LLM serving for everyone
</h3>
Woosuk Kwon's avatar
Woosuk Kwon committed
11

Zhuohan Li's avatar
Zhuohan Li committed
12
<p align="center">
Woosuk Kwon's avatar
Woosuk Kwon committed
13
| <a href="https://vllm.readthedocs.io/en/latest/"><b>Documentation</b></a> | <a href="https://vllm.ai"><b>Blog</b></a> | <a href="https://github.com/vllm-project/vllm/discussions"><b>Discussions</b></a> |
Woosuk Kwon's avatar
Woosuk Kwon committed
14

Zhuohan Li's avatar
Zhuohan Li committed
15
</p>
Woosuk Kwon's avatar
Woosuk Kwon committed
16

Zhuohan Li's avatar
Zhuohan Li committed
17
---
18

Zhuohan Li's avatar
Zhuohan Li committed
19
*Latest News* 🔥
Zhuohan Li's avatar
Zhuohan Li committed
20
- [2023/07] Added support for LLaMA-2! You can run and serve 7B/13B/70B LLaMA-2s on vLLM with a single command!
21
- [2023/06] Serving vLLM On any Cloud with SkyPilot. Check out a 1-click [example](https://github.com/skypilot-org/skypilot/blob/master/llm/vllm) to start the vLLM demo, and the [blog post](https://blog.skypilot.co/serving-llm-24x-faster-on-the-cloud-with-vllm-and-skypilot/) for the story behind vLLM development on the clouds.
Lianmin Zheng's avatar
Lianmin Zheng committed
22
- [2023/06] We officially released vLLM! FastChat-vLLM integration has powered [LMSYS Vicuna and Chatbot Arena](https://chat.lmsys.org) since mid-April. Check out our [blog post](https://vllm.ai).
Zhuohan Li's avatar
Zhuohan Li committed
23
24

---
25

Woosuk Kwon's avatar
Woosuk Kwon committed
26
vLLM is a fast and easy-to-use library for LLM inference and serving.
27

Zhuohan Li's avatar
Zhuohan Li committed
28
vLLM is fast with:
29

Zhuohan Li's avatar
Zhuohan Li committed
30
- State-of-the-art serving throughput
31
- Efficient management of attention key and value memory with **PagedAttention**
32
- Continuous batching of incoming requests
33
- Optimized CUDA kernels
Zhuohan Li's avatar
Zhuohan Li committed
34
35
36
37
38

vLLM is flexible and easy to use with:

- Seamless integration with popular HuggingFace models
- High-throughput serving with various decoding algorithms, including *parallel sampling*, *beam search*, and more
39
40
41
- Tensor parallelism support for distributed inference
- Streaming outputs
- OpenAI-compatible API server
42

43
44
vLLM seamlessly supports many Huggingface models, including the following architectures:

Zhuohan Li's avatar
Zhuohan Li committed
45
- Baichuan-7B (`baichuan-inc/Baichuan-7B`)
Woosuk Kwon's avatar
Woosuk Kwon committed
46
- BLOOM (`bigscience/bloom`, `bigscience/bloomz`, etc.)
Zhuohan Li's avatar
Zhuohan Li committed
47
- GPT-2 (`gpt2`, `gpt2-xl`, etc.)
48
- GPT BigCode (`bigcode/starcoder`, `bigcode/gpt_bigcode-santacoder`, etc.)
49
- GPT-J (`EleutherAI/gpt-j-6b`, `nomic-ai/gpt4all-j`, etc.)
50
- GPT-NeoX (`EleutherAI/gpt-neox-20b`, `databricks/dolly-v2-12b`, `stabilityai/stablelm-tuned-alpha-7b`, etc.)
Zhuohan Li's avatar
Zhuohan Li committed
51
- LLaMA & LLaMA-2 (`meta-llama/Llama-2-70b-hf`, `lmsys/vicuna-13b-v1.3`, `young-geng/koala`, `openlm-research/open_llama_13b`, etc.)
52
- MPT (`mosaicml/mpt-7b`, `mosaicml/mpt-30b`, etc.)
Zhuohan Li's avatar
Zhuohan Li committed
53
- OPT (`facebook/opt-66b`, `facebook/opt-iml-max-30b`, etc.)
54

55
Install vLLM with pip or [from source](https://vllm.readthedocs.io/en/latest/getting_started/installation.html#build-from-source):
Zhuohan Li's avatar
Zhuohan Li committed
56
57
58
59
60
61
62

```bash
pip install vllm
```

## Getting Started

63
64
65
66
Visit our [documentation](https://vllm.readthedocs.io/en/latest/) to get started.
- [Installation](https://vllm.readthedocs.io/en/latest/getting_started/installation.html)
- [Quickstart](https://vllm.readthedocs.io/en/latest/getting_started/quickstart.html)
- [Supported Models](https://vllm.readthedocs.io/en/latest/models/supported_models.html)
Zhuohan Li's avatar
Zhuohan Li committed
67

68
## Performance
69

70
vLLM outperforms HuggingFace Transformers (HF) by up to 24x and Text Generation Inference (TGI) by up to 3.5x, in terms of throughput.
Woosuk Kwon's avatar
Woosuk Kwon committed
71
For details, check out our [blog post](https://vllm.ai).
72

73
<p align="center">
Zhuohan Li's avatar
Zhuohan Li committed
74
  <picture>
Zhuohan Li's avatar
Zhuohan Li committed
75
76
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vllm-project/vllm/main/docs/source/assets/figures/perf_a10g_n1_dark.png">
  <img src="https://raw.githubusercontent.com/vllm-project/vllm/main/docs/source/assets/figures/perf_a10g_n1_light.png" width="45%">
Zhuohan Li's avatar
Zhuohan Li committed
77
78
  </picture>
  <picture>
Woosuk Kwon's avatar
Woosuk Kwon committed
79
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vllm-project/vllm/main/docs/source/assets/figures/perf_a100_n1_dark.png">
Zhuohan Li's avatar
Zhuohan Li committed
80
  <img src="https://raw.githubusercontent.com/vllm-project/vllm/main/docs/source/assets/figures/perf_a100_n1_light.png" width="45%">
Zhuohan Li's avatar
Zhuohan Li committed
81
  </picture>
82
83
84
  <br>
  <em> Serving throughput when each request asks for 1 output completion. </em>
</p>
85

86
<p align="center">
Zhuohan Li's avatar
Zhuohan Li committed
87
  <picture>
Woosuk Kwon's avatar
Woosuk Kwon committed
88
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vllm-project/vllm/main/docs/source/assets/figures/perf_a10g_n3_dark.png">
Zhuohan Li's avatar
Zhuohan Li committed
89
  <img src="https://raw.githubusercontent.com/vllm-project/vllm/main/docs/source/assets/figures/perf_a10g_n3_light.png" width="45%">
Zhuohan Li's avatar
Zhuohan Li committed
90
91
  </picture>
  <picture>
Woosuk Kwon's avatar
Woosuk Kwon committed
92
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/vllm-project/vllm/main/docs/source/assets/figures/perf_a100_n3_dark.png">
Zhuohan Li's avatar
Zhuohan Li committed
93
  <img src="https://raw.githubusercontent.com/vllm-project/vllm/main/docs/source/assets/figures/perf_a100_n3_light.png" width="45%">
Zhuohan Li's avatar
Zhuohan Li committed
94
  </picture>  <br>
95
96
  <em> Serving throughput when each request asks for 3 output completions. </em>
</p>
97

98
## Contributing
99

100
101
We welcome and value any contributions and collaborations.
Please check out [CONTRIBUTING.md](./CONTRIBUTING.md) for how to get involved.