supported_models.rst 19.7 KB
Newer Older
Woosuk Kwon's avatar
Woosuk Kwon committed
1
2
3
4
5
.. _supported_models:

Supported Models
================

6
vLLM supports a variety of generative Transformer models in `HuggingFace (HF) Transformers <https://huggingface.co/models>`_.
Woosuk Kwon's avatar
Woosuk Kwon committed
7
The following is the list of model architectures that are currently supported by vLLM.
Woosuk Kwon's avatar
Woosuk Kwon committed
8
9
Alongside each architecture, we include some popular models that use it.

10
11
12
13
14
Text-only Language Models
^^^^^^^^^^^^^^^^^^^^^^^^^

Text Generation
---------------
15

Woosuk Kwon's avatar
Woosuk Kwon committed
16
.. list-table::
17
  :widths: 25 25 50 5 5
Woosuk Kwon's avatar
Woosuk Kwon committed
18
19
20
21
  :header-rows: 1

  * - Architecture
    - Models
22
    - Example HF Models
23
    - :ref:`LoRA <lora>`
24
    - :ref:`PP <distributed_serving>`
25
  * - :code:`AquilaForCausalLM`
26
    - Aquila, Aquila2
27
    - :code:`BAAI/Aquila-7B`, :code:`BAAI/AquilaChat-7B`, etc.
28
    - ✅︎
29
    - ✅︎
30
31
32
33
  * - :code:`ArcticForCausalLM`
    - Arctic
    - :code:`Snowflake/snowflake-arctic-base`, :code:`Snowflake/snowflake-arctic-instruct`, etc.
    -
34
    - ✅︎
Zhuohan Li's avatar
Zhuohan Li committed
35
  * - :code:`BaiChuanForCausalLM`
36
    - Baichuan2, Baichuan
37
    - :code:`baichuan-inc/Baichuan2-13B-Chat`, :code:`baichuan-inc/Baichuan-7B`, etc.
Jee Li's avatar
Jee Li committed
38
    - ✅︎
39
    - ✅︎
40
41
42
43
  * - :code:`BloomForCausalLM`
    - BLOOM, BLOOMZ, BLOOMChat
    - :code:`bigscience/bloom`, :code:`bigscience/bloomz`, etc.
    -
44
    - ✅︎
45
46
47
48
49
  * - :code:`BartForConditionalGeneration`
    - BART
    - :code:`facebook/bart-base`, :code:`facebook/bart-large-cnn`, etc.
    - 
    - 
50
51
52
  * - :code:`ChatGLMModel`
    - ChatGLM
    - :code:`THUDM/chatglm2-6b`, :code:`THUDM/chatglm3-6b`, etc.
Jee Li's avatar
Jee Li committed
53
    - ✅︎
54
    - ✅︎
55
56
57
  * - :code:`CohereForCausalLM`
    - Command-R
    - :code:`CohereForAI/c4ai-command-r-v01`, etc.
58
59
    - ✅︎
    - ✅︎
60
61
62
  * - :code:`DbrxForCausalLM`
    - DBRX
    - :code:`databricks/dbrx-base`, :code:`databricks/dbrx-instruct`, etc.
63
    -
64
    - ✅︎
65
66
67
  * - :code:`DeciLMForCausalLM`
    - DeciLM
    - :code:`Deci/DeciLM-7B`, :code:`Deci/DeciLM-7B-instruct`, etc.
68
    -
69
    - ✅︎
70
71
72
73
  * - :code:`DeepseekForCausalLM`
    - DeepSeek
    - :code:`deepseek-ai/deepseek-llm-67b-base`, :code:`deepseek-ai/deepseek-llm-7b-chat` etc.
    - 
74
    - ✅︎
75
76
77
78
  * - :code:`DeepseekV2ForCausalLM`
    - DeepSeek-V2
    - :code:`deepseek-ai/DeepSeek-V2`, :code:`deepseek-ai/DeepSeek-V2-Chat` etc.
    - 
