vision_language.py 58.4 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3
"""
Cyrus Leung's avatar
Cyrus Leung committed
4
5
This example shows how to use vLLM for running offline inference with
the correct prompt format on vision language models for text generation.
6
7
8
9

For most models, the prompt format should follow corresponding examples
on HuggingFace model repository.
"""
10

11
import os
12
import random
13
from contextlib import contextmanager
14
from dataclasses import asdict
15
from typing import NamedTuple
16

17
from huggingface_hub import snapshot_download
18
19
from transformers import AutoTokenizer

20
from vllm import LLM, EngineArgs, SamplingParams
21
from vllm.assets.image import ImageAsset
22
from vllm.assets.video import VideoAsset
23
from vllm.lora.request import LoRARequest
24
from vllm.multimodal.image import convert_image_mode
25
26
from vllm.utils import FlexibleArgumentParser

27
28
29
30

class ModelRequestData(NamedTuple):
    engine_args: EngineArgs
    prompts: list[str]
31
32
    stop_token_ids: list[int] | None = None
    lora_requests: list[LoRARequest] | None = None
33
34


35
36
37
38
# NOTE: The default `max_num_seqs` and `max_model_len` may result in OOM on
# lower-end GPUs.
# Unless specified, these settings have been tested to work on a single L4.

39

40
# Aria
41
def run_aria(questions: list[str], modality: str) -> ModelRequestData:
42
43
44
    assert modality == "image"
    model_name = "rhymes-ai/Aria"

45
    # NOTE: Need L40 (or equivalent) to avoid OOM
46
47
48
49
50
    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=2,
        dtype="bfloat16",
51
        limit_mm_per_prompt={modality: 1},
52
    )
53

54
55
56
57
58
59
60
    prompts = [
        (
            f"<|im_start|>user\n<fim_prefix><|img|><fim_suffix>{question}"
            "<|im_end|>\n<|im_start|>assistant\n"
        )
        for question in questions
    ]
61
62

    stop_token_ids = [93532, 93653, 944, 93421, 1019, 93653, 93519]
63
64
65
66
67
68

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
69
70


