supported_models.md 27.9 KB
Newer Older
1
(supported-models)=
Woosuk Kwon's avatar
Woosuk Kwon committed
2

3
# Supported Models
Woosuk Kwon's avatar
Woosuk Kwon committed
4

5
vLLM supports generative and pooling models across various tasks.
6
If a model supports more than one task, you can set the task via the {code}`--task` argument.
7
8

For each task, we list the model architectures that have been implemented in vLLM.
Woosuk Kwon's avatar
Woosuk Kwon committed
9
10
Alongside each architecture, we include some popular models that use it.

11
## Loading a Model
12

13
### HuggingFace Hub
14

15
By default, vLLM loads models from [HuggingFace (HF) Hub](https://huggingface.co/models).
16

17
18
To determine whether a given model is supported, you can check the {code}`config.json` file inside the HF repository.
If the {code}`"architectures"` field contains a model architecture listed below, then it should be supported in theory.
19

20
21
````{tip}
The easiest way to check if your model is really supported at runtime is to run the program below:
22

23
24
```python
from vllm import LLM
25

26
27
28
29
# For generative models (task=generate) only
llm = LLM(model=..., task="generate")  # Name or path of your model
output = llm.generate("Hello, my name is")
print(output)
30

31
# For pooling models (task={embed,classify,reward,score}) only
32
33
34
35
llm = LLM(model=..., task="embed")  # Name or path of your model
output = llm.encode("Hello, my name is")
print(output)
```
36

37
38
If vLLM successfully returns text (for generative models) or hidden states (for pooling models), it indicates that your model is supported.
````
39

40
41
Otherwise, please refer to [Adding a New Model](#adding-a-new-model) and [Enabling Multimodal Inputs](#enabling-multimodal-inputs) for instructions on how to implement your model in vLLM.
Alternatively, you can [open an issue on GitHub](https://github.com/vllm-project/vllm/issues/new/choose) to request vLLM support.
42

43
### ModelScope
44

45
To use models from [ModelScope](https://www.modelscope.cn) instead of HuggingFace Hub, set an environment variable:
46

47
48
49
```shell
$ export VLLM_USE_MODELSCOPE=True
```
50

51
And use with {code}`trust_remote_code=True`.
52

53
54
```python
from vllm import LLM
55

56
llm = LLM(model=..., revision=..., task=..., trust_remote_code=True)
57

58
59
60
# For generative models (task=generate) only
output = llm.generate("Hello, my name is")
print(output)
61

62
# For pooling models (task={embed,classify,reward,score}) only
63
64
65
output = llm.encode("Hello, my name is")
print(output)
```
66

67
## List of Text-only Language Models
68

69
### Generative Models
70

71
See [this page](#generative-models) for more information on how to use generative models.
72

73
#### Text Generation (`--task generate`)
74

75
```{eval-rst}
Woosuk Kwon's avatar
Woosuk Kwon committed
76
.. list-table::
77
  :widths: 25 25 50 5 5
Woosuk Kwon's avatar
Woosuk Kwon committed
78
79
80
81
  :header-rows: 1

  * - Architecture
    - Models
82
    - Example HF Models
83
84
    - :ref:`LoRA <lora-adapter>`
    - :ref:`PP <distributed-serving>`
85
  * - :code:`AquilaForCausalLM`
86
    - Aquila, Aquila2
87
    - :code:`BAAI/Aquila-7B`, :code:`BAAI/AquilaChat-7B`, etc.
88
    - ✅︎
89
    - ✅︎
90
91
92
93
  * - :code:`ArcticForCausalLM`
    - Arctic
    - :code:`Snowflake/snowflake-arctic-base`, :code:`Snowflake/snowflake-arctic-instruct`, etc.
    -
94
    - ✅︎
Zhuohan Li's avatar
Zhuohan Li committed
95
  * - :code:`BaiChuanForCausalLM`
96
    - Baichuan2, Baichuan
97
    - :code:`baichuan-inc/Baichuan2-13B-Chat`, :code:`baichuan-inc/Baichuan-7B`, etc.
Jee Li's avatar
Jee Li committed
98
    - ✅︎
99
    - ✅︎
100
101
102
103
  * - :code:`BloomForCausalLM`
    - BLOOM, BLOOMZ, BLOOMChat
    - :code:`bigscience/bloom`, :code:`bigscience/bloomz`, etc.
    -
104
    - ✅︎
105
106
107
  * - :code:`BartForConditionalGeneration`
    - BART
    - :code:`facebook/bart-base`, :code:`facebook/bart-large-cnn`, etc.
108
109
    -
    -
110
111
112
  * - :code:`ChatGLMModel`
    - ChatGLM
    - :code:`THUDM/chatglm2-6b`, :code:`THUDM/chatglm3-6b`, etc.
Jee Li's avatar
Jee Li committed
113
    - ✅︎
114
    - ✅︎
115
  * - :code:`CohereForCausalLM`,:code:`Cohere2ForCausalLM`
116
    - Command-R
117
    - :code:`CohereForAI/c4ai-command-r-v01`, :code:`CohereForAI/c4ai-command-r7b-12-2024`, etc.
118
119
    - ✅︎
    - ✅︎
120
121
122
  * - :code:`DbrxForCausalLM`
    - DBRX
    - :code:`databricks/dbrx-base`, :code:`databricks/dbrx-instruct`, etc.
123
    -
124
    - ✅︎
125
126
127
  * - :code:`DeciLMForCausalLM`
    - DeciLM
    - :code:`Deci/DeciLM-7B`, :code:`Deci/DeciLM-7B-instruct`, etc.
128
    -
129
    - ✅︎
130
131
132
  * - :code:`DeepseekForCausalLM`
    - DeepSeek
    - :code:`deepseek-ai/deepseek-llm-67b-base`, :code:`deepseek-ai/deepseek-llm-7b-chat` etc.
133
    -
134
    - ✅︎
135
136
137
  * - :code:`DeepseekV2ForCausalLM`
    - DeepSeek-V2
    - :code:`deepseek-ai/DeepSeek-V2`, :code:`deepseek-ai/DeepSeek-V2-Chat` etc.
138
    -
139
    - ✅︎
140
141
142
143
  * - :code:`ExaoneForCausalLM`
    - EXAONE-3
    - :code:`LGAI-EXAONE/EXAONE-3.0-7.8B-Instruct`, etc.
    - ✅︎
144
    - ✅︎
Zhuohan Li's avatar
Zhuohan Li committed
145
146
  * - :code:`FalconForCausalLM`
    - Falcon
147
    - :code:`tiiuae/falcon-7b`, :code:`tiiuae/falcon-40b`, :code:`tiiuae/falcon-rw-7b`, etc.
148
    -
149
    - ✅︎
150
151
152
153
  * - :code:`FalconMambaForCausalLM`
    - FalconMamba
    - :code:`tiiuae/falcon-mamba-7b`, :code:`tiiuae/falcon-mamba-7b-instruct`, etc.
    - ✅︎
154
    - ✅︎
155
156
157
  * - :code:`GemmaForCausalLM`
    - Gemma
    - :code:`google/gemma-2b`, :code:`google/gemma-7b`, etc.
158
    - ✅︎
159
    - ✅︎
Woosuk Kwon's avatar
Woosuk Kwon committed
160
161
162
163
  * - :code:`Gemma2ForCausalLM`
    - Gemma2
    - :code:`google/gemma-2-9b`, :code:`google/gemma-2-27b`, etc.
    - ✅︎
164
    - ✅︎
165
166
167
168
169
  * - :code:`GlmForCausalLM`
    - GLM-4
    - :code:`THUDM/glm-4-9b-chat-hf`, etc.
    - ✅︎
    - ✅︎
Woosuk Kwon's avatar
Woosuk Kwon committed
170
171
  * - :code:`GPT2LMHeadModel`
    - GPT-2
172
    - :code:`gpt2`, :code:`gpt2-xl`, etc.
173
    -
174
    - ✅︎
175
176
177
  * - :code:`GPTBigCodeForCausalLM`
    - StarCoder, SantaCoder, WizardCoder
    - :code:`bigcode/starcoder`, :code:`bigcode/gpt_bigcode-santacoder`, :code:`WizardLM/WizardCoder-15B-V1.0`, etc.
178
    - ✅︎
179
    - ✅︎
180
181
182
  * - :code:`GPTJForCausalLM`
    - GPT-J
    - :code:`EleutherAI/gpt-j-6b`, :code:`nomic-ai/gpt4all-j`, etc.
183
    -
184
    - ✅︎
Woosuk Kwon's avatar
Woosuk Kwon committed
185
186
  * - :code:`GPTNeoXForCausalLM`
    - GPT-NeoX, Pythia, OpenAssistant, Dolly V2, StableLM
187
    - :code:`EleutherAI/gpt-neox-20b`, :code:`EleutherAI/pythia-12b`, :code:`OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5`, :code:`databricks/dolly-v2-12b`, :code:`stabilityai/stablelm-tuned-alpha-7b`, etc.
188
    -
189
    - ✅︎
190
  * - :code:`GraniteForCausalLM`
191
192
    - Granite 3.0, Granite 3.1, PowerLM
    - :code:`ibm-granite/granite-3.0-2b-base`, :code:`ibm-granite/granite-3.1-8b-instruct`, :code:`ibm/PowerLM-3b`, etc.
193
    - ✅︎
194
    - ✅︎
195
  * - :code:`GraniteMoeForCausalLM`
196
197
    - Granite 3.0 MoE, PowerMoE
    - :code:`ibm-granite/granite-3.0-1b-a400m-base`, :code:`ibm-granite/granite-3.0-3b-a800m-instruct`, :code:`ibm/PowerMoE-3b`, etc.
198
    - ✅︎
199
    - ✅︎
200
201
202
203
204
  * - :code:`GritLM`
    - GritLM
    - :code:`parasail-ai/GritLM-7B-vllm`.
    - ✅︎
    - ✅︎
205
206
207
  * - :code:`InternLMForCausalLM`
    - InternLM
    - :code:`internlm/internlm-7b`, :code:`internlm/internlm-chat-7b`, etc.
208
    - ✅︎
209
    - ✅︎
Fengzhe Zhou's avatar
Fengzhe Zhou committed
210
211
212
  * - :code:`InternLM2ForCausalLM`
    - InternLM2
    - :code:`internlm/internlm2-7b`, :code:`internlm/internlm2-chat-7b`, etc.
213
    - ✅︎
214
    - ✅︎
215
216
  * - :code:`JAISLMHeadModel`
    - Jais
217
    - :code:`inceptionai/jais-13b`, :code:`inceptionai/jais-13b-chat`, :code:`inceptionai/jais-30b-v3`, :code:`inceptionai/jais-30b-chat-v3`, etc.
218
    -
219
    - ✅︎
Mor Zusman's avatar
Mor Zusman committed
220
221
  * - :code:`JambaForCausalLM`
    - Jamba
222
    - :code:`ai21labs/AI21-Jamba-1.5-Large`, :code:`ai21labs/AI21-Jamba-1.5-Mini`, :code:`ai21labs/Jamba-v0.1`, etc.
Mor Zusman's avatar
Mor Zusman committed
223
    - ✅︎
224
    - ✅︎
Woosuk Kwon's avatar
Woosuk Kwon committed
225
  * - :code:`LlamaForCausalLM`
226
227
    - Llama 3.1, Llama 3, Llama 2, LLaMA, Yi
    - :code:`meta-llama/Meta-Llama-3.1-405B-Instruct`, :code:`meta-llama/Meta-Llama-3.1-70B`, :code:`meta-llama/Meta-Llama-3-70B-Instruct`, :code:`meta-llama/Llama-2-70b-hf`, :code:`01-ai/Yi-34B`, etc.
228
    - ✅︎
229
    - ✅︎
230
231
232
  * - :code:`MambaForCausalLM`
    - Mamba
    - :code:`state-spaces/mamba-130m-hf`, :code:`state-spaces/mamba-790m-hf`, :code:`state-spaces/mamba-2.8b-hf`, etc.
233
    -
234
    - ✅︎
ywfang's avatar
ywfang committed
235
236
  * - :code:`MiniCPMForCausalLM`
    - MiniCPM
237
    - :code:`openbmb/MiniCPM-2B-sft-bf16`, :code:`openbmb/MiniCPM-2B-dpo-bf16`, :code:`openbmb/MiniCPM-S-1B-sft`, etc.
238
239
    - ✅︎
    - ✅︎
ywfang's avatar
ywfang committed
240
241
242
  * - :code:`MiniCPM3ForCausalLM`
    - MiniCPM3
    - :code:`openbmb/MiniCPM3-4B`, etc.
243
244
    - ✅︎
    - ✅︎
245
246
247
  * - :code:`MistralForCausalLM`
    - Mistral, Mistral-Instruct
    - :code:`mistralai/Mistral-7B-v0.1`, :code:`mistralai/Mistral-7B-Instruct-v0.1`, etc.
248
    - ✅︎
249
    - ✅︎
Woosuk Kwon's avatar
Woosuk Kwon committed
250
251
  * - :code:`MixtralForCausalLM`
    - Mixtral-8x7B, Mixtral-8x7B-Instruct
252
    - :code:`mistralai/Mixtral-8x7B-v0.1`, :code:`mistralai/Mixtral-8x7B-Instruct-v0.1`, :code:`mistral-community/Mixtral-8x22B-v0.1`, etc.
253
    - ✅︎
254
    - ✅︎
Woosuk Kwon's avatar
Woosuk Kwon committed
255
  * - :code:`MPTForCausalLM`
256
257
    - MPT, MPT-Instruct, MPT-Chat, MPT-StoryWriter
    - :code:`mosaicml/mpt-7b`, :code:`mosaicml/mpt-7b-storywriter`, :code:`mosaicml/mpt-30b`, etc.
258
    -
259
    - ✅︎
260
261
262
263
  * - :code:`NemotronForCausalLM`
    - Nemotron-3, Nemotron-4, Minitron
    - :code:`nvidia/Minitron-8B-Base`, :code:`mgoin/Nemotron-4-340B-Base-hf-FP8`, etc.
    - ✅︎
264
    - ✅︎
Isotr0py's avatar
Isotr0py committed
265
266
  * - :code:`OLMoForCausalLM`
    - OLMo
267
    - :code:`allenai/OLMo-1B-hf`, :code:`allenai/OLMo-7B-hf`, etc.
268
    -
269
    - ✅︎
270
271
272
273
274
  * - :code:`OLMo2ForCausalLM`
    - OLMo2
    - :code:`allenai/OLMo2-7B-1124`, etc.
    -
    - ✅︎
275
276
277
278
279
  * - :code:`OLMoEForCausalLM`
    - OLMoE
    - :code:`allenai/OLMoE-1B-7B-0924`, :code:`allenai/OLMoE-1B-7B-0924-Instruct`, etc.
    - ✅︎
    - ✅︎
Woosuk Kwon's avatar
Woosuk Kwon committed
280
281
  * - :code:`OPTForCausalLM`
    - OPT, OPT-IML
282
    - :code:`facebook/opt-66b`, :code:`facebook/opt-iml-max-30b`, etc.
283
    -
284
    - ✅︎
张大成's avatar
张大成 committed
285
286
287
  * - :code:`OrionForCausalLM`
    - Orion
    - :code:`OrionStarAI/Orion-14B-Base`, :code:`OrionStarAI/Orion-14B-Chat`, etc.
288
    -
289
    - ✅︎
290
  * - :code:`PhiForCausalLM`
291
292
    - Phi
    - :code:`microsoft/phi-1_5`, :code:`microsoft/phi-2`, etc.
293
    - ✅︎
294
    - ✅︎
295
296
  * - :code:`Phi3ForCausalLM`
    - Phi-3
297
    - :code:`microsoft/Phi-3-mini-4k-instruct`, :code:`microsoft/Phi-3-mini-128k-instruct`, :code:`microsoft/Phi-3-medium-128k-instruct`, etc.
298
299
    - ✅︎
    - ✅︎
300
301
302
  * - :code:`Phi3SmallForCausalLM`
    - Phi-3-Small
    - :code:`microsoft/Phi-3-small-8k-instruct`, :code:`microsoft/Phi-3-small-128k-instruct`, etc.
303
    -
304
    - ✅︎
305
306
307
  * - :code:`PhiMoEForCausalLM`
    - Phi-3.5-MoE
    - :code:`microsoft/Phi-3.5-MoE-instruct`, etc.
308
309
    - ✅︎
    - ✅︎
310
311
312
  * - :code:`PersimmonForCausalLM`
    - Persimmon
    - :code:`adept/persimmon-8b-base`, :code:`adept/persimmon-8b-chat`, etc.
313
    -
314
    - ✅︎
315
  * - :code:`QWenLMHeadModel`
316
317
    - Qwen
    - :code:`Qwen/Qwen-7B`, :code:`Qwen/Qwen-7B-Chat`, etc.
318
    - ✅︎
319
    - ✅︎
Junyang Lin's avatar
Junyang Lin committed
320
321
  * - :code:`Qwen2ForCausalLM`
    - Qwen2
322
    - :code:`Qwen/Qwen2-7B-Instruct`, :code:`Qwen/Qwen2-7B`, etc.
323
    - ✅︎
324
    - ✅︎
325
326
327
  * - :code:`Qwen2MoeForCausalLM`
    - Qwen2MoE
    - :code:`Qwen/Qwen1.5-MoE-A2.7B`, :code:`Qwen/Qwen1.5-MoE-A2.7B-Chat`, etc.
328
    -
329
    - ✅︎
330
  * - :code:`StableLmForCausalLM`
Hyunsung Lee's avatar
Hyunsung Lee committed
331
    - StableLM
332
    - :code:`stabilityai/stablelm-3b-4e1t`, :code:`stabilityai/stablelm-base-alpha-7b-v2`, etc.
333
    -
334
    - ✅︎
335
336
337
338
  * - :code:`Starcoder2ForCausalLM`
    - Starcoder2
    - :code:`bigcode/starcoder2-3b`, :code:`bigcode/starcoder2-7b`, :code:`bigcode/starcoder2-15b`, etc.
    -
339
    - ✅︎
340
  * - :code:`SolarForCausalLM`
341
    - Solar Pro
342
    - :code:`upstage/solar-pro-preview-instruct`, etc.
343
344
    - ✅︎
    - ✅︎
345
346
347
348
349
  * - :code:`TeleChat2ForCausalLM`
    - TeleChat2
    - :code:`TeleAI/TeleChat2-3B`, :code:`TeleAI/TeleChat2-7B`, :code:`TeleAI/TeleChat2-35B`, etc.
    - ✅︎
    - ✅︎
350
  * - :code:`XverseForCausalLM`
351
    - XVERSE
352
    - :code:`xverse/XVERSE-7B-Chat`, :code:`xverse/XVERSE-13B-Chat`, :code:`xverse/XVERSE-65B-Chat`, etc.
353
354
    - ✅︎
    - ✅︎
355
```
356

357
358
359
```{note}
Currently, the ROCm version of vLLM supports Mistral and Mixtral only for context lengths up to 4096.
```
360

361
### Pooling Models
362

363
See [this page](pooling-models) for more information on how to use pooling models.
364

365
366
367
368
```{important}
Since some model architectures support both generative and pooling tasks,
you should explicitly specify the task type to ensure that the model is used in pooling mode instead of generative mode.
```
369

370
#### Text Embedding (`--task embed`)
371

372
```{eval-rst}
373
374
375
376
377
378
.. list-table::
  :widths: 25 25 50 5 5
  :header-rows: 1

  * - Architecture
    - Models
379
    - Example HF Models
380
381
    - :ref:`LoRA <lora-adapter>`
    - :ref:`PP <distributed-serving>`
382
383
384
  * - :code:`BertModel`
    - BERT-based
    - :code:`BAAI/bge-base-en-v1.5`, etc.
385
386
    -
    -
387
388
389
  * - :code:`Gemma2Model`
    - Gemma2-based
    - :code:`BAAI/bge-multilingual-gemma2`, etc.
390
    -
391
    - ✅︎
392
393
394
395
396
  * - :code:`GritLM`
    - GritLM
    - :code:`parasail-ai/GritLM-7B-vllm`.
    - ✅︎
    - ✅︎
397
398
  * - :code:`LlamaModel`, :code:`LlamaForCausalLM`, :code:`MistralModel`, etc.
    - Llama-based
399
    - :code:`intfloat/e5-mistral-7b-instruct`, etc.
400
    - ✅︎
401
    - ✅︎
402
403
  * - :code:`Qwen2Model`, :code:`Qwen2ForCausalLM`
    - Qwen2-based
404
    - :code:`ssmits/Qwen2-7B-Instruct-embed-base` (see note), :code:`Alibaba-NLP/gte-Qwen2-7B-instruct` (see note), etc.
405
406
    - ✅︎
    - ✅︎
407
408
409
  * - :code:`RobertaModel`, :code:`RobertaForMaskedLM`
    - RoBERTa-based
    - :code:`sentence-transformers/all-roberta-large-v1`, :code:`sentence-transformers/all-roberta-large-v1`, etc.
410
411
    -
    -
412
413
414
  * - :code:`XLMRobertaModel`
    - XLM-RoBERTa-based
    - :code:`intfloat/multilingual-e5-large`, etc.
415
416
417
    -
    -
```
418

419
420
421
422
```{note}
{code}`ssmits/Qwen2-7B-Instruct-embed-base` has an improperly defined Sentence Transformers config.
You should manually set mean pooling by passing {code}`--override-pooler-config '{"pooling_type": "MEAN"}'`.
```
423

424
425
426
```{note}
Unlike base Qwen2, {code}`Alibaba-NLP/gte-Qwen2-7B-instruct` uses bi-directional attention.
You can set {code}`--hf-overrides '{"is_causal": false}'` to change the attention mask accordingly.
427

428
429
430
On the other hand, its 1.5B variant ({code}`Alibaba-NLP/gte-Qwen2-1.5B-instruct`) uses causal attention
despite being described otherwise on its model card.
```
431

432
433
434
435
If your model is not in the above list, we will try to automatically convert the model using
:func:`vllm.model_executor.models.adapters.as_embedding_model`. By default, the embeddings
of the whole prompt are extracted from the normalized hidden state corresponding to the last token.

436
#### Reward Modeling (`--task reward`)
437

438
```{eval-rst}
439
440
441
442
443
444
.. list-table::
  :widths: 25 25 50 5 5
  :header-rows: 1

  * - Architecture
    - Models
445
    - Example HF Models
446
447
    - :ref:`LoRA <lora-adapter>`
    - :ref:`PP <distributed-serving>`
448
449
450
451
452
  * - :code:`LlamaForCausalLM`
    - Llama-based
    - :code:`peiyi9979/math-shepherd-mistral-7b-prm`, etc.
    - ✅︎
    - ✅︎
453
454
455
  * - :code:`Qwen2ForRewardModel`
    - Qwen2-based
    - :code:`Qwen/Qwen2.5-Math-RM-72B`, etc.
456
    - ✅︎
457
    - ✅︎
458
```
459

460
461
462
If your model is not in the above list, we will try to automatically convert the model using
:func:`vllm.model_executor.models.adapters.as_reward_model`. By default, we return the hidden states of each token directly.

463
464
465
466
```{important}
For process-supervised reward models such as {code}`peiyi9979/math-shepherd-mistral-7b-prm`, the pooling config should be set explicitly,
e.g.: {code}`--override-pooler-config '{"pooling_type": "STEP", "step_tag_id": 123, "returned_token_ids": [456, 789]}'`.
```
467

468
#### Classification (`--task classify`)
469

470
```{eval-rst}
471
472
473
474
475
476
477
.. list-table::
  :widths: 25 25 50 5 5
  :header-rows: 1

  * - Architecture
    - Models
    - Example HF Models
478
479
    - :ref:`LoRA <lora-adapter>`
    - :ref:`PP <distributed-serving>`
480
481
482
483
484
  * - :code:`JambaForSequenceClassification`
    - Jamba
    - :code:`ai21labs/Jamba-tiny-reward-dev`, etc.
    - ✅︎
    - ✅︎
485
486
487
  * - :code:`Qwen2ForSequenceClassification`
    - Qwen2-based
    - :code:`jason9693/Qwen2.5-1.5B-apeach`, etc.
488
    - ✅︎
489
    - ✅︎
490
```
491

492
493
494
If your model is not in the above list, we will try to automatically convert the model using
:func:`vllm.model_executor.models.adapters.as_classification_model`. By default, the class probabilities are extracted from the softmaxed hidden state corresponding to the last token.

495
#### Sentence Pair Scoring (`--task score`)
496

497
```{eval-rst}
498
499
500
501
502
503
504
.. list-table::
  :widths: 25 25 50 5 5
  :header-rows: 1

  * - Architecture
    - Models
    - Example HF Models
505
506
    - :ref:`LoRA <lora-adapter>`
    - :ref:`PP <distributed-serving>`
507
508
509
  * - :code:`BertForSequenceClassification`
    - BERT-based
    - :code:`cross-encoder/ms-marco-MiniLM-L-6-v2`, etc.
510
511
    -
    -
512
513
514
  * - :code:`RobertaForSequenceClassification`
    - RoBERTa-based
    - :code:`cross-encoder/quora-roberta-base`, etc.
515
516
    -
    -
517
518
519
  * - :code:`XLMRobertaForSequenceClassification`
    - XLM-RoBERTa-based
    - :code:`BAAI/bge-reranker-v2-m3`, etc.
520
521
522
    -
    -
```
523

524
(supported-mm-models)=
525

526
## List of Multimodal Language Models
527
528
529

The following modalities are supported depending on the model:

530
531
532
533
- **T**ext
- **I**mage
- **V**ideo
- **A**udio
534

535
Any combination of modalities joined by {code}`+` are supported.
Cyrus Leung's avatar
Cyrus Leung committed
536

537
- e.g.: {code}`T + I` means that the model supports text-only, image-only, and text-with-image inputs.
Cyrus Leung's avatar
Cyrus Leung committed
538

539
On the other hand, modalities separated by {code}`/` are mutually exclusive.
Cyrus Leung's avatar
Cyrus Leung committed
540

541
- e.g.: {code}`T / I` means that the model supports text-only and image-only inputs, but not text-with-image inputs.
Cyrus Leung's avatar
Cyrus Leung committed
542

543
See [this page](#multimodal-inputs) on how to pass multi-modal inputs to the model.
544

545
### Generative Models
546

547
See [this page](#generative-models) for more information on how to use generative models.
548

549
#### Text Generation (`--task generate`)
550

551
```{eval-rst}
552
.. list-table::
553
  :widths: 25 25 15 20 5 5 5
554
555
556
557
  :header-rows: 1

  * - Architecture
    - Models
558
559
    - Inputs
    - Example HF Models
560
561
    - :ref:`LoRA <lora-adapter>`
    - :ref:`PP <distributed-serving>`
562
    - V1
563
564
565
566
  * - :code:`AriaForConditionalGeneration`
    - Aria
    - T + I
    - :code:`rhymes-ai/Aria`
567
    -
568
    - ✅︎
569
    -
570
571
  * - :code:`Blip2ForConditionalGeneration`
    - BLIP-2
572
    - T + I\ :sup:`E`
573
574
    - :code:`Salesforce/blip2-opt-2.7b`, :code:`Salesforce/blip2-opt-6.7b`, etc.
    -
575
    - ✅︎
576
    -
577
578
  * - :code:`ChameleonForConditionalGeneration`
    - Chameleon
579
    - T + I
580
    - :code:`facebook/chameleon-7b` etc.
581
    -
582
    - ✅︎
583
    -
584
585
  * - :code:`FuyuForCausalLM`
    - Fuyu
586
    - T + I
587
    - :code:`adept/fuyu-8b` etc.
588
    -
589
    - ✅︎
590
    -
591
592
  * - :code:`ChatGLMModel`
    - GLM-4V
593
    - T + I
594
    - :code:`THUDM/glm-4v-9b` etc.
595
    - ✅︎
596
    - ✅︎
597
    -
598
599
600
601
  * - :code:`H2OVLChatModel`
    - H2OVL
    - T + I\ :sup:`E+`
    - :code:`h2oai/h2ovl-mississippi-800m`, :code:`h2oai/h2ovl-mississippi-2b`, etc.
602
    -
603
    - ✅︎
604
    -
605
606
607
608
  * - :code:`Idefics3ForConditionalGeneration`
    - Idefics3
    - T + I
    - :code:`HuggingFaceM4/Idefics3-8B-Llama3` etc.
609
    - ✅︎
610
    -
611
    -
612
  * - :code:`InternVLChatModel`
613
    - InternVL 2.5, Mono-InternVL, InternVL 2.0
614
    - T + I\ :sup:`E+`
615
    - :code:`OpenGVLab/InternVL2_5-4B`, :code:`OpenGVLab/Mono-InternVL-2B`, :code:`OpenGVLab/InternVL2-4B`, etc.
616
    -
617
    - ✅︎
618
    - ✅︎
619
620
  * - :code:`LlavaForConditionalGeneration`
    - LLaVA-1.5
621
    - T + I\ :sup:`E+`
622
    - :code:`llava-hf/llava-1.5-7b-hf`, :code:`TIGER-Lab/Mantis-8B-siglip-llama3` (see note), etc.
623
    -
624
    - ✅︎
625
    - ✅︎
626
627
  * - :code:`LlavaNextForConditionalGeneration`
    - LLaVA-NeXT
628
    - T + I\ :sup:`E+`
629
630
    - :code:`llava-hf/llava-v1.6-mistral-7b-hf`, :code:`llava-hf/llava-v1.6-vicuna-7b-hf`, etc.
    -
631
    - ✅︎
632
    -
633
634
  * - :code:`LlavaNextVideoForConditionalGeneration`
    - LLaVA-NeXT-Video
635
    - T + V
636
    - :code:`llava-hf/LLaVA-NeXT-Video-7B-hf`, etc.
637
    -
638
    - ✅︎
639
    -
640
641
  * - :code:`LlavaOnevisionForConditionalGeneration`
    - LLaVA-Onevision
642
    - T + I\ :sup:`+` + V\ :sup:`+`
643
    - :code:`llava-hf/llava-onevision-qwen2-7b-ov-hf`, :code:`llava-hf/llava-onevision-qwen2-0.5b-ov-hf`, etc.
644
    -
645
    - ✅︎
646
    -
647
648
  * - :code:`MiniCPMV`
    - MiniCPM-V
649
    - T + I\ :sup:`E+`
650
    - :code:`openbmb/MiniCPM-V-2` (see note), :code:`openbmb/MiniCPM-Llama3-V-2_5`, :code:`openbmb/MiniCPM-V-2_6`, etc.
651
652
    - ✅︎
    - ✅︎
653
    -
654
655
  * - :code:`MllamaForConditionalGeneration`
    - Llama 3.2
656
    - T + I\ :sup:`+`
657
658
    - :code:`meta-llama/Llama-3.2-90B-Vision-Instruct`, :code:`meta-llama/Llama-3.2-11B-Vision`, etc.
    -
659
    -
660
    -
661
662
  * - :code:`MolmoForCausalLM`
    - Molmo
663
    - T + I
664
665
666
    - :code:`allenai/Molmo-7B-D-0924`, :code:`allenai/Molmo-72B-0924`, etc.
    -
    - ✅︎
667
    - ✅︎
668
669
  * - :code:`NVLM_D_Model`
    - NVLM-D 1.0
670
    - T + I\ :sup:`E+`
671
    - :code:`nvidia/NVLM-D-72B`, etc.
672
    -
673
    - ✅︎
674
    - ✅︎
Roger Wang's avatar
Roger Wang committed
675
  * - :code:`PaliGemmaForConditionalGeneration`
Jani Monoses's avatar
Jani Monoses committed
676
    - PaliGemma, PaliGemma 2
677
    - T + I\ :sup:`E`
Jani Monoses's avatar
Jani Monoses committed
678
    - :code:`google/paligemma-3b-pt-224`, :code:`google/paligemma-3b-mix-224`, :code:`google/paligemma2-3b-ft-docci-448`, etc.
Roger Wang's avatar
Roger Wang committed
679
    - 
680
    - ✅︎
681
    -
682
  * - :code:`Phi3VForCausalLM`
683
    - Phi-3-Vision, Phi-3.5-Vision
684
    - T + I\ :sup:`E+`
685
    - :code:`microsoft/Phi-3-vision-128k-instruct`, :code:`microsoft/Phi-3.5-vision-instruct` etc.
686
    -
687
    - ✅︎
688
    - ✅︎
Patrick von Platen's avatar
Patrick von Platen committed
689
690
  * - :code:`PixtralForConditionalGeneration`
    - Pixtral
691
    - T + I\ :sup:`+`
692
    - :code:`mistralai/Pixtral-12B-2409`, :code:`mistral-community/pixtral-12b` etc.
Patrick von Platen's avatar
Patrick von Platen committed
693
    -
694
    - ✅︎
695
    - ✅︎
696
  * - :code:`QWenLMHeadModel`
697
    - Qwen-VL
698
    - T + I\ :sup:`E+`
699
    - :code:`Qwen/Qwen-VL`, :code:`Qwen/Qwen-VL-Chat`, etc.
700
    - ✅︎
701
    - ✅︎
702
    -
703
704
705
706
707
708
  * - :code:`Qwen2AudioForConditionalGeneration`
    - Qwen2-Audio
    - T + A\ :sup:`+`
    - :code:`Qwen/Qwen2-Audio-7B-Instruct`
    -
    - ✅︎
709
    -
710
  * - :code:`Qwen2VLForConditionalGeneration`
711
    - Qwen2-VL
712
    - T + I\ :sup:`E+` + V\ :sup:`E+`
713
    - :code:`Qwen/Qwen2-VL-2B-Instruct`, :code:`Qwen/Qwen2-VL-7B-Instruct`, :code:`Qwen/Qwen2-VL-72B-Instruct`, etc.
714
    - ✅︎
715
    - ✅︎
716
    -
717
  * - :code:`UltravoxModel`
718
    - Ultravox
719
    - T + A\ :sup:`E+`
720
    - :code:`fixie-ai/ultravox-v0_3`
721
    -
722
    - ✅︎
723
724
    -
```
725

726
727
```{eval-rst}
:sup:`E` Pre-computed embeddings can be inputted for this modality.
728

729
730
:sup:`+` Multiple items can be inputted per text prompt for this modality.
```
731

732
733
734
````{important}
To enable multiple multi-modal items per text prompt, you have to set {code}`limit_mm_per_prompt` (offline inference)
or {code}`--limit-mm-per-prompt` (online inference). For example, to enable passing up to 4 images per text prompt:
735

736
737
738
739
740
741
```python
llm = LLM(
    model="Qwen/Qwen2-VL-7B-Instruct",
    limit_mm_per_prompt={"image": 4},
)
```
742

743
744
745
746
```bash
vllm serve Qwen/Qwen2-VL-7B-Instruct --limit-mm-per-prompt image=4
```
````
747

748
749
750
```{note}
vLLM currently only supports adding LoRA to the language backbone of multimodal models.
```
751

752
753
754
755
```{note}
To use {code}`TIGER-Lab/Mantis-8B-siglip-llama3`, you have to install their GitHub repo ({code}`pip install git+https://github.com/TIGER-AI-Lab/Mantis.git`)
and pass {code}`--hf_overrides '{"architectures": ["MantisForConditionalGeneration"]}'` when running vLLM.
```
756

757
758
759
760
```{note}
The official {code}`openbmb/MiniCPM-V-2` doesn't work yet, so we need to use a fork ({code}`HwwwH/MiniCPM-V-2`) for now.
For more details, please see: <https://github.com/vllm-project/vllm/pull/4087#issuecomment-2250397630>
```
Alphi's avatar
Alphi committed
761

762
### Pooling Models
763

764
See [this page](pooling-models) for more information on how to use pooling models.
765

766
767
768
769
```{important}
Since some model architectures support both generative and pooling tasks,
you should explicitly specify the task type to ensure that the model is used in pooling mode instead of generative mode.
```
770

771
#### Text Embedding (`--task embed`)
772

773
Any text generation model can be converted into an embedding model by passing {code}`--task embed`.
774

775
776
777
```{note}
To get the best results, you should use pooling models that are specifically trained as such.
```
778
779

The following table lists those that are tested in vLLM.
780

781
```{eval-rst}
782
783
784
785
786
787
788
789
.. list-table::
  :widths: 25 25 15 25 5 5
  :header-rows: 1

  * - Architecture
    - Models
    - Inputs
    - Example HF Models
790
791
    - :ref:`LoRA <lora-adapter>`
    - :ref:`PP <distributed-serving>`
Cyrus Leung's avatar
Cyrus Leung committed
792
793
794
795
  * - :code:`LlavaNextForConditionalGeneration`
    - LLaVA-NeXT-based
    - T / I
    - :code:`royokong/e5-v`
796
    -
Cyrus Leung's avatar
Cyrus Leung committed
797
    - ✅︎
798
799
800
801
802
803
  * - :code:`Phi3VForCausalLM`
    - Phi-3-Vision-based
    - T + I
    - :code:`TIGER-Lab/VLM2Vec-Full`
    - 🚧
    - ✅︎
804
805
806
807
  * - :code:`Qwen2VLForConditionalGeneration`
    - Qwen2-VL-based
    - T + I
    - :code:`MrLight/dse-qwen2-2b-mrl-v1`
808
    -
809
    - ✅︎
810
```
811

812
______________________________________________________________________
813

814
# Model Support Policy
815
816
817
818
819
820

At vLLM, we are committed to facilitating the integration and support of third-party models within our ecosystem. Our approach is designed to balance the need for robustness and the practical limitations of supporting a wide range of models. Here’s how we manage third-party model support:

1. **Community-Driven Support**: We encourage community contributions for adding new models. When a user requests support for a new model, we welcome pull requests (PRs) from the community. These contributions are evaluated primarily on the sensibility of the output they generate, rather than strict consistency with existing implementations such as those in transformers. **Call for contribution:** PRs coming directly from model vendors are greatly appreciated!
2. **Best-Effort Consistency**: While we aim to maintain a level of consistency between the models implemented in vLLM and other frameworks like transformers, complete alignment is not always feasible. Factors like acceleration techniques and the use of low-precision computations can introduce discrepancies. Our commitment is to ensure that the implemented models are functional and produce sensible results.

821
822
823
```{tip}
When comparing the output of {code}`model.generate` from HuggingFace Transformers with the output of {code}`llm.generate` from vLLM, note that the former reads the model's generation config file (i.e., [generation_config.json](https://github.com/huggingface/transformers/blob/19dabe96362803fb0a9ae7073d03533966598b17/src/transformers/generation/utils.py#L1945)) and applies the default parameters for generation, while the latter only uses the parameters passed to the function. Ensure all sampling parameters are identical when comparing outputs.
```
824

825
826
827
828
829
830
831
832
833
834
3. **Issue Resolution and Model Updates**: Users are encouraged to report any bugs or issues they encounter with third-party models. Proposed fixes should be submitted via PRs, with a clear explanation of the problem and the rationale behind the proposed solution. If a fix for one model impacts another, we rely on the community to highlight and address these cross-model dependencies. Note: for bugfix PRs, it is good etiquette to inform the original author to seek their feedback.
4. **Monitoring and Updates**: Users interested in specific models should monitor the commit history for those models (e.g., by tracking changes in the main/vllm/model_executor/models directory). This proactive approach helps users stay informed about updates and changes that may affect the models they use.
5. **Selective Focus**: Our resources are primarily directed towards models with significant user interest and impact. Models that are less frequently used may receive less attention, and we rely on the community to play a more active role in their upkeep and improvement.

Through this approach, vLLM fosters a collaborative environment where both the core development team and the broader community contribute to the robustness and diversity of the third-party models supported in our ecosystem.

Note that, as an inference engine, vLLM does not introduce new models. Therefore, all models supported by vLLM are third-party models in this regard.

We have the following levels of testing for models:

835
1. **Strict Consistency**: We compare the output of the model with the output of the model in the HuggingFace Transformers library under greedy decoding. This is the most stringent test. Please refer to [models tests](https://github.com/vllm-project/vllm/blob/main/tests/models) for the models that have passed this test.
836
2. **Output Sensibility**: We check if the output of the model is sensible and coherent, by measuring the perplexity of the output and checking for any obvious errors. This is a less stringent test.
837
3. **Runtime Functionality**: We check if the model can be loaded and run without errors. This is the least stringent test. Please refer to [functionality tests](https://github.com/vllm-project/vllm/tree/main/tests) and [examples](https://github.com/vllm-project/vllm/tree/main/examples) for the models that have passed this test.
838
4. **Community Feedback**: We rely on the community to provide feedback on the models. If a model is broken or not working as expected, we encourage users to raise issues to report it or open pull requests to fix it. The rest of the models fall under this category.