79
    - ✅︎
80
81
82
83
  * - :code:`ExaoneForCausalLM`
    - EXAONE-3
    - :code:`LGAI-EXAONE/EXAONE-3.0-7.8B-Instruct`, etc.
    - ✅︎
84
    - ✅︎
Zhuohan Li's avatar
Zhuohan Li committed
85
86
  * - :code:`FalconForCausalLM`
    - Falcon
87
    - :code:`tiiuae/falcon-7b`, :code:`tiiuae/falcon-40b`, :code:`tiiuae/falcon-rw-7b`, etc.
88
    -
89
    - ✅︎
90
91
92
93
94
  * - :code:`FalconMambaForCausalLM`
    - FalconMamba
    - :code:`tiiuae/falcon-mamba-7b`, :code:`tiiuae/falcon-mamba-7b-instruct`, etc.
    - ✅︎
    -  
95
96
97
  * - :code:`GemmaForCausalLM`
    - Gemma
    - :code:`google/gemma-2b`, :code:`google/gemma-7b`, etc.
98
    - ✅︎
99
    - ✅︎
Woosuk Kwon's avatar
Woosuk Kwon committed
100
101
102
103
  * - :code:`Gemma2ForCausalLM`
    - Gemma2
    - :code:`google/gemma-2-9b`, :code:`google/gemma-2-27b`, etc.
    - ✅︎
104
    - ✅︎
Woosuk Kwon's avatar
Woosuk Kwon committed
105
106
  * - :code:`GPT2LMHeadModel`
    - GPT-2
107
    - :code:`gpt2`, :code:`gpt2-xl`, etc.
108
    -
109
    - ✅︎
110
111
112
  * - :code:`GPTBigCodeForCausalLM`
    - StarCoder, SantaCoder, WizardCoder
    - :code:`bigcode/starcoder`, :code:`bigcode/gpt_bigcode-santacoder`, :code:`WizardLM/WizardCoder-15B-V1.0`, etc.
113
    - ✅︎
114
    - ✅︎
115
116
117
  * - :code:`GPTJForCausalLM`
    - GPT-J
    - :code:`EleutherAI/gpt-j-6b`, :code:`nomic-ai/gpt4all-j`, etc.
118
    -
119
    - ✅︎
Woosuk Kwon's avatar
Woosuk Kwon committed
120
121
  * - :code:`GPTNeoXForCausalLM`
    - GPT-NeoX, Pythia, OpenAssistant, Dolly V2, StableLM
122
    - :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.
123
    -
124
    - ✅︎
125
  * - :code:`GraniteForCausalLM`
126
127
128
    - PowerLM
    - :code:`ibm/PowerLM-3b` etc.
    - ✅︎
129
    - ✅︎
130
131
132
  * - :code:`GraniteMoeForCausalLM`
    - PowerMoE
    - :code:`ibm/PowerMoE-3b` etc.
133
    - ✅︎
134
    - ✅︎
135
136
137
  * - :code:`InternLMForCausalLM`
    - InternLM
    - :code:`internlm/internlm-7b`, :code:`internlm/internlm-chat-7b`, etc.
138
    - ✅︎
139
    - ✅︎
Fengzhe Zhou's avatar
Fengzhe Zhou committed
140
141
142
  * - :code:`InternLM2ForCausalLM`
    - InternLM2
    - :code:`internlm/internlm2-7b`, :code:`internlm/internlm2-chat-7b`, etc.
143
    -
144
    - ✅︎
145
146
147
148
  * - :code:`JAISLMHeadModel`
    - Jais
    - :code:`core42/jais-13b`, :code:`core42/jais-13b-chat`, :code:`core42/jais-30b-v3`, :code:`core42/jais-30b-chat-v3`, etc.
    -
149
    - ✅︎