Jennifer Zhao's avatar
Jennifer Zhao committed
71
72
73
74
75
76
77
78
79
80
# Aya Vision
def run_aya_vision(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"
    model_name = "CohereForAI/aya-vision-8b"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=2048,
        max_num_seqs=2,
        mm_processor_kwargs={"crop_to_patches": True},
81
        limit_mm_per_prompt={modality: 1},
Jennifer Zhao's avatar
Jennifer Zhao committed
82
83
84
85
86
87
88
89
90
91
92
    )
    prompts = [
        f"<|START_OF_TURN_TOKEN|><|USER_TOKEN|><image>{question}<|END_OF_TURN_TOKEN|><|START_OF_TURN_TOKEN|><|CHATBOT_TOKEN|>"
        for question in questions
    ]
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# Bee-8B
def run_bee(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"
    model_name = "Open-Bee/Bee-8B-RL"

    prompts = [
        (
            f"<|im_start|>system\nYou are a helpful assistant.<|im_end|>\n"
            f"<|im_start|>user\n<image>\n{question}<|im_end|>"
            f"<|im_start|>assistant\n<think>\n"
        )
        for question in questions
    ]

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=16384,
        limit_mm_per_prompt={modality: 1},
        trust_remote_code=True,
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


120
# BLIP-2
121
def run_blip2(questions: list[str], modality: str) -> ModelRequestData:
122
123
124
125
    assert modality == "image"

    # BLIP-2 prompt format is inaccurate on HuggingFace model repository.
    # See https://huggingface.co/Salesforce/blip2-opt-2.7b/discussions/15#64ff02f3f8cf9e4f5b038262 #noqa
126
    prompts = [f"Question: {question} Answer:" for question in questions]
127
    engine_args = EngineArgs(
128
        model="Salesforce/blip2-opt-2.7b",
129
        limit_mm_per_prompt={modality: 1},
130
131
132
133
134
135
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
136
137
138


# Chameleon
139
def run_chameleon(questions: list[str], modality: str) -> ModelRequestData:
140
141
    assert modality == "image"

142
    prompts = [f"{question}<image>" for question in questions]
143
144
145
146
    engine_args = EngineArgs(
        model="facebook/chameleon-7b",
        max_model_len=4096,
        max_num_seqs=2,
147
        limit_mm_per_prompt={modality: 1},
148
149
150
151
152
153
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
154
155


Roger Wang's avatar
Roger Wang committed
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# Dots-OCR
def run_dots_ocr(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"

    prompts = [f"<|img|><|imgpad|><|endofimg|>{question}" for question in questions]
    engine_args = EngineArgs(
        model="rednote-hilab/dots.ocr",
        limit_mm_per_prompt={modality: 1},
        trust_remote_code=True,
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
def run_command_a_vision(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"

    model_name = "CohereLabs/command-a-vision-07-2025"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=32768,
        tensor_parallel_size=4,
        limit_mm_per_prompt={modality: 1},
    )

    prompts = [
        f"<|START_OF_TURN_TOKEN|><|USER_TOKEN|><|IMG_PATCH|>{question}<|END_OF_TURN_TOKEN|><|START_OF_TURN_TOKEN|><|CHATBOT_TOKEN|>"
        for question in questions
    ]

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


196
# Deepseek-VL2
197
def run_deepseek_vl2(questions: list[str], modality: str) -> ModelRequestData:
198
199
    assert modality == "image"

200
    model_name = "deepseek-ai/deepseek-vl2-tiny"
201

202
203
204
205
206
    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=2,
        hf_overrides={"architectures": ["DeepseekVLV2ForCausalLM"]},
207
        limit_mm_per_prompt={modality: 1},
208
    )
209

210
    prompts = [
211
        f"<|User|>: <image>\n{question}\n\n<|Assistant|>:" for question in questions
212
    ]
213
214
215
216
217

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
218
219


220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
# Ernie4.5-VL
def run_ernie45_vl(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "baidu/ERNIE-4.5-VL-28B-A3B-PT"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=5,
        limit_mm_per_prompt={modality: 1},
        trust_remote_code=True,
    )

    if modality == "image":
        placeholder = "Picture 1:<|IMAGE_START|><|image@placeholder|><|IMAGE_END|>"
    elif modality == "video":
        placeholder = "Video 1:<|VIDEO_START|><|video@placeholder|><|VIDEO_END|>"

    prompts = [
        (
            f"<|begin_of_sentence|>User: {question}{placeholder}\n"
            "Assistant: <think></think>"
        )
        for question in questions
    ]

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


251
# Fuyu
252
def run_fuyu(questions: list[str], modality: str) -> ModelRequestData:
253
254
    assert modality == "image"

255
    prompts = [f"{question}\n" for question in questions]
256
257
258
259
    engine_args = EngineArgs(
        model="adept/fuyu-8b",
        max_model_len=2048,
        max_num_seqs=2,
260
        limit_mm_per_prompt={modality: 1},
261
262
263
264
265
266
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
267
268


269
# Gemma 3
270
def run_gemma3(questions: list[str], modality: str) -> ModelRequestData:
271
272
273
    assert modality == "image"
    model_name = "google/gemma-3-4b-it"

274
    engine_args = EngineArgs(
275
276
277
        model=model_name,
        max_model_len=2048,
        max_num_seqs=2,
278
279
        # TODO: Support this in transformers backend
        # mm_processor_kwargs={"do_pan_and_scan": True},
280
        limit_mm_per_prompt={modality: 1},
281
    )
282

283
284
285
286
287
288
289
290
    prompts = [
        (
            "<bos><start_of_turn>user\n"
            f"<start_of_image>{question}<end_of_turn>\n"
            "<start_of_turn>model\n"
        )
        for question in questions
    ]
Nicolò Lucchesi's avatar
Nicolò Lucchesi committed
291
292
293
294
295
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )

296

Nicolò Lucchesi's avatar
Nicolò Lucchesi committed
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
# Gemma3N
def run_gemma3n(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"
    model_name = "google/gemma-3n-E2B-it"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=2048,
        max_num_seqs=2,
        limit_mm_per_prompt={modality: 1},
        enforce_eager=True,
    )

    prompts = [
        (
            "<start_of_turn>user\n"
            f"<image_soft_token>{question}<end_of_turn>\n"
            "<start_of_turn>model\n"
        )
        for question in questions
    ]
318
319
320
321
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
322
323


324
# GLM-4v
325
def run_glm4v(questions: list[str], modality: str) -> ModelRequestData:
326
    assert modality == "image"
327
    model_name = "zai-org/glm-4v-9b"
328

329
330
331
332
333
334
335
    engine_args = EngineArgs(
        model=model_name,
        max_model_len=2048,
        max_num_seqs=2,
        trust_remote_code=True,
        enforce_eager=True,
        hf_overrides={"architectures": ["GLM4VForCausalLM"]},
336
        limit_mm_per_prompt={modality: 1},
337
    )
338

339
    prompts = [
340
341
342
343
        (
            "<|user|>\n<|begin_of_image|><|endoftext|><|end_of_image|>"
            f"{question}<|assistant|>"
        )
344
        for question in questions
345
    ]
346

347
    stop_token_ids = [151329, 151336, 151338]
348
349
350
351
352
353

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
354
355


356
357
# GLM-4.1V
def run_glm4_1v(questions: list[str], modality: str) -> ModelRequestData:
358
    model_name = "zai-org/GLM-4.1V-9B-Thinking"
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=2,
        mm_processor_kwargs={
            "size": {"shortest_edge": 12544, "longest_edge": 47040000},
            "fps": 1,
        },
        limit_mm_per_prompt={modality: 1},
        enforce_eager=True,
    )

    if modality == "image":
        placeholder = "<|begin_of_image|><|image|><|end_of_image|>"
    elif modality == "video":
        placeholder = "<|begin_of_video|><|video|><|end_of_video|>"

    prompts = [
        (
            "[gMASK]<sop><|system|>\nYou are a helpful assistant.<|user|>\n"
            f"{placeholder}"
            f"{question}<|assistant|>assistant\n"
        )
        for question in questions
    ]

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
# GLM-4.5V
def run_glm4_5v(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "zai-org/GLM-4.5V"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=2,
        mm_processor_kwargs={
            "size": {"shortest_edge": 12544, "longest_edge": 47040000},
            "fps": 1,
        },
        limit_mm_per_prompt={modality: 1},
        enforce_eager=True,
        tensor_parallel_size=4,
    )

    if modality == "image":
        placeholder = "<|begin_of_image|><|image|><|end_of_image|>"
    elif modality == "video":
        placeholder = "<|begin_of_video|><|video|><|end_of_video|>"

    prompts = [
        (
            "[gMASK]<sop><|system|>\nYou are a helpful assistant.<|user|>\n"
            f"{placeholder}"
            f"{question}<|assistant|>assistant\n"
        )
        for question in questions
    ]

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


# GLM-4.5V-FP8
def run_glm4_5v_fp8(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "zai-org/GLM-4.5V-FP8"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=2,
        mm_processor_kwargs={
            "size": {"shortest_edge": 12544, "longest_edge": 47040000},
            "fps": 1,
        },
        limit_mm_per_prompt={modality: 1},
        enforce_eager=True,
        tensor_parallel_size=4,
    )

    if modality == "image":
        placeholder = "<|begin_of_image|><|image|><|end_of_image|>"
    elif modality == "video":
        placeholder = "<|begin_of_video|><|video|><|end_of_video|>"

    prompts = [
        (
            "[gMASK]<sop><|system|>\nYou are a helpful assistant.<|user|>\n"
            f"{placeholder}"
            f"{question}<|assistant|>assistant\n"
        )
        for question in questions
    ]

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


466
# H2OVL-Mississippi
467
def run_h2ovl(questions: list[str], modality: str) -> ModelRequestData:
468
469
    assert modality == "image"

470
    model_name = "h2oai/h2ovl-mississippi-800m"
471

472
    engine_args = EngineArgs(
473
474
475
        model=model_name,
        trust_remote_code=True,
        max_model_len=8192,
476
        limit_mm_per_prompt={modality: 1},
477
478
    )

479
480
481
482
483
484
485
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
    messages = [
        [{"role": "user", "content": f"<image>\n{question}"}] for question in questions
    ]
    prompts = tokenizer.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
486
487

    # Stop tokens for H2OVL-Mississippi
488
    # https://huggingface.co/h2oai/h2ovl-mississippi-800m
489
    stop_token_ids = [tokenizer.eos_token_id]
490
491
492
493
494
495

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
496
497


498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
# naver-hyperclovax/HyperCLOVAX-SEED-Vision-Instruct-3B
def run_hyperclovax_seed_vision(
    questions: list[str], modality: str
) -> ModelRequestData:
    model_name = "naver-hyperclovax/HyperCLOVAX-SEED-Vision-Instruct-3B"
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)

    engine_args = EngineArgs(
        model=model_name,
        trust_remote_code=True,
        max_model_len=8192 if modality == "image" else 16384,
        limit_mm_per_prompt={modality: 1},
    )

    messages = list()
    for question in questions:
        if modality == "image":
            """
516
517
            ocr: List the words in the image in raster order.
                Even if the word order feels unnatural for reading,
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
                the model will handle it as long as it follows raster order.
                e.g. "Naver, CLOVA, bigshane"
            lens_keywords: List the entity names in the image.
                e.g. "iPhone"
            lens_local_keywords: List the entity names with quads in the image.
                e.g. "[0.07, 0.21, 0.92, 0.90] iPhone"
            """
            messages.append(
                [
                    {
                        "role": "user",
                        "content": [
                            {
                                "type": "image",
                                "ocr": "",
                                "lens_keywords": "",
                                "lens_local_keywords": "",
                            },
                            {
                                "type": "text",
                                "text": question,
                            },
                        ],
                    }
                ]
            )
        elif modality == "video":
            messages.append(
                [
                    {
                        "role": "user",
                        "content": [
                            {
                                "type": "video",
                            },
                            {
                                "type": "text",
                                "text": question,
                            },
                        ],
                    }
                ]
            )
        else:
            raise ValueError(f"Unsupported modality: {modality}")

    prompts = tokenizer.apply_chat_template(
        messages,
        tokenize=False,
        add_generation_prompt=True,
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=None,
    )


577
# Idefics3-8B-Llama3
578
def run_idefics3(questions: list[str], modality: str) -> ModelRequestData:
579
580
581
    assert modality == "image"
    model_name = "HuggingFaceM4/Idefics3-8B-Llama3"

582
    engine_args = EngineArgs(
583
584
585
586
587
588
589
        model=model_name,
        max_model_len=8192,
        max_num_seqs=2,
        enforce_eager=True,
        # if you are running out of memory, you can reduce the "longest_edge".
        # see: https://huggingface.co/HuggingFaceM4/Idefics3-8B-Llama3#model-optimizations
        mm_processor_kwargs={
590
            "size": {"longest_edge": 3 * 364},
591
        },
592
        limit_mm_per_prompt={modality: 1},
593
    )
594
595
596
597
    prompts = [
        (f"<|begin_of_text|>User:<image>{question}<end_of_utterance>\nAssistant:")
        for question in questions
    ]
598
599
600
601
602

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
603
604


Lyu Han's avatar
Lyu Han committed
605
606
# Intern-S1
def run_interns1(questions: list[str], modality: str) -> ModelRequestData:
607
    model_name = "internlm/Intern-S1-mini"
Lyu Han's avatar
Lyu Han committed
608
609
610
611
612
613
614
615
616
617

    engine_args = EngineArgs(
        model=model_name,
        trust_remote_code=True,
        max_model_len=8192,
        max_num_seqs=2,
        limit_mm_per_prompt={modality: 1},
        enforce_eager=True,
    )

618
619
620
621
622
    if modality == "image":
        placeholder = "<IMG_CONTEXT>"
    elif modality == "video":
        placeholder = "<video>"

Lyu Han's avatar
Lyu Han committed
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
    messages = [
        [{"role": "user", "content": f"{placeholder}\n{question}"}]
        for question in questions
    ]
    prompts = tokenizer.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


638
# InternVL
639
def run_internvl(questions: list[str], modality: str) -> ModelRequestData:
640
    model_name = "OpenGVLab/InternVL3-2B"
641

642
    engine_args = EngineArgs(
643
644
        model=model_name,
        trust_remote_code=True,
645
        max_model_len=8192,
646
        limit_mm_per_prompt={modality: 1},
647
648
    )

649
650
651
652
653
    if modality == "image":
        placeholder = "<image>"
    elif modality == "video":
        placeholder = "<video>"

654
655
656
657
658
659
660
661
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
    messages = [
        [{"role": "user", "content": f"{placeholder}\n{question}"}]
        for question in questions
    ]
    prompts = tokenizer.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
662
663
664
665
666
667
668

    # Stop tokens for InternVL
    # models variants may have different stop tokens
    # please refer to the model card for the correct "stop words":
    # https://huggingface.co/OpenGVLab/InternVL2-2B/blob/main/conversation.py
    stop_tokens = ["<|endoftext|>", "<|im_start|>", "<|im_end|>", "<|end|>"]
    stop_token_ids = [tokenizer.convert_tokens_to_ids(i) for i in stop_tokens]
669
    stop_token_ids = [token_id for token_id in stop_token_ids if token_id is not None]
670
671
672
673
674
675

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
676
677


678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
# Keye-VL
def run_keye_vl(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "Kwai-Keye/Keye-VL-8B-Preview"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=8192,
        trust_remote_code=True,
        limit_mm_per_prompt={modality: 1},
    )

    if modality == "image":
        placeholder = "<|image_pad|>"
    elif modality == "video":
        placeholder = "<|video_pad|>"

    prompts = [
        (
            f"<|im_start|>user\n<|vision_start|>{placeholder}<|vision_end|>"
            f"{question}<|im_end|>\n"
            "<|im_start|>assistant\n"
        )
        for question in questions
    ]

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
# Keye-VL-1.5
def run_keye_vl1_5(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "Kwai-Keye/Keye-VL-1.5-8B"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=8192,
        trust_remote_code=True,
        limit_mm_per_prompt={modality: 1},
    )

    if modality == "image":
        placeholder = "<|image_pad|>"
    elif modality == "video":
        placeholder = "<|video_pad|>"

    prompts = [
        (
            f"<|im_start|>user\n<|vision_start|>{placeholder}<|vision_end|>"
            f"{question}<|im_end|>\n"
            "<|im_start|>assistant\n"
        )
        for question in questions
    ]

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


740
741
742
743
744
745
746
# Kimi-VL
def run_kimi_vl(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"

    prompts = [
        "<|im_user|>user<|im_middle|><|media_start|>image<|media_content|>"
        f"<|media_pad|><|media_end|>{question}<|im_end|>"
747
748
        "<|im_assistant|>assistant<|im_middle|>"
        for question in questions
749
750
751
752
753
    ]

    engine_args = EngineArgs(
        model="moonshotai/Kimi-VL-A3B-Instruct",
        trust_remote_code=True,
Cyrus Leung's avatar
Cyrus Leung committed
754
        max_model_len=4096,
755
        limit_mm_per_prompt={modality: 1},
756
757
758
759
760
761
762
763
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
# LightOnOCR
def run_lightonocr(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"

    prompts = [
        "<|im_start|>system<|im_end|>\n<|im_start|>user\n<|image_pad|><|im_end|>\n<|im_start|>assistant\n"
        for _ in questions
    ]

    engine_args = EngineArgs(
        model="lightonai/LightOnOCR-1B",
        limit_mm_per_prompt={modality: 1},
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
def run_llama4(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"

    model_name = "meta-llama/Llama-4-Scout-17B-16E-Instruct"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=8192,
        max_num_seqs=4,
        tensor_parallel_size=8,
        gpu_memory_utilization=0.4,
        limit_mm_per_prompt={modality: 1},
    )

    tokenizer = AutoTokenizer.from_pretrained(model_name)
    messages = [
        [
            {
                "role": "user",
                "content": [{"type": "image"}, {"type": "text", "text": f"{question}"}],
            }
        ]
        for question in questions
    ]
    prompts = tokenizer.apply_chat_template(
        messages, add_generation_prompt=True, tokenize=False
    )
    stop_token_ids = None
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )


819
# LLaVA-1.5
820
def run_llava(questions: list[str], modality: str) -> ModelRequestData:
821
    assert modality == "image"
822

823
    prompts = [f"USER: <image>\n{question}\nASSISTANT:" for question in questions]
824

825
826
827
    engine_args = EngineArgs(
        model="llava-hf/llava-1.5-7b-hf",
        max_model_len=4096,
828
        limit_mm_per_prompt={modality: 1},
829
830
831
832
833
834
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
835
836
837


# LLaVA-1.6/LLaVA-NeXT
838
def run_llava_next(questions: list[str], modality: str) -> ModelRequestData:
839
    assert modality == "image"
840

841
    prompts = [f"[INST] <image>\n{question} [/INST]" for question in questions]
842
843
844
    engine_args = EngineArgs(
        model="llava-hf/llava-v1.6-mistral-7b-hf",
        max_model_len=8192,
845
        limit_mm_per_prompt={modality: 1},
846
847
848
849
850
851
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
852
853
854
855


# LlaVA-NeXT-Video
# Currently only support for video input
856
def run_llava_next_video(questions: list[str], modality: str) -> ModelRequestData:
857
858
    assert modality == "video"

859
    prompts = [f"USER: <video>\n{question} ASSISTANT:" for question in questions]
860
861
862
    engine_args = EngineArgs(
        model="llava-hf/LLaVA-NeXT-Video-7B-hf",
        max_model_len=8192,
863
        max_num_seqs=2,
864
        limit_mm_per_prompt={modality: 1},
865
866
867
868
869
870
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
871
872


873
# LLaVA-OneVision
874
def run_llava_onevision(questions: list[str], modality: str) -> ModelRequestData:
875
    if modality == "video":
876
        prompts = [
877
            f"<|im_start|>user <video>\n{question}<|im_end|><|im_start|>assistant\n"
878
            for question in questions
879
        ]
880
881

    elif modality == "image":
882
        prompts = [
883
            f"<|im_start|>user <image>\n{question}<|im_end|><|im_start|>assistant\n"
884
            for question in questions
885
        ]
886

887
888
889
    engine_args = EngineArgs(
        model="llava-hf/llava-onevision-qwen2-7b-ov-hf",
        max_model_len=16384,
890
        limit_mm_per_prompt={modality: 1},
891
892
893
894
895
896
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
897
898


899
# Mantis
900
def run_mantis(questions: list[str], modality: str) -> ModelRequestData:
901
    assert modality == "image"
902

903
904
    llama3_template = "<|start_header_id|>user<|end_header_id|>\n\n{}<|eot_id|><|start_header_id|>assistant<|end_header_id|>\n\n"  # noqa: E501
    prompts = [llama3_template.format(f"{question}\n<image>") for question in questions]
905

906
    engine_args = EngineArgs(
907
        model="TIGER-Lab/Mantis-8B-siglip-llama3",
908
        max_model_len=4096,
909
        hf_overrides={"architectures": ["MantisForConditionalGeneration"]},
910
        limit_mm_per_prompt={modality: 1},
911
    )
912
    stop_token_ids = [128009]
913
914
915
916
917
918

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
919
920
921


# MiniCPM-V
922
def run_minicpmv_base(questions: list[str], modality: str, model_name):
923
924
    assert modality in ["image", "video"]
    # If you want to use `MiniCPM-o-2_6` with audio inputs, check `audio_language.py` # noqa
925
926
927
928
929
930
931

    # 2.0
    # The official repo doesn't work yet, so we need to use a fork for now
    # For more details, please see: See: https://github.com/vllm-project/vllm/pull/4087#issuecomment-2250397630 # noqa
    # model_name = "HwwwH/MiniCPM-V-2"

    # 2.5
932
933
    # model_name = "openbmb/MiniCPM-Llama3-V-2_5"

934
    # 2.6
935
936
937
938
939
940
941
942
943
    # model_name = "openbmb/MiniCPM-V-2_6"
    # o2.6

    # modality supports
    # 2.0: image
    # 2.5: image
    # 2.6: image, video
    # o2.6: image, video, audio
    # model_name = "openbmb/MiniCPM-o-2_6"
944
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
945
    engine_args = EngineArgs(
946
        model=model_name,
947
948
        max_model_len=4096,
        max_num_seqs=2,
949
        trust_remote_code=True,
950
        limit_mm_per_prompt={modality: 1},
951
    )
952
953
954
955
956
957
958
    # NOTE The stop_token_ids are different for various versions of MiniCPM-V
    # 2.0
    # stop_token_ids = [tokenizer.eos_id]

    # 2.5
    # stop_token_ids = [tokenizer.eos_id, tokenizer.eot_id]

959
    # 2.6 / o2.6
960
    stop_tokens = ["<|im_end|>", "<|endoftext|>"]
961
    stop_token_ids = [tokenizer.convert_tokens_to_ids(i) for i in stop_tokens]
962

963
964
965
966
967
    modality_placeholder = {
        "image": "(<image>./</image>)",
        "video": "(<video>./</video>)",
    }

968
969
    prompts = [
        tokenizer.apply_chat_template(
970
971
972
973
974
975
            [
                {
                    "role": "user",
                    "content": f"{modality_placeholder[modality]}\n{question}",
                }
            ],
976
            tokenize=False,
977
978
979
            add_generation_prompt=True,
        )
        for question in questions
980
    ]
981
982
983
984
985
986

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
987
988


989
def run_minicpmo(questions: list[str], modality: str) -> ModelRequestData:
990
    return run_minicpmv_base(questions, modality, "openbmb/MiniCPM-o-2_6")
991
992


993
def run_minicpmv(questions: list[str], modality: str) -> ModelRequestData:
994
    return run_minicpmv_base(questions, modality, "openbmb/MiniCPM-V-2_6")
995
996


997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
def run_minimax_vl_01(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"

    model_name = "MiniMaxAI/MiniMax-VL-01"

    engine_args = EngineArgs(
        model=model_name,
        max_num_seqs=2,
        limit_mm_per_prompt={modality: 1},
        trust_remote_code=True,
        tensor_parallel_size=8,
    )

    tokenizer = AutoTokenizer.from_pretrained(model_name)
    messages = [
        [
            {
                "role": "user",
                "content": [{"type": "image"}, {"type": "text", "text": question}],
            }
        ]
        for question in questions
    ]
    prompts = tokenizer.apply_chat_template(
        messages, add_generation_prompt=True, tokenize=False
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
# Mistral-3 HF-format
def run_mistral3(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"

    model_name = "mistralai/Mistral-Small-3.1-24B-Instruct-2503"

    # NOTE: Need L40 (or equivalent) to avoid OOM
    engine_args = EngineArgs(
        model=model_name,
        max_model_len=8192,
        max_num_seqs=2,
        tensor_parallel_size=2,
1042
        limit_mm_per_prompt={modality: 1},
1043
        ignore_patterns=["consolidated.safetensors"],
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
    )

    prompts = [f"<s>[INST]{question}\n[IMG][/INST]" for question in questions]

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


1054
1055
# Molmo
def run_molmo(questions: list[str], modality: str) -> ModelRequestData:
1056
1057
    assert modality == "image"

1058
    model_name = "allenai/Molmo-7B-D-0924"
1059
1060
1061

    engine_args = EngineArgs(
        model=model_name,
1062
1063
        trust_remote_code=True,
        dtype="bfloat16",
1064
        limit_mm_per_prompt={modality: 1},
1065
1066
    )

1067
    prompts = [
1068
        f"<|im_start|>user <image>\n{question}<|im_end|><|im_start|>assistant\n"
1069
1070
        for question in questions
    ]
1071

1072
1073
1074
1075
1076
1077
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


1078
1079
1080
# Nemontron_VL
def run_nemotron_vl(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "nvidia/Llama-3.1-Nemotron-Nano-VL-8B-V1"
1081

1082
    engine_args = EngineArgs(
1083
        model=model_name,
1084
        trust_remote_code=True,
1085
        max_model_len=8192,
1086
        limit_mm_per_prompt={modality: 1},
1087
    )
1088

1089
1090
1091
1092
1093
1094
    assert modality == "image"
    placeholder = "<image>"

    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
    messages = [
        [{"role": "user", "content": f"{placeholder}\n{question}"}]
1095
        for question in questions
1096
    ]
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
    prompts = tokenizer.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

    # Stop tokens for InternVL
    # models variants may have different stop tokens
    # please refer to the model card for the correct "stop words":
    # https://huggingface.co/OpenGVLab/InternVL2-2B/blob/main/conversation.py
    stop_tokens = ["<|endoftext|>", "<|im_start|>", "<|im_end|>", "<|end|>"]
    stop_token_ids = [tokenizer.convert_tokens_to_ids(i) for i in stop_tokens]
    stop_token_ids = [token_id for token_id in stop_token_ids if token_id is not None]
1108
1109
1110
1111

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
1112
        stop_token_ids=stop_token_ids,
1113
    )
1114
1115


1116
# NVLM-D
1117
def run_nvlm_d(questions: list[str], modality: str) -> ModelRequestData:
1118
1119
1120
1121
1122
    assert modality == "image"

    model_name = "nvidia/NVLM-D-72B"

    # Adjust this as necessary to fit in GPU
1123
    engine_args = EngineArgs(
1124
1125
1126
1127
        model=model_name,
        trust_remote_code=True,
        max_model_len=4096,
        tensor_parallel_size=4,
1128
        limit_mm_per_prompt={modality: 1},
1129
1130
    )

1131
1132
1133
1134
1135
1136
1137
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
    messages = [
        [{"role": "user", "content": f"<image>\n{question}"}] for question in questions
    ]
    prompts = tokenizer.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
1138
1139
1140
1141
1142

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
1143
1144


1145
1146
# Ovis
def run_ovis(questions: list[str], modality: str) -> ModelRequestData:
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
    assert modality == "image"

    model_name = "AIDC-AI/Ovis2-1B"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=2,
        trust_remote_code=True,
        dtype="half",
1157
        limit_mm_per_prompt={modality: 1},
1158
1159
    )

1160
1161
1162
1163
1164
1165
1166
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
    messages = [
        [{"role": "user", "content": f"<image>\n{question}"}] for question in questions
    ]
    prompts = tokenizer.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
1167
1168
1169
1170
1171
1172
1173

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
# Ovis2_5
def run_ovis2_5(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "AIDC-AI/Ovis2.5-2B"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=2,
        trust_remote_code=True,
        dtype="half",
        limit_mm_per_prompt={modality: 1},
    )
    if modality == "image":
        placeholder = "<image>"
    elif modality == "video":
        placeholder = "<video>"

1191
1192
    prompts = [
        f"<|im_start|>user\n\n{placeholder}\n{question}<|im_end|>\n<|im_start|>assistant\n"
1193
1194
1195
1196
1197
1198
1199
1200
1201
        for question in questions
    ]

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


1202
# PaliGemma
1203
def run_paligemma(questions: list[str], modality: str) -> ModelRequestData:
1204
    assert modality == "image"
1205

1206
    # PaliGemma has special prompt format for VQA
1207
1208
1209
    prompts = ["caption en" for _ in questions]
    engine_args = EngineArgs(
        model="google/paligemma-3b-mix-224",
1210
        limit_mm_per_prompt={modality: 1},
1211
    )
1212
1213
1214
1215
1216

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
1217
1218


1219
# PaliGemma 2
1220
def run_paligemma2(questions: list[str], modality: str) -> ModelRequestData:
1221
    assert modality == "image"
1222

1223
    # PaliGemma 2 has special prompt format for VQA
1224
1225
1226
    prompts = ["caption en" for _ in questions]
    engine_args = EngineArgs(
        model="google/paligemma2-3b-ft-docci-448",
1227
        limit_mm_per_prompt={modality: 1},
1228
    )
1229
1230
1231
1232
1233

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
1234
1235


1236
# Phi-3-Vision
1237
def run_phi3v(questions: list[str], modality: str) -> ModelRequestData:
1238
1239
    assert modality == "image"

1240
1241
1242
1243
    prompts = [
        f"<|user|>\n<|image_1|>\n{question}<|end|>\n<|assistant|>\n"
        for question in questions
    ]
1244

1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
    # num_crops is an override kwarg to the multimodal image processor;
    # For some models, e.g., Phi-3.5-vision-instruct, it is recommended
    # to use 16 for single frame scenarios, and 4 for multi-frame.
    #
    # Generally speaking, a larger value for num_crops results in more
    # tokens per image instance, because it may scale the image more in
    # the image preprocessing. Some references in the model docs and the
    # formula for image tokens after the preprocessing
    # transform can be found below.
    #
    # https://huggingface.co/microsoft/Phi-3.5-vision-instruct#loading-the-model-locally
    # https://huggingface.co/microsoft/Phi-3.5-vision-instruct/blob/main/processing_phi3_v.py#L194
1257
    engine_args = EngineArgs(
1258
1259
        model="microsoft/Phi-3.5-vision-instruct",
        trust_remote_code=True,
1260
        max_model_len=4096,
1261
        max_num_seqs=2,
1262
        # Note - mm_processor_kwargs can also be passed to generate/chat calls
1263
        mm_processor_kwargs={"num_crops": 16},
1264
        limit_mm_per_prompt={modality: 1},
1265
    )
1266
1267
1268
1269
1270

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
1271
1272


1273
# Phi-4-multimodal-instruct
1274
def run_phi4mm(questions: list[str], modality: str) -> ModelRequestData:
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
    """
    Phi-4-multimodal-instruct supports both image and audio inputs. Here, we
    show how to process image inputs.
    """
    assert modality == "image"
    model_path = snapshot_download("microsoft/Phi-4-multimodal-instruct")
    # Since the vision-lora and speech-lora co-exist with the base model,
    # we have to manually specify the path of the lora weights.
    vision_lora_path = os.path.join(model_path, "vision-lora")
    prompts = [
1285
        f"<|user|><|image_1|>{question}<|end|><|assistant|>" for question in questions
1286
    ]
1287
    engine_args = EngineArgs(
1288
1289
        model=model_path,
        trust_remote_code=True,
1290
        max_model_len=5120,
1291
        max_num_seqs=2,
1292
        max_num_batched_tokens=12800,
1293
1294
        enable_lora=True,
        max_lora_rank=320,
1295
1296
        # Note - mm_processor_kwargs can also be passed to generate/chat calls
        mm_processor_kwargs={"dynamic_hd": 16},
1297
        limit_mm_per_prompt={modality: 1},
1298
1299
    )

1300
1301
1302
1303
1304
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        lora_requests=[LoRARequest("vision", 1, vision_lora_path)],
    )
1305
1306


1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
# HF format Phi-4-multimodal-instruct
def run_phi4_multimodal(questions: list[str], modality: str) -> ModelRequestData:
    """
    Phi-4-multimodal-instruct supports both image and audio inputs. Here, we
    show how to process image inputs.
    """
    assert modality == "image"
    model_path = snapshot_download(
        "microsoft/Phi-4-multimodal-instruct", revision="refs/pr/70"
    )
    # Since the vision-lora and speech-lora co-exist with the base model,
    # we have to manually specify the path of the lora weights.
    vision_lora_path = os.path.join(model_path, "vision-lora")
    prompts = [
        f"<|user|><|image|>{question}<|end|><|assistant|>" for question in questions
    ]
    engine_args = EngineArgs(
        model=model_path,
        max_model_len=5120,
        max_num_seqs=2,
        max_num_batched_tokens=12800,
        enable_lora=True,
        max_lora_rank=320,
        # Note - mm_processor_kwargs can also be passed to generate/chat calls
        mm_processor_kwargs={"dynamic_hd": 16},
        limit_mm_per_prompt={"image": 1},
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        lora_requests=[LoRARequest("vision", 1, vision_lora_path)],
    )


1342
# Pixtral HF-format
1343
def run_pixtral_hf(questions: list[str], modality: str) -> ModelRequestData:
1344
1345
1346
1347
    assert modality == "image"

    model_name = "mistral-community/pixtral-12b"

1348
    # NOTE: Need L40 (or equivalent) to avoid OOM
1349
    engine_args = EngineArgs(
1350
        model=model_name,
1351
        max_model_len=6144,
1352
        max_num_seqs=2,
1353
        limit_mm_per_prompt={modality: 1},
1354
1355
    )

1356
    prompts = [f"<s>[INST]{question}\n[IMG][/INST]" for question in questions]
1357
1358
1359
1360
1361

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
1362
1363


1364
# Qwen-VL
1365
def run_qwen_vl(questions: list[str], modality: str) -> ModelRequestData:
1366
1367
    assert modality == "image"

1368
    engine_args = EngineArgs(
1369
        model="Qwen/Qwen-VL",
1370
        trust_remote_code=True,
1371
1372
        max_model_len=1024,
        max_num_seqs=2,
1373
        hf_overrides={"architectures": ["QwenVLForConditionalGeneration"]},
1374
        limit_mm_per_prompt={modality: 1},
1375
1376
    )

1377
    prompts = [f"{question}Picture 1: <img></img>\n" for question in questions]
1378
1379
1380
1381
1382

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
1383
1384


1385
# Qwen2-VL
1386
def run_qwen2_vl(questions: list[str], modality: str) -> ModelRequestData:
1387
    model_name = "Qwen/Qwen2-VL-7B-Instruct"
1388

1389
    engine_args = EngineArgs(
1390
        model=model_name,
1391
1392
1393
        max_model_len=4096,
        max_num_seqs=5,
        # Note - mm_processor_kwargs can also be passed to generate/chat calls
1394
        mm_processor_kwargs={
1395
1396
            "min_pixels": 28 * 28,
            "max_pixels": 1280 * 28 * 28,
1397
        },
1398
        limit_mm_per_prompt={modality: 1},
1399
    )
1400

1401
1402
1403
1404
1405
    if modality == "image":
        placeholder = "<|image_pad|>"
    elif modality == "video":
        placeholder = "<|video_pad|>"

1406
    prompts = [
1407
1408
1409
1410
1411
1412
1413
        (
            "<|im_start|>system\nYou are a helpful assistant.<|im_end|>\n"
            f"<|im_start|>user\n<|vision_start|>{placeholder}<|vision_end|>"
            f"{question}<|im_end|>\n"
            "<|im_start|>assistant\n"
        )
        for question in questions
1414
    ]
1415
1416
1417
1418
1419

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
1420
1421


Roger Wang's avatar
Roger Wang committed
1422
# Qwen2.5-VL
1423
def run_qwen2_5_vl(questions: list[str], modality: str) -> ModelRequestData:
Roger Wang's avatar
Roger Wang committed
1424
1425
    model_name = "Qwen/Qwen2.5-VL-3B-Instruct"

1426
    engine_args = EngineArgs(
Roger Wang's avatar
Roger Wang committed
1427
1428
1429
1430
1431
1432
1433
1434
        model=model_name,
        max_model_len=4096,
        max_num_seqs=5,
        mm_processor_kwargs={
            "min_pixels": 28 * 28,
            "max_pixels": 1280 * 28 * 28,
            "fps": 1,
        },
1435
        limit_mm_per_prompt={modality: 1},
Roger Wang's avatar
Roger Wang committed
1436
1437
1438
1439
1440
1441
1442
    )

    if modality == "image":
        placeholder = "<|image_pad|>"
    elif modality == "video":
        placeholder = "<|video_pad|>"

1443
    prompts = [
1444
1445
1446
1447
1448
1449
1450
        (
            "<|im_start|>system\nYou are a helpful assistant.<|im_end|>\n"
            f"<|im_start|>user\n<|vision_start|>{placeholder}<|vision_end|>"
            f"{question}<|im_end|>\n"
            "<|im_start|>assistant\n"
        )
        for question in questions
1451
    ]
1452
1453
1454
1455
1456

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
Roger Wang's avatar
Roger Wang committed
1457
1458


1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
# Qwen2.5-Omni
def run_qwen2_5_omni(questions: list[str], modality: str):
    model_name = "Qwen/Qwen2.5-Omni-7B"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=5,
        mm_processor_kwargs={
            "min_pixels": 28 * 28,
            "max_pixels": 1280 * 28 * 28,
            "fps": [1],
        },
1472
        limit_mm_per_prompt={modality: 1},
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
    )

    if modality == "image":
        placeholder = "<|IMAGE|>"
    elif modality == "video":
        placeholder = "<|VIDEO|>"

    default_system = (
        "You are Qwen, a virtual human developed by the Qwen Team, Alibaba "
        "Group, capable of perceiving auditory and visual inputs, as well as "
1483
1484
        "generating text and speech."
    )
1485

1486
1487
1488
1489
1490
1491
1492
1493
1494
    prompts = [
        (
            f"<|im_start|>system\n{default_system}<|im_end|>\n"
            f"<|im_start|>user\n<|vision_bos|>{placeholder}<|vision_eos|>"
            f"{question}<|im_end|>\n"
            "<|im_start|>assistant\n"
        )
        for question in questions
    ]
1495
1496
1497
1498
1499
1500
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
# Qwen3-VL-Dense
def run_qwen3_vl(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "Qwen/Qwen3-VL-4B-Instruct"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=5,
        mm_processor_kwargs={
            "min_pixels": 28 * 28,
            "max_pixels": 1280 * 28 * 28,
            "fps": 1,
        },
        limit_mm_per_prompt={modality: 1},
    )

    if modality == "image":
        placeholder = "<|image_pad|>"
    elif modality == "video":
        placeholder = "<|video_pad|>"

    prompts = [
        (
            "<|im_start|>system\nYou are a helpful assistant.<|im_end|>\n"
            f"<|im_start|>user\n<|vision_start|>{placeholder}<|vision_end|>"
            f"{question}<|im_end|>\n"
            "<|im_start|>assistant\n"
        )
        for question in questions
    ]

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


# Qwen3-VL-MOE
def run_qwen3_vl_moe(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "Qwen/Qwen3-VL-30B-A3B-Instruct"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=5,
        mm_processor_kwargs={
            "min_pixels": 28 * 28,
            "max_pixels": 1280 * 28 * 28,
            "fps": 1,
        },
        limit_mm_per_prompt={modality: 1},
    )

    if modality == "image":
        placeholder = "<|image_pad|>"
    elif modality == "video":
        placeholder = "<|video_pad|>"

    prompts = [
        (
            "<|im_start|>system\nYou are a helpful assistant.<|im_end|>\n"
            f"<|im_start|>user\n<|vision_start|>{placeholder}<|vision_end|>"
            f"{question}<|im_end|>\n"
            "<|im_start|>assistant\n"
        )
        for question in questions
    ]

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
# R-4B
def run_r_vl(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"
    model_name = "YannQi/R-4B"

    prompts = [
        f"<|im_start|>user <image>\n{question}<|im_end|><|im_start|>assistant\n"
        for question in questions
    ]

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=16384,
        limit_mm_per_prompt={modality: 1},
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


1597
1598
# SkyworkR1V
def run_skyworkr1v(questions: list[str], modality: str) -> ModelRequestData:
1599
    assert modality == "image"
1600
1601

    model_name = "Skywork/Skywork-R1V-38B"
1602
1603
1604
1605
1606
1607
1608

    engine_args = EngineArgs(
        model=model_name,
        trust_remote_code=True,
        max_model_len=4096,
        limit_mm_per_prompt={modality: 1},
    )
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621

    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
    messages = [
        [{"role": "user", "content": f"<image>\n{question}"}] for question in questions
    ]
    prompts = tokenizer.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

    # Stop tokens for SkyworkR1V
    # https://huggingface.co/Skywork/Skywork-R1V-38B/blob/main/conversation.py
    stop_tokens = ["<|end▁of▁sentence|>", "<|endoftext|>"]
    stop_token_ids = [tokenizer.convert_tokens_to_ids(i) for i in stop_tokens]
1622
1623
1624
1625

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
1626
        stop_token_ids=stop_token_ids,
1627
1628
1629
    )


1630
1631
1632
1633
# SmolVLM2-2.2B-Instruct
def run_smolvlm(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"
    model_name = "HuggingFaceTB/SmolVLM2-2.2B-Instruct"
1634
1635
1636

    engine_args = EngineArgs(
        model=model_name,
1637
1638
1639
1640
1641
1642
        max_model_len=8192,
        max_num_seqs=2,
        enforce_eager=True,
        mm_processor_kwargs={
            "max_image_size": {"longest_edge": 384},
        },
1643
1644
        limit_mm_per_prompt={modality: 1},
    )
1645
1646
1647
1648
    prompts = [
        (f"<|im_start|>User:<image>{question}<end_of_utterance>\nAssistant:")
        for question in questions
    ]
1649

1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


# Step3
def run_step3(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"

    model_name = "stepfun-ai/step3-fp8"

    # NOTE: Below are verified configurations for step3-fp8
    # on 8xH100 GPUs.
    engine_args = EngineArgs(
        model=model_name,
        max_num_batched_tokens=4096,
        gpu_memory_utilization=0.85,
        tensor_parallel_size=8,
        limit_mm_per_prompt={modality: 1},
        reasoning_parser="step3",
    )
1672
1673

    prompts = [
1674
1675
        "<|begin▁of▁sentence|> You are a helpful assistant. <|BOT|>user\n "
        f"<im_patch>{question} <|EOT|><|BOT|>assistant\n<think>\n"
1676
1677
1678
1679
1680
1681
1682
1683
1684
        for question in questions
    ]

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


1685
1686
# omni-research/Tarsier-7b
def run_tarsier(questions: list[str], modality: str) -> ModelRequestData:
1687
    assert modality == "image"
1688
    model_name = "omni-research/Tarsier-7b"
1689
1690
1691
1692
1693

    engine_args = EngineArgs(
        model=model_name,
        trust_remote_code=True,
        max_model_len=4096,
1694
        limit_mm_per_prompt={modality: 1},
1695
    )
1696
    prompts = [(f"USER: <image>\n{question} ASSISTANT:") for question in questions]
1697

1698
1699
1700
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
1701
    )
1702

1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727

def run_tarsier2(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "omni-research/Tarsier2-Recap-7b"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        hf_overrides={"architectures": ["Tarsier2ForConditionalGeneration"]},
        limit_mm_per_prompt={modality: 1},
    )

    if modality == "image":
        placeholder = "<|image_pad|>"
    elif modality == "video":
        placeholder = "<|video_pad|>"

    prompts = [
        (
            "<|im_start|>system\nYou are a helpful assistant.<|im_end|>\n"
            f"<|im_start|>user\n<|vision_start|>{placeholder}<|vision_end|>"
            f"{question}<|im_end|>\n"
            "<|im_start|>assistant\n"
        )
        for question in questions
    ]
1728
1729
1730
1731
1732
1733
1734

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


1735
model_example_map = {
1736
    "aria": run_aria,
Jennifer Zhao's avatar
Jennifer Zhao committed
1737
    "aya_vision": run_aya_vision,
1738
    "bee": run_bee,
1739
1740
    "blip-2": run_blip2,
    "chameleon": run_chameleon,
Roger Wang's avatar
Roger Wang committed
1741
    "dots_ocr": run_dots_ocr,
1742
    "command_a_vision": run_command_a_vision,
1743
    "deepseek_vl_v2": run_deepseek_vl2,
1744
    "ernie45_vl": run_ernie45_vl,
1745
    "fuyu": run_fuyu,
1746
    "gemma3": run_gemma3,
Nicolò Lucchesi's avatar
Nicolò Lucchesi committed
1747
    "gemma3n": run_gemma3n,
1748
    "glm4v": run_glm4v,
1749
    "glm4_1v": run_glm4_1v,
1750
1751
    "glm4_5v": run_glm4_5v,
    "glm4_5v_fp8": run_glm4_5v_fp8,
1752
    "h2ovl_chat": run_h2ovl,
1753
    "hyperclovax_seed_vision": run_hyperclovax_seed_vision,
1754
    "idefics3": run_idefics3,
Lyu Han's avatar
Lyu Han committed
1755
    "interns1": run_interns1,
1756
    "internvl_chat": run_internvl,
1757
    "keye_vl": run_keye_vl,
1758
    "keye_vl1_5": run_keye_vl1_5,
1759
    "kimi_vl": run_kimi_vl,
1760
    "lightonocr": run_lightonocr,
1761
    "llama4": run_llama4,
1762
1763
    "llava": run_llava,
    "llava-next": run_llava_next,
1764
    "llava-next-video": run_llava_next_video,
1765
    "llava-onevision": run_llava_onevision,
1766
    "mantis": run_mantis,
1767
    "minicpmo": run_minicpmo,
1768
    "minicpmv": run_minicpmv,
1769
    "minimax_vl_01": run_minimax_vl_01,
1770
    "mistral3": run_mistral3,
1771
    "molmo": run_molmo,
1772
    "nemotron_vl": run_nemotron_vl,
1773
    "NVLM_D": run_nvlm_d,
1774
    "ovis": run_ovis,
1775
    "ovis2_5": run_ovis2_5,
1776
1777
1778
    "paligemma": run_paligemma,
    "paligemma2": run_paligemma2,
    "phi3_v": run_phi3v,
1779
    "phi4_mm": run_phi4mm,
1780
    "phi4_multimodal": run_phi4_multimodal,
1781
    "pixtral_hf": run_pixtral_hf,
1782
    "qwen_vl": run_qwen_vl,
1783
    "qwen2_vl": run_qwen2_vl,
Roger Wang's avatar
Roger Wang committed
1784
    "qwen2_5_vl": run_qwen2_5_vl,
1785
    "qwen2_5_omni": run_qwen2_5_omni,
1786
1787
    "qwen3_vl": run_qwen3_vl,
    "qwen3_vl_moe": run_qwen3_vl_moe,
1788
    "rvl": run_r_vl,
1789
    "skywork_chat": run_skyworkr1v,
1790
    "smolvlm": run_smolvlm,
1791
    "step3": run_step3,
汪志鹏's avatar
汪志鹏 committed
1792
    "tarsier": run_tarsier,
1793
    "tarsier2": run_tarsier2,
1794
1795
1796
}


1797
1798
1799
1800
MODELS_NEED_VIDEO_METADATA = [
    "glm4_1v",
    "glm4_5v",
    "glm4_5v_fp8",
1801
1802
    "qwen3_vl",
    "qwen3_vl_moe",
1803
1804
1805
]


1806
1807
1808
1809
1810
1811
1812
1813
1814
def get_multi_modal_input(args):
    """
    return {
        "data": image or video,
        "question": question,
    }
    """
    if args.modality == "image":
        # Input image and question
1815
        image = convert_image_mode(ImageAsset("cherry_blossom").pil_image, "RGB")
1816
1817
1818
1819
1820
1821
        img_questions = [
            "What is the content of this image?",
            "Describe the content of this image in detail.",
            "What's in the image?",
            "Where is this image taken?",
        ]
1822
1823
1824

        return {
            "data": image,
1825
            "questions": img_questions,
1826
1827
1828
1829
        }

    if args.modality == "video":
        # Input video and question
1830
        needs_metadata = args.model_type in MODELS_NEED_VIDEO_METADATA
1831
        video = VideoAsset(name="baby_reading", num_frames=args.num_frames).np_ndarrays
1832
        metadata = VideoAsset(name="baby_reading", num_frames=args.num_frames).metadata
1833
        vid_questions = ["Why is this video funny?"]
1834
1835

        return {
1836
            "data": ([(video, metadata)] if needs_metadata else video),
1837
            "questions": vid_questions,
1838
1839
1840
1841
1842
1843
        }

    msg = f"Modality {args.modality} is not supported."
    raise ValueError(msg)


1844
1845
1846
1847
def apply_image_repeat(
    image_repeat_prob, num_prompts, data, prompts: list[str], modality
):
    """Repeats images with provided probability of "image_repeat_prob".
1848
1849
    Used to simulate hit/miss for the MM preprocessor cache.
    """
1850
    assert image_repeat_prob <= 1.0 and image_repeat_prob >= 0
1851
1852
1853
1854
    no_yes = [0, 1]
    probs = [1.0 - image_repeat_prob, image_repeat_prob]

    inputs = []
1855
    inputs_with_empty_media = []
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
    cur_image = data
    for i in range(num_prompts):
        if image_repeat_prob is not None:
            res = random.choices(no_yes, probs)[0]
            if res == 0:
                # No repeat => Modify one pixel
                cur_image = cur_image.copy()
                new_val = (i // 256 // 256, i // 256, i % 256)
                cur_image.putpixel((0, 0), new_val)

1866
1867
        uuid = "uuid_{}".format(i)

1868
1869
1870
1871
        inputs.append(
            {
                "prompt": prompts[i % len(prompts)],
                "multi_modal_data": {modality: cur_image},
1872
1873
1874
1875
1876
1877
1878
1879
1880
                "multi_modal_uuids": {modality: uuid},
            }
        )

        inputs_with_empty_media.append(
            {
                "prompt": prompts[i % len(prompts)],
                "multi_modal_data": {modality: None},
                "multi_modal_uuids": {modality: uuid},
1881
            }
1882
        )
1883

1884
    return inputs, inputs_with_empty_media
1885
1886


1887
1888
1889
1890
@contextmanager
def time_counter(enable: bool):
    if enable:
        import time
1891

1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
        start_time = time.time()
        yield
        elapsed_time = time.time() - start_time
        print("-" * 50)
        print("-- generate time = {}".format(elapsed_time))
        print("-" * 50)
    else:
        yield


1902
1903
def parse_args():
    parser = FlexibleArgumentParser(
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
        description="Demo on using vLLM for offline inference with "
        "vision language models for text generation"
    )
    parser.add_argument(
        "--model-type",
        "-m",
        type=str,
        default="llava",
        choices=model_example_map.keys(),
        help='Huggingface "model_type".',
    )
    parser.add_argument(
        "--num-prompts", type=int, default=4, help="Number of prompts to run."
    )
    parser.add_argument(
        "--modality",
        type=str,
        default="image",
        choices=["image", "video"],
        help="Modality of the input.",
    )
    parser.add_argument(
        "--num-frames",
        type=int,
        default=16,
        help="Number of frames to extract from the video.",
    )
    parser.add_argument(
        "--seed",
        type=int,
        default=None,
        help="Set the seed when initializing `vllm.LLM`.",
    )
1937
1938

    parser.add_argument(
1939
        "--image-repeat-prob",
1940
1941
        type=float,
        default=None,
1942
1943
        help="Simulates the hit-ratio for multi-modal preprocessor cache (if enabled)",
    )
1944
1945

    parser.add_argument(
1946
        "--disable-mm-processor-cache",
1947
        action="store_true",
1948
        help="If True, disables caching of multi-modal processor.",
1949
    )
1950
1951

    parser.add_argument(
1952
1953
1954
1955
        "--time-generate",
        action="store_true",
        help="If True, then print the total generate() call time",
    )
1956
1957

    parser.add_argument(
1958
1959
1960
1961
1962
        "--use-different-prompt-per-request",
        action="store_true",
        help="If True, then use different prompt (with the same multi-modal "
        "data) for each request.",
    )
1963
1964
1965
1966
1967
1968
1969

    parser.add_argument(
        "--verify-mm-cache-hit-with-uuids",
        action="store_true",
        help="If True, will send all requests in a second batch with empty mm "
        "data to verify cache hits with UUIDs.",
    )
1970
1971
1972
    return parser.parse_args()


1973
1974
1975
1976
1977
def main(args):
    model = args.model_type
    if model not in model_example_map:
        raise ValueError(f"Model type {model} is not supported.")

1978
1979
1980
    modality = args.modality
    mm_input = get_multi_modal_input(args)
    data = mm_input["data"]
1981
    questions = mm_input["questions"]
1982

1983
1984
    req_data = model_example_map[model](questions, modality)

1985
1986
1987
    # Disable other modalities to save memory
    default_limits = {"image": 0, "video": 0, "audio": 0}
    req_data.engine_args.limit_mm_per_prompt = default_limits | dict(
1988
1989
        req_data.engine_args.limit_mm_per_prompt or {}
    )
1990
1991
1992

    engine_args = asdict(req_data.engine_args) | {
        "seed": args.seed,
1993
        "mm_processor_cache_gb": 0 if args.disable_mm_processor_cache else 4,
1994
    }
1995
1996
    llm = LLM(**engine_args)

1997
    # Don't want to check the flag multiple times, so just hijack `prompts`.
1998
1999
2000
2001
2002
    prompts = (
        req_data.prompts
        if args.use_different_prompt_per_request
        else [req_data.prompts[0]]
    )
2003
2004
2005

    # We set temperature to 0.2 so that outputs can be different
    # even when all prompts are identical when running batch inference.
2006
2007
2008
    sampling_params = SamplingParams(
        temperature=0.2, max_tokens=64, stop_token_ids=req_data.stop_token_ids
    )
2009
2010
2011
2012

    assert args.num_prompts > 0
    if args.num_prompts == 1:
        # Single inference
2013
        uuid = "uuid_0"
2014
        inputs = {
2015
            "prompt": prompts[0],
2016
            "multi_modal_data": {modality: data},
2017
2018
2019
2020
2021
2022
            "multi_modal_uuids": {modality: uuid},
        }
        inputs_with_empty_media = {
            "prompt": prompts[0],
            "multi_modal_data": {modality: None},
            "multi_modal_uuids": {modality: uuid},
2023
2024
2025
        }
    else:
        # Batch inference
2026
2027
        if args.image_repeat_prob is not None:
            # Repeat images with specified probability of "image_repeat_prob"
2028
2029
2030
2031
2032
2033
            inputs, inputs_with_empty_media = apply_image_repeat(
                args.image_repeat_prob,
                args.num_prompts,
                data,
                prompts,
                modality,
2034
            )
2035
2036
        else:
            # Use the same image for all prompts
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
            inputs = []
            inputs_with_empty_media = []
            for i in range(args.num_prompts):
                uuid = "uuid_{}".format(i)
                inputs.append(
                    {
                        "prompt": prompts[i % len(prompts)],
                        "multi_modal_data": {modality: data},
                        "multi_modal_uuids": {modality: uuid},
                    }
                )
                inputs_with_empty_media.append(
                    {
                        "prompt": prompts[i % len(prompts)],
                        "multi_modal_data": {modality: None},
                        "multi_modal_uuids": {modality: uuid},
                    }
                )
2055

2056
    # Add LoRA request if applicable
2057
2058
2059
    lora_request = (
        req_data.lora_requests * args.num_prompts if req_data.lora_requests else None
    )
2060

2061
2062
2063
2064
2065
2066
    with time_counter(args.time_generate):
        outputs = llm.generate(
            inputs,
            sampling_params=sampling_params,
            lora_request=lora_request,
        )
2067

2068
    print("-" * 50)
2069
2070
2071
    for o in outputs:
        generated_text = o.outputs[0].text
        print(generated_text)
2072
        print("-" * 50)
2073

2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
    if args.verify_mm_cache_hit_with_uuids:
        try:
            # Verify cache hits with UUIDs
            print(
                "Sending a second batch of requests with empty media"
                " and matching UUIDs."
            )
            outputs = llm.generate(
                inputs_with_empty_media,
                sampling_params=sampling_params,
                lora_request=lora_request,
            )
            print("-" * 50)
            for o in outputs:
                generated_text = o.outputs[0].text
                print(generated_text)
                print("-" * 50)
        except Exception as e:
            print(f"Failed to verify cache hits with UUIDs. Error: {e}")

2094
2095

if __name__ == "__main__":
2096
    args = parse_args()
2097
    main(args)