Mor Zusman's avatar
Mor Zusman committed
150
151
  * - :code:`JambaForCausalLM`
    - Jamba
152
    - :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
153
    - ✅︎
154
    - 
Woosuk Kwon's avatar
Woosuk Kwon committed
155
  * - :code:`LlamaForCausalLM`
156
157
    - 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.
158
    - ✅︎
159
    - ✅︎
160
161
162
  * - :code:`MambaForCausalLM`
    - Mamba
    - :code:`state-spaces/mamba-130m-hf`, :code:`state-spaces/mamba-790m-hf`, :code:`state-spaces/mamba-2.8b-hf`, etc.
163
    -
164
    -
ywfang's avatar
ywfang committed
165
166
  * - :code:`MiniCPMForCausalLM`
    - MiniCPM
167
    - :code:`openbmb/MiniCPM-2B-sft-bf16`, :code:`openbmb/MiniCPM-2B-dpo-bf16`, :code:`openbmb/MiniCPM-S-1B-sft`, etc.
168
169
    - ✅︎
    - ✅︎
ywfang's avatar
ywfang committed
170
171
172
  * - :code:`MiniCPM3ForCausalLM`
    - MiniCPM3
    - :code:`openbmb/MiniCPM3-4B`, etc.
173
174
    - ✅︎
    - ✅︎
175
176
177
  * - :code:`MistralForCausalLM`
    - Mistral, Mistral-Instruct
    - :code:`mistralai/Mistral-7B-v0.1`, :code:`mistralai/Mistral-7B-Instruct-v0.1`, etc.
178
    - ✅︎
179
    - ✅︎
Woosuk Kwon's avatar
Woosuk Kwon committed
180
181
  * - :code:`MixtralForCausalLM`
    - Mixtral-8x7B, Mixtral-8x7B-Instruct
182
    - :code:`mistralai/Mixtral-8x7B-v0.1`, :code:`mistralai/Mixtral-8x7B-Instruct-v0.1`, :code:`mistral-community/Mixtral-8x22B-v0.1`, etc.
183
    - ✅︎
184
    - ✅︎
Woosuk Kwon's avatar
Woosuk Kwon committed
185
  * - :code:`MPTForCausalLM`
186
187
    - MPT, MPT-Instruct, MPT-Chat, MPT-StoryWriter
    - :code:`mosaicml/mpt-7b`, :code:`mosaicml/mpt-7b-storywriter`, :code:`mosaicml/mpt-30b`, etc.
188
    -
189
    - ✅︎
190
191
192
193
  * - :code:`NemotronForCausalLM`
    - Nemotron-3, Nemotron-4, Minitron
    - :code:`nvidia/Minitron-8B-Base`, :code:`mgoin/Nemotron-4-340B-Base-hf-FP8`, etc.
    - ✅︎
194
    - ✅︎
Isotr0py's avatar
Isotr0py committed
195
196
  * - :code:`OLMoForCausalLM`
    - OLMo
197
    - :code:`allenai/OLMo-1B-hf`, :code:`allenai/OLMo-7B-hf`, etc.
198
    -
199
200
201
202
203
204
    - ✅︎
  * - :code:`OLMoEForCausalLM`
    - OLMoE
    - :code:`allenai/OLMoE-1B-7B-0924`, :code:`allenai/OLMoE-1B-7B-0924-Instruct`, etc.
    - ✅︎
    - ✅︎
Woosuk Kwon's avatar
Woosuk Kwon committed
205
206
  * - :code:`OPTForCausalLM`
    - OPT, OPT-IML
207
    - :code:`facebook/opt-66b`, :code:`facebook/opt-iml-max-30b`, etc.
208
    -
209
    - ✅︎
张大成's avatar
张大成 committed
210
211
212
  * - :code:`OrionForCausalLM`
    - Orion
    - :code:`OrionStarAI/Orion-14B-Base`, :code:`OrionStarAI/Orion-14B-Chat`, etc.
213
    -
214
    - ✅︎
215
  * - :code:`PhiForCausalLM`
216
217
    - Phi
    - :code:`microsoft/phi-1_5`, :code:`microsoft/phi-2`, etc.
218
    - ✅︎
219
    - ✅︎
220
221
  * - :code:`Phi3ForCausalLM`
    - Phi-3
222
    - :code:`microsoft/Phi-3-mini-4k-instruct`, :code:`microsoft/Phi-3-mini-128k-instruct`, :code:`microsoft/Phi-3-medium-128k-instruct`, etc.
223
224
    - ✅︎
    - ✅︎
225
226
227
  * - :code:`Phi3SmallForCausalLM`
    - Phi-3-Small
    - :code:`microsoft/Phi-3-small-8k-instruct`, :code:`microsoft/Phi-3-small-128k-instruct`, etc.
228
    -
229
    - ✅︎
230
231
232
  * - :code:`PhiMoEForCausalLM`
    - Phi-3.5-MoE
    - :code:`microsoft/Phi-3.5-MoE-instruct`, etc.
233
234
    - ✅︎
    - ✅︎
235
236
237
238
  * - :code:`PersimmonForCausalLM`
    - Persimmon
    - :code:`adept/persimmon-8b-base`, :code:`adept/persimmon-8b-chat`, etc.
    - 
239
    - ✅︎
240
  * - :code:`QWenLMHeadModel`
241
242
    - Qwen
    - :code:`Qwen/Qwen-7B`, :code:`Qwen/Qwen-7B-Chat`, etc.
243
    -
244
    - ✅︎
Junyang Lin's avatar
Junyang Lin committed
245
246
  * - :code:`Qwen2ForCausalLM`
    - Qwen2
247
    - :code:`Qwen/Qwen2-beta-7B`, :code:`Qwen/Qwen2-beta-7B-Chat`, etc.
248
    - ✅︎
249
    - ✅︎
250
251
252
  * - :code:`Qwen2MoeForCausalLM`
    - Qwen2MoE
    - :code:`Qwen/Qwen1.5-MoE-A2.7B`, :code:`Qwen/Qwen1.5-MoE-A2.7B-Chat`, etc.
253
    -
254
    - ✅︎
255
  * - :code:`StableLmForCausalLM`
Hyunsung Lee's avatar
Hyunsung Lee committed
256
    - StableLM
257
    - :code:`stabilityai/stablelm-3b-4e1t`, :code:`stabilityai/stablelm-base-alpha-7b-v2`, etc.
258
    -
259
    - ✅︎
260
261
262
263
  * - :code:`Starcoder2ForCausalLM`
    - Starcoder2
    - :code:`bigcode/starcoder2-3b`, :code:`bigcode/starcoder2-7b`, :code:`bigcode/starcoder2-15b`, etc.
    -
264
    - ✅︎
265
  * - :code:`SolarForCausalLM`
266
    - Solar Pro
267
    - :code:`upstage/solar-pro-preview-instruct`, etc.
268
269
    - ✅︎
    - ✅︎
270
  * - :code:`XverseForCausalLM`
271
    - XVERSE
272
    - :code:`xverse/XVERSE-7B-Chat`, :code:`xverse/XVERSE-13B-Chat`, :code:`xverse/XVERSE-65B-Chat`, etc.
273
274
    - ✅︎
    - ✅︎
275

276
277
278
.. note::
    Currently, the ROCm version of vLLM supports Mistral and Mixtral only for context lengths up to 4096.

279
280
281
282
283
284
285
286
287
Text Embedding
--------------

.. list-table::
  :widths: 25 25 50 5 5
  :header-rows: 1

  * - Architecture
    - Models
288
    - Example HF Models
289
290
291
292
293
294
295
296
297
298
299
300
301
    - :ref:`LoRA <lora>`
    - :ref:`PP <distributed_serving>`
  * - :code:`Gemma2Model`
    - Gemma2-based
    - :code:`BAAI/bge-multilingual-gemma2`, etc.
    - 
    - ✅︎
  * - :code:`MistralModel`
    - Mistral-based
    - :code:`intfloat/e5-mistral-7b-instruct`, etc.
    - 
    - ✅︎

302
303
304
305
.. important::
  Some model architectures support both generation and embedding tasks.
  In this case, you have to pass :code:`--task embedding` to run the model in embedding mode.

306
307
308
309
310
311
312
313
314
Reward Modeling
---------------

.. list-table::
  :widths: 25 25 50 5 5
  :header-rows: 1

  * - Architecture
    - Models
315
    - Example HF Models
316
317
318
319
320
321
322
323
324
325
    - :ref:`LoRA <lora>`
    - :ref:`PP <distributed_serving>`
  * - :code:`Qwen2ForRewardModel`
    - Qwen2-based
    - :code:`Qwen/Qwen2.5-Math-RM-72B`, etc.
    - 
    - ✅︎

.. note::
    As an interim measure, these models are supported via Embeddings API. See `this RFC <https://github.com/vllm-project/vllm/issues/8967>`_ for upcoming changes.
326

327
Multimodal Language Models
328
329
330
331
332
333
334
335
^^^^^^^^^^^^^^^^^^^^^^^^^^

The following modalities are supported depending on the model:

- **T**\ ext
- **I**\ mage
- **V**\ ideo
- **A**\ udio
336

Cyrus Leung's avatar
Cyrus Leung committed
337
338
339
340
341
342
343
344
Any combination of modalities joined by :code:`+` are supported.

- e.g.: :code:`T + I` means that the model supports text-only, image-only, and text-with-image inputs.

On the other hand, modalities separated by :code:`/` are mutually exclusive.

- e.g.: :code:`T / I` means that the model supports text-only and image-only inputs, but not text-with-image inputs.

345
346
.. _supported_vlms:

347
348
349
Text Generation
---------------

350
.. list-table::
351
  :widths: 25 25 15 25 5 5
352
353
354
355
  :header-rows: 1

  * - Architecture
    - Models
356
357
    - Inputs
    - Example HF Models
358
    - :ref:`LoRA <lora>`
359
    - :ref:`PP <distributed_serving>`
360
361
  * - :code:`Blip2ForConditionalGeneration`
    - BLIP-2
362
    - T + I\ :sup:`E`
363
364
    - :code:`Salesforce/blip2-opt-2.7b`, :code:`Salesforce/blip2-opt-6.7b`, etc.
    -
365
    - ✅︎
366
367
  * - :code:`ChameleonForConditionalGeneration`
    - Chameleon
368
    - T + I
369
370
    - :code:`facebook/chameleon-7b` etc.
    - 
371
    - ✅︎
372
373
  * - :code:`FuyuForCausalLM`
    - Fuyu
374
    - T + I
375
376
    - :code:`adept/fuyu-8b` etc.
    - 
377
    - ✅︎
378
379
  * - :code:`ChatGLMModel`
    - GLM-4V
380
    - T + I
381
382
383
    - :code:`THUDM/glm-4v-9b` etc.
    - 
    - ✅︎
384
385
  * - :code:`InternVLChatModel`
    - InternVL2
386
    - T + I\ :sup:`E+`
387
    - :code:`OpenGVLab/Mono-InternVL-2B`, :code:`OpenGVLab/InternVL2-4B`, :code:`OpenGVLab/InternVL2-8B`, etc.
388
    - 
389
    - ✅︎
390
391
  * - :code:`LlavaForConditionalGeneration`
    - LLaVA-1.5
392
    - T + I\ :sup:`E+`
393
394
    - :code:`llava-hf/llava-1.5-7b-hf`, :code:`llava-hf/llava-1.5-13b-hf`, etc.
    -
395
    - ✅︎
396
397
  * - :code:`LlavaNextForConditionalGeneration`
    - LLaVA-NeXT
398
    - T + I\ :sup:`E+`
399
400
    - :code:`llava-hf/llava-v1.6-mistral-7b-hf`, :code:`llava-hf/llava-v1.6-vicuna-7b-hf`, etc.
    -
401
    - ✅︎
402
403
  * - :code:`LlavaNextVideoForConditionalGeneration`
    - LLaVA-NeXT-Video
404
    - T + V
405
    - :code:`llava-hf/LLaVA-NeXT-Video-7B-hf`, etc.
406
    -
407
    - ✅︎
408
409
  * - :code:`LlavaOnevisionForConditionalGeneration`
    - LLaVA-Onevision
410
    - T + I\ :sup:`+` + V
411
    - :code:`llava-hf/llava-onevision-qwen2-7b-ov-hf`, :code:`llava-hf/llava-onevision-qwen2-0.5b-ov-hf`, etc.
412
    -
413
    - ✅︎
414
415
  * - :code:`MiniCPMV`
    - MiniCPM-V
416
    - T + I\ :sup:`E+`
417
    - :code:`openbmb/MiniCPM-V-2` (see note), :code:`openbmb/MiniCPM-Llama3-V-2_5`, :code:`openbmb/MiniCPM-V-2_6`, etc.
418
419
    - ✅︎
    - ✅︎
420
421
  * - :code:`MllamaForConditionalGeneration`
    - Llama 3.2
422
    - T + I
423
424
    - :code:`meta-llama/Llama-3.2-90B-Vision-Instruct`, :code:`meta-llama/Llama-3.2-11B-Vision`, etc.
    -
425
    -
426
427
  * - :code:`MolmoForCausalLM`
    - Molmo
428
    - T + I
429
430
431
    - :code:`allenai/Molmo-7B-D-0924`, :code:`allenai/Molmo-72B-0924`, etc.
    -
    - ✅︎
432
433
  * - :code:`NVLM_D_Model`
    - NVLM-D 1.0
434
    - T + I\ :sup:`E+`
435
    - :code:`nvidia/NVLM-D-72B`, etc.
436
    - 
437
    - ✅︎
Roger Wang's avatar
Roger Wang committed
438
439
  * - :code:`PaliGemmaForConditionalGeneration`
    - PaliGemma
440
    - T + I\ :sup:`E`
Roger Wang's avatar
Roger Wang committed
441
442
    - :code:`google/paligemma-3b-pt-224`, :code:`google/paligemma-3b-mix-224`, etc.
    - 
443
    - ✅︎
444
  * - :code:`Phi3VForCausalLM`
445
    - Phi-3-Vision, Phi-3.5-Vision
446
    - T + I\ :sup:`E+`
447
    - :code:`microsoft/Phi-3-vision-128k-instruct`, :code:`microsoft/Phi-3.5-vision-instruct` etc.
448
    -
449
    - ✅︎
Patrick von Platen's avatar
Patrick von Platen committed
450
451
  * - :code:`PixtralForConditionalGeneration`
    - Pixtral
452
    - T + I\ :sup:`+`
453
    - :code:`mistralai/Pixtral-12B-2409`, :code:`mistral-community/pixtral-12b` etc.
Patrick von Platen's avatar
Patrick von Platen committed
454
    -
455
    - ✅︎
456
  * - :code:`QWenLMHeadModel`
457
    - Qwen-VL
458
    - T + I\ :sup:`E+`
459
460
    - :code:`Qwen/Qwen-VL`, :code:`Qwen/Qwen-VL-Chat`, etc.
    -
461
    - ✅︎
462
463
464
465
466
467
  * - :code:`Qwen2AudioForConditionalGeneration`
    - Qwen2-Audio
    - T + A\ :sup:`+`
    - :code:`Qwen/Qwen2-Audio-7B-Instruct`
    -
    - ✅︎
468
  * - :code:`Qwen2VLForConditionalGeneration`
469
    - Qwen2-VL
470
    - T + I\ :sup:`E+` + V\ :sup:`+`
471
472
    - :code:`Qwen/Qwen2-VL-2B-Instruct`, :code:`Qwen/Qwen2-VL-7B-Instruct`, :code:`Qwen/Qwen2-VL-72B-Instruct`, etc.
    -
473
    - ✅︎
474
  * - :code:`UltravoxModel`
475
    - Ultravox
476
    - T + A\ :sup:`E+`
477
    - :code:`fixie-ai/ultravox-v0_3`
478
    -
479
    - ✅︎
Woosuk Kwon's avatar
Woosuk Kwon committed
480

481
482
483
| :sup:`E` Pre-computed embeddings can be inputted for this modality.
| :sup:`+` Multiple items can be inputted per text prompt for this modality.

Alphi's avatar
Alphi committed
484
485
486
487
.. note::
  For :code:`openbmb/MiniCPM-V-2`, the official repo 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

488
489
490
491
492
493
494
495
496
497
498
499
500
Multimodal Embedding
--------------------

.. list-table::
  :widths: 25 25 15 25 5 5
  :header-rows: 1

  * - Architecture
    - Models
    - Inputs
    - Example HF Models
    - :ref:`LoRA <lora>`
    - :ref:`PP <distributed_serving>`
Cyrus Leung's avatar
Cyrus Leung committed
501
502
503
504
505
506
  * - :code:`LlavaNextForConditionalGeneration`
    - LLaVA-NeXT-based
    - T / I
    - :code:`royokong/e5-v`
    - 
    - ✅︎
507
508
509
510
511
512
513
  * - :code:`Phi3VForCausalLM`
    - Phi-3-Vision-based
    - T + I
    - :code:`TIGER-Lab/VLM2Vec-Full`
    - 🚧
    - ✅︎

514
515
516
517
.. important::
  Some model architectures support both generation and embedding tasks.
  In this case, you have to pass :code:`--task embedding` to run the model in embedding mode.

518
----
519

Woosuk Kwon's avatar
Woosuk Kwon committed
520
If your model uses one of the above model architectures, you can seamlessly run your model with vLLM.
521
Otherwise, please refer to :ref:`Adding a New Model <adding_a_new_model>` and :ref:`Enabling Multimodal Inputs <enabling_multimodal_inputs>` 
522
for instructions on how to implement support for your model.
523
Alternatively, you can raise an issue on our `GitHub <https://github.com/vllm-project/vllm/issues>`_ project.
Woosuk Kwon's avatar
Woosuk Kwon committed
524
525
526
527
528
529

.. tip::
    The easiest way to check if your model is supported is to run the program below:

    .. code-block:: python

Woosuk Kwon's avatar
Woosuk Kwon committed
530
        from vllm import LLM
Woosuk Kwon's avatar
Woosuk Kwon committed
531
532
533
534
535

        llm = LLM(model=...)  # Name or path of your model
        output = llm.generate("Hello, my name is")
        print(output)

536
537
538
    If vLLM successfully generates text, it indicates that your model is supported.

.. tip::
539
    To use models from `ModelScope <https://www.modelscope.cn>`_ instead of HuggingFace Hub, set an environment variable:
540
541
542
543
544

    .. code-block:: shell

       $ export VLLM_USE_MODELSCOPE=True

545
546
    And use with :code:`trust_remote_code=True`.

547
548
549
550
551
552
553
    .. code-block:: python

        from vllm import LLM

        llm = LLM(model=..., revision=..., trust_remote_code=True)  # Name or path of your model
        output = llm.generate("Hello, my name is")
        print(output)
554

555

556
Model Support Policy
557
=====================
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576

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.

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:

577
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.
578
579
580
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.
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.
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.