vision_language.py 51.3 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
15
from dataclasses import asdict
from typing import NamedTuple, Optional
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
31
32
33
34

class ModelRequestData(NamedTuple):
    engine_args: EngineArgs
    prompts: list[str]
    stop_token_ids: Optional[list[int]] = None
    lora_requests: Optional[list[LoRARequest]] = None


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
# BLIP-2
94
def run_blip2(questions: list[str], modality: str) -> ModelRequestData:
95
96
97
98
    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
99
    prompts = [f"Question: {question} Answer:" for question in questions]
100
    engine_args = EngineArgs(
101
        model="Salesforce/blip2-opt-2.7b",
102
        limit_mm_per_prompt={modality: 1},
103
104
105
106
107
108
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
109
110
111


# Chameleon
112
def run_chameleon(questions: list[str], modality: str) -> ModelRequestData:
113
114
    assert modality == "image"

115
    prompts = [f"{question}<image>" for question in questions]
116
117
118
119
    engine_args = EngineArgs(
        model="facebook/chameleon-7b",
        max_model_len=4096,
        max_num_seqs=2,
120
        limit_mm_per_prompt={modality: 1},
121
122
123
124
125
126
    )

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


129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
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,
    )


152
# Deepseek-VL2
153
def run_deepseek_vl2(questions: list[str], modality: str) -> ModelRequestData:
154
155
    assert modality == "image"

156
    model_name = "deepseek-ai/deepseek-vl2-tiny"
157

158
159
160
161
162
    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=2,
        hf_overrides={"architectures": ["DeepseekVLV2ForCausalLM"]},
163
        limit_mm_per_prompt={modality: 1},
164
    )
165

166
    prompts = [
167
        f"<|User|>: <image>\n{question}\n\n<|Assistant|>:" for question in questions
168
    ]
169
170
171
172
173

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


176
# Florence2
177
def run_florence2(questions: list[str], modality: str) -> ModelRequestData:
178
179
    assert modality == "image"

180
181
    engine_args = EngineArgs(
        model="microsoft/Florence-2-large",
182
        tokenizer="Isotr0py/Florence-2-tokenizer",
183
184
        max_model_len=4096,
        max_num_seqs=2,
185
186
        trust_remote_code=True,
        dtype="bfloat16",
187
        limit_mm_per_prompt={modality: 1},
188
    )
189

190
191
192
193
194
195
    prompts = ["<MORE_DETAILED_CAPTION>" for _ in questions]

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


198
# Fuyu
199
def run_fuyu(questions: list[str], modality: str) -> ModelRequestData:
200
201
    assert modality == "image"

202
    prompts = [f"{question}\n" for question in questions]
203
204
205
206
    engine_args = EngineArgs(
        model="adept/fuyu-8b",
        max_model_len=2048,
        max_num_seqs=2,
207
        limit_mm_per_prompt={modality: 1},
208
209
210
211
212
213
    )

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


216
# Gemma 3
217
def run_gemma3(questions: list[str], modality: str) -> ModelRequestData:
218
219
220
    assert modality == "image"
    model_name = "google/gemma-3-4b-it"

221
    engine_args = EngineArgs(
222
223
224
225
        model=model_name,
        max_model_len=2048,
        max_num_seqs=2,
        mm_processor_kwargs={"do_pan_and_scan": True},
226
        limit_mm_per_prompt={modality: 1},
227
    )
228

229
230
231
232
233
234
235
236
    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
237
238
239
240
241
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )

242

Nicolò Lucchesi's avatar
Nicolò Lucchesi committed
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# 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
    ]
264
265
266
267
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
268
269


270
# GLM-4v
271
def run_glm4v(questions: list[str], modality: str) -> ModelRequestData:
272
    assert modality == "image"
273
    model_name = "zai-org/glm-4v-9b"
274

275
276
277
278
279
280
281
    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"]},
282
        limit_mm_per_prompt={modality: 1},
283
    )
284

285
286
    prompts = [
        f"<|user|>\n<|begin_of_image|><|endoftext|><|end_of_image|>\
287
288
        {question}<|assistant|>"
        for question in questions
289
    ]
290

291
    stop_token_ids = [151329, 151336, 151338]
292
293
294
295
296
297

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
298
299


300
301
# GLM-4.1V
def run_glm4_1v(questions: list[str], modality: str) -> ModelRequestData:
302
    model_name = "zai-org/GLM-4.1V-9B-Thinking"
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335

    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,
    )


336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
# 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,
    )


410
# H2OVL-Mississippi
411
def run_h2ovl(questions: list[str], modality: str) -> ModelRequestData:
412
413
    assert modality == "image"

414
    model_name = "h2oai/h2ovl-mississippi-800m"
415

416
    engine_args = EngineArgs(
417
418
419
        model=model_name,
        trust_remote_code=True,
        max_model_len=8192,
420
        limit_mm_per_prompt={modality: 1},
421
422
    )

423
424
425
426
427
428
429
    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
    )
430
431

    # Stop tokens for H2OVL-Mississippi
432
    # https://huggingface.co/h2oai/h2ovl-mississippi-800m
433
    stop_token_ids = [tokenizer.eos_token_id]
434
435
436
437
438
439

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
440
441


442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
# 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":
            """
460
461
            ocr: List the words in the image in raster order.
                Even if the word order feels unnatural for reading,
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
                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,
    )


521
# Idefics3-8B-Llama3
522
def run_idefics3(questions: list[str], modality: str) -> ModelRequestData:
523
524
525
    assert modality == "image"
    model_name = "HuggingFaceM4/Idefics3-8B-Llama3"

526
    engine_args = EngineArgs(
527
528
529
530
531
532
533
        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={
534
            "size": {"longest_edge": 3 * 364},
535
        },
536
        limit_mm_per_prompt={modality: 1},
537
    )
538
539
540
541
    prompts = [
        (f"<|begin_of_text|>User:<image>{question}<end_of_utterance>\nAssistant:")
        for question in questions
    ]
542
543
544
545
546

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


Lyu Han's avatar
Lyu Han committed
549
550
551
552
553
554
555
556
557
558
559
560
561
# Intern-S1
def run_interns1(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "internlm/Intern-S1"

    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,
    )

562
563
564
565
566
    if modality == "image":
        placeholder = "<IMG_CONTEXT>"
    elif modality == "video":
        placeholder = "<video>"

Lyu Han's avatar
Lyu Han committed
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
    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,
    )


582
# InternVL
583
def run_internvl(questions: list[str], modality: str) -> ModelRequestData:
584
    model_name = "OpenGVLab/InternVL3-2B"
585

586
    engine_args = EngineArgs(
587
588
        model=model_name,
        trust_remote_code=True,
589
        max_model_len=8192,
590
        limit_mm_per_prompt={modality: 1},
591
592
    )

593
594
595
596
597
    if modality == "image":
        placeholder = "<image>"
    elif modality == "video":
        placeholder = "<video>"

598
599
600
601
602
603
604
605
    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
    )
606
607
608
609
610
611
612

    # 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]
613
    stop_token_ids = [token_id for token_id in stop_token_ids if token_id is not None]
614
615
616
617
618
619

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
620
621


622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
# 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,
    )


653
654
655
656
657
658
659
# 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|>"
660
661
        "<|im_assistant|>assistant<|im_middle|>"
        for question in questions
662
663
664
665
666
    ]

    engine_args = EngineArgs(
        model="moonshotai/Kimi-VL-A3B-Instruct",
        trust_remote_code=True,
Cyrus Leung's avatar
Cyrus Leung committed
667
        max_model_len=4096,
668
        limit_mm_per_prompt={modality: 1},
669
670
671
672
673
674
675
676
    )

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


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
709
710
711
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,
    )


712
# LLaVA-1.5
713
def run_llava(questions: list[str], modality: str) -> ModelRequestData:
714
    assert modality == "image"
715

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

718
719
720
    engine_args = EngineArgs(
        model="llava-hf/llava-1.5-7b-hf",
        max_model_len=4096,
721
        limit_mm_per_prompt={modality: 1},
722
723
724
725
726
727
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
728
729
730


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

734
    prompts = [f"[INST] <image>\n{question} [/INST]" for question in questions]
735
736
737
    engine_args = EngineArgs(
        model="llava-hf/llava-v1.6-mistral-7b-hf",
        max_model_len=8192,
738
        limit_mm_per_prompt={modality: 1},
739
740
741
742
743
744
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
745
746
747
748


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

752
    prompts = [f"USER: <video>\n{question} ASSISTANT:" for question in questions]
753
754
755
    engine_args = EngineArgs(
        model="llava-hf/LLaVA-NeXT-Video-7B-hf",
        max_model_len=8192,
756
        max_num_seqs=2,
757
        limit_mm_per_prompt={modality: 1},
758
759
760
761
762
763
    )

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


766
# LLaVA-OneVision
767
def run_llava_onevision(questions: list[str], modality: str) -> ModelRequestData:
768
    if modality == "video":
769
770
        prompts = [
            f"<|im_start|>user <video>\n{question}<|im_end|> \
771
772
        <|im_start|>assistant\n"
            for question in questions
773
        ]
774
775

    elif modality == "image":
776
777
        prompts = [
            f"<|im_start|>user <image>\n{question}<|im_end|> \
778
779
        <|im_start|>assistant\n"
            for question in questions
780
        ]
781

782
783
784
    engine_args = EngineArgs(
        model="llava-hf/llava-onevision-qwen2-7b-ov-hf",
        max_model_len=16384,
785
        limit_mm_per_prompt={modality: 1},
786
787
788
789
790
791
    )

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


794
# Mantis
795
def run_mantis(questions: list[str], modality: str) -> ModelRequestData:
796
    assert modality == "image"
797

798
799
    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]
800

801
    engine_args = EngineArgs(
802
        model="TIGER-Lab/Mantis-8B-siglip-llama3",
803
        max_model_len=4096,
804
        hf_overrides={"architectures": ["MantisForConditionalGeneration"]},
805
        limit_mm_per_prompt={modality: 1},
806
    )
807
    stop_token_ids = [128009]
808
809
810
811
812
813

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
814
815
816


# MiniCPM-V
817
def run_minicpmv_base(questions: list[str], modality: str, model_name):
818
819
    assert modality in ["image", "video"]
    # If you want to use `MiniCPM-o-2_6` with audio inputs, check `audio_language.py` # noqa
820
821
822
823
824
825
826

    # 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
827
828
    # model_name = "openbmb/MiniCPM-Llama3-V-2_5"

829
    # 2.6
830
831
832
833
834
835
836
837
838
    # 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"
839
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
840
    engine_args = EngineArgs(
841
        model=model_name,
842
843
        max_model_len=4096,
        max_num_seqs=2,
844
        trust_remote_code=True,
845
        limit_mm_per_prompt={modality: 1},
846
    )
847
848
849
850
851
852
853
    # 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]

854
    # 2.6 / o2.6
855
    stop_tokens = ["<|im_end|>", "<|endoftext|>"]
856
    stop_token_ids = [tokenizer.convert_tokens_to_ids(i) for i in stop_tokens]
857

858
859
860
861
862
    modality_placeholder = {
        "image": "(<image>./</image>)",
        "video": "(<video>./</video>)",
    }

863
864
    prompts = [
        tokenizer.apply_chat_template(
865
866
867
868
869
870
            [
                {
                    "role": "user",
                    "content": f"{modality_placeholder[modality]}\n{question}",
                }
            ],
871
            tokenize=False,
872
873
874
            add_generation_prompt=True,
        )
        for question in questions
875
    ]
876
877
878
879
880
881

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
882
883


884
def run_minicpmo(questions: list[str], modality: str) -> ModelRequestData:
885
    return run_minicpmv_base(questions, modality, "openbmb/MiniCPM-o-2_6")
886
887


888
def run_minicpmv(questions: list[str], modality: str) -> ModelRequestData:
889
    return run_minicpmv_base(questions, modality, "openbmb/MiniCPM-V-2_6")
890
891


892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
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,
    )


925
926
927
928
929
930
931
932
933
934
935
936
# 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,
937
        limit_mm_per_prompt={modality: 1},
938
        ignore_patterns=["consolidated.safetensors"],
939
940
941
942
943
944
945
946
947
948
    )

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

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


949
# LLama 3.2
950
def run_mllama(questions: list[str], modality: str) -> ModelRequestData:
951
952
    assert modality == "image"

953
    model_name = "meta-llama/Llama-3.2-11B-Vision-Instruct"
954

955
956
957
958
959
    # Note: The default setting of max_num_seqs (256) and
    # max_model_len (131072) for this model may cause OOM.
    # You may lower either to run this example on lower-end GPUs.

    # The configuration below has been confirmed to launch on a single L40 GPU.
960
    engine_args = EngineArgs(
961
        model=model_name,
962
        max_model_len=8192,
963
        max_num_seqs=2,
964
        limit_mm_per_prompt={modality: 1},
965
966
    )

967
    tokenizer = AutoTokenizer.from_pretrained(model_name)
968
969
970
971
972
973
974
975
976
977
978
979
    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
    )
980
981
982
983
984

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


987
988
# Molmo
def run_molmo(questions: list[str], modality: str) -> ModelRequestData:
989
990
    assert modality == "image"

991
    model_name = "allenai/Molmo-7B-D-0924"
992
993
994

    engine_args = EngineArgs(
        model=model_name,
995
996
        trust_remote_code=True,
        dtype="bfloat16",
997
        limit_mm_per_prompt={modality: 1},
998
999
    )

1000
1001
1002
    prompts = [
        f"<|im_start|>user <image>\n{question}<|im_end|> \
        <|im_start|>assistant\n"
1003
1004
        for question in questions
    ]
1005

1006
1007
1008
1009
1010
1011
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


1012
1013
1014
# Nemontron_VL
def run_nemotron_vl(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "nvidia/Llama-3.1-Nemotron-Nano-VL-8B-V1"
1015

1016
    engine_args = EngineArgs(
1017
        model=model_name,
1018
        trust_remote_code=True,
1019
        max_model_len=8192,
1020
        limit_mm_per_prompt={modality: 1},
1021
    )
1022

1023
1024
1025
1026
1027
1028
    assert modality == "image"
    placeholder = "<image>"

    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
    messages = [
        [{"role": "user", "content": f"{placeholder}\n{question}"}]
1029
        for question in questions
1030
    ]
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
    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]
1042
1043
1044
1045

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
1046
        stop_token_ids=stop_token_ids,
1047
    )
1048
1049


1050
# NVLM-D
1051
def run_nvlm_d(questions: list[str], modality: str) -> ModelRequestData:
1052
1053
1054
1055
1056
    assert modality == "image"

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

    # Adjust this as necessary to fit in GPU
1057
    engine_args = EngineArgs(
1058
1059
1060
1061
        model=model_name,
        trust_remote_code=True,
        max_model_len=4096,
        tensor_parallel_size=4,
1062
        limit_mm_per_prompt={modality: 1},
1063
1064
    )

1065
1066
1067
1068
1069
1070
1071
    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
    )
1072
1073
1074
1075
1076

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


1079
1080
# Ovis
def run_ovis(questions: list[str], modality: str) -> ModelRequestData:
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
    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",
1091
        limit_mm_per_prompt={modality: 1},
1092
1093
    )

1094
1095
1096
1097
1098
1099
1100
    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
    )
1101
1102
1103
1104
1105
1106
1107

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


1108
# PaliGemma
1109
def run_paligemma(questions: list[str], modality: str) -> ModelRequestData:
1110
    assert modality == "image"
1111

1112
    # PaliGemma has special prompt format for VQA
1113
1114
1115
    prompts = ["caption en" for _ in questions]
    engine_args = EngineArgs(
        model="google/paligemma-3b-mix-224",
1116
        limit_mm_per_prompt={modality: 1},
1117
    )
1118
1119
1120
1121
1122

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


1125
# PaliGemma 2
1126
def run_paligemma2(questions: list[str], modality: str) -> ModelRequestData:
1127
    assert modality == "image"
1128

1129
    # PaliGemma 2 has special prompt format for VQA
1130
1131
1132
    prompts = ["caption en" for _ in questions]
    engine_args = EngineArgs(
        model="google/paligemma2-3b-ft-docci-448",
1133
        limit_mm_per_prompt={modality: 1},
1134
    )
1135
1136
1137
1138
1139

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


1142
# Phi-3-Vision
1143
def run_phi3v(questions: list[str], modality: str) -> ModelRequestData:
1144
1145
    assert modality == "image"

1146
1147
1148
1149
    prompts = [
        f"<|user|>\n<|image_1|>\n{question}<|end|>\n<|assistant|>\n"
        for question in questions
    ]
1150

1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
    # 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
1163
    engine_args = EngineArgs(
1164
1165
        model="microsoft/Phi-3.5-vision-instruct",
        trust_remote_code=True,
1166
        max_model_len=4096,
1167
        max_num_seqs=2,
1168
        # Note - mm_processor_kwargs can also be passed to generate/chat calls
1169
        mm_processor_kwargs={"num_crops": 16},
1170
        limit_mm_per_prompt={modality: 1},
1171
    )
1172
1173
1174
1175
1176

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


1179
# Phi-4-multimodal-instruct
1180
def run_phi4mm(questions: list[str], modality: str) -> ModelRequestData:
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
    """
    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 = [
1191
        f"<|user|><|image_1|>{question}<|end|><|assistant|>" for question in questions
1192
    ]
1193
    engine_args = EngineArgs(
1194
1195
        model=model_path,
        trust_remote_code=True,
1196
        max_model_len=5120,
1197
        max_num_seqs=2,
1198
        max_num_batched_tokens=12800,
1199
1200
        enable_lora=True,
        max_lora_rank=320,
1201
1202
        # Note - mm_processor_kwargs can also be passed to generate/chat calls
        mm_processor_kwargs={"dynamic_hd": 16},
1203
        limit_mm_per_prompt={modality: 1},
1204
1205
    )

1206
1207
1208
1209
1210
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        lora_requests=[LoRARequest("vision", 1, vision_lora_path)],
    )
1211
1212


1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
# 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)],
    )


1248
# Pixtral HF-format
1249
def run_pixtral_hf(questions: list[str], modality: str) -> ModelRequestData:
1250
1251
1252
1253
    assert modality == "image"

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

1254
    # NOTE: Need L40 (or equivalent) to avoid OOM
1255
    engine_args = EngineArgs(
1256
        model=model_name,
1257
        max_model_len=6144,
1258
        max_num_seqs=2,
1259
        limit_mm_per_prompt={modality: 1},
1260
1261
    )

1262
    prompts = [f"<s>[INST]{question}\n[IMG][/INST]" for question in questions]
1263
1264
1265
1266
1267

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


1270
# Qwen-VL
1271
def run_qwen_vl(questions: list[str], modality: str) -> ModelRequestData:
1272
1273
    assert modality == "image"

1274
    engine_args = EngineArgs(
1275
        model="Qwen/Qwen-VL",
1276
        trust_remote_code=True,
1277
1278
        max_model_len=1024,
        max_num_seqs=2,
1279
        hf_overrides={"architectures": ["QwenVLForConditionalGeneration"]},
1280
        limit_mm_per_prompt={modality: 1},
1281
1282
    )

1283
    prompts = [f"{question}Picture 1: <img></img>\n" for question in questions]
1284
1285
1286
1287
1288

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


1291
# Qwen2-VL
1292
def run_qwen2_vl(questions: list[str], modality: str) -> ModelRequestData:
1293
    model_name = "Qwen/Qwen2-VL-7B-Instruct"
1294

1295
    engine_args = EngineArgs(
1296
        model=model_name,
1297
1298
1299
        max_model_len=4096,
        max_num_seqs=5,
        # Note - mm_processor_kwargs can also be passed to generate/chat calls
1300
        mm_processor_kwargs={
1301
1302
            "min_pixels": 28 * 28,
            "max_pixels": 1280 * 28 * 28,
1303
        },
1304
        limit_mm_per_prompt={modality: 1},
1305
    )
1306

1307
1308
1309
1310
1311
    if modality == "image":
        placeholder = "<|image_pad|>"
    elif modality == "video":
        placeholder = "<|video_pad|>"

1312
    prompts = [
1313
1314
1315
1316
1317
1318
1319
        (
            "<|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
1320
    ]
1321
1322
1323
1324
1325

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


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

1332
    engine_args = EngineArgs(
Roger Wang's avatar
Roger Wang committed
1333
1334
1335
1336
1337
1338
1339
1340
        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,
        },
1341
        limit_mm_per_prompt={modality: 1},
Roger Wang's avatar
Roger Wang committed
1342
1343
1344
1345
1346
1347
1348
    )

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

1349
    prompts = [
1350
1351
1352
1353
1354
1355
1356
        (
            "<|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
1357
    ]
1358
1359
1360
1361
1362

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
Roger Wang's avatar
Roger Wang committed
1363
1364


1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
# 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],
        },
1378
        limit_mm_per_prompt={modality: 1},
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
    )

    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 "
1389
1390
        "generating text and speech."
    )
1391

1392
1393
1394
1395
1396
1397
1398
1399
1400
    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
    ]
1401
1402
1403
1404
1405
1406
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


1407
1408
# SkyworkR1V
def run_skyworkr1v(questions: list[str], modality: str) -> ModelRequestData:
1409
    assert modality == "image"
1410
1411

    model_name = "Skywork/Skywork-R1V-38B"
1412
1413
1414
1415
1416
1417
1418

    engine_args = EngineArgs(
        model=model_name,
        trust_remote_code=True,
        max_model_len=4096,
        limit_mm_per_prompt={modality: 1},
    )
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431

    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]
1432
1433
1434
1435

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
1436
        stop_token_ids=stop_token_ids,
1437
1438
1439
    )


1440
1441
1442
1443
# SmolVLM2-2.2B-Instruct
def run_smolvlm(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"
    model_name = "HuggingFaceTB/SmolVLM2-2.2B-Instruct"
1444
1445
1446

    engine_args = EngineArgs(
        model=model_name,
1447
1448
1449
1450
1451
1452
        max_model_len=8192,
        max_num_seqs=2,
        enforce_eager=True,
        mm_processor_kwargs={
            "max_image_size": {"longest_edge": 384},
        },
1453
1454
        limit_mm_per_prompt={modality: 1},
    )
1455
1456
1457
1458
    prompts = [
        (f"<|im_start|>User:<image>{question}<end_of_utterance>\nAssistant:")
        for question in questions
    ]
1459

1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
    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",
    )
1482
1483

    prompts = [
1484
1485
        "<|begin▁of▁sentence|> You are a helpful assistant. <|BOT|>user\n "
        f"<im_patch>{question} <|EOT|><|BOT|>assistant\n<think>\n"
1486
1487
1488
1489
1490
1491
1492
1493
1494
        for question in questions
    ]

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


1495
1496
# omni-research/Tarsier-7b
def run_tarsier(questions: list[str], modality: str) -> ModelRequestData:
1497
    assert modality == "image"
1498
    model_name = "omni-research/Tarsier-7b"
1499
1500
1501
1502
1503

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

1508
1509
1510
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
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

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
    ]
1538
1539
1540
1541
1542
1543
1544

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


1545
model_example_map = {
1546
    "aria": run_aria,
Jennifer Zhao's avatar
Jennifer Zhao committed
1547
    "aya_vision": run_aya_vision,
1548
1549
    "blip-2": run_blip2,
    "chameleon": run_chameleon,
1550
    "command_a_vision": run_command_a_vision,
1551
    "deepseek_vl_v2": run_deepseek_vl2,
1552
    "florence2": run_florence2,
1553
    "fuyu": run_fuyu,
1554
    "gemma3": run_gemma3,
Nicolò Lucchesi's avatar
Nicolò Lucchesi committed
1555
    "gemma3n": run_gemma3n,
1556
    "glm4v": run_glm4v,
1557
    "glm4_1v": run_glm4_1v,
1558
1559
    "glm4_5v": run_glm4_5v,
    "glm4_5v_fp8": run_glm4_5v_fp8,
1560
    "h2ovl_chat": run_h2ovl,
1561
    "hyperclovax_seed_vision": run_hyperclovax_seed_vision,
1562
    "idefics3": run_idefics3,
Lyu Han's avatar
Lyu Han committed
1563
    "interns1": run_interns1,
1564
    "internvl_chat": run_internvl,
1565
    "keye_vl": run_keye_vl,
1566
    "kimi_vl": run_kimi_vl,
1567
    "llama4": run_llama4,
1568
1569
    "llava": run_llava,
    "llava-next": run_llava_next,
1570
    "llava-next-video": run_llava_next_video,
1571
    "llava-onevision": run_llava_onevision,
1572
    "mantis": run_mantis,
1573
    "minicpmo": run_minicpmo,
1574
    "minicpmv": run_minicpmv,
1575
    "minimax_vl_01": run_minimax_vl_01,
1576
    "mistral3": run_mistral3,
1577
1578
    "mllama": run_mllama,
    "molmo": run_molmo,
1579
    "nemotron_vl": run_nemotron_vl,
1580
    "NVLM_D": run_nvlm_d,
1581
    "ovis": run_ovis,
1582
1583
1584
    "paligemma": run_paligemma,
    "paligemma2": run_paligemma2,
    "phi3_v": run_phi3v,
1585
    "phi4_mm": run_phi4mm,
1586
    "phi4_multimodal": run_phi4_multimodal,
1587
    "pixtral_hf": run_pixtral_hf,
1588
    "qwen_vl": run_qwen_vl,
1589
    "qwen2_vl": run_qwen2_vl,
Roger Wang's avatar
Roger Wang committed
1590
    "qwen2_5_vl": run_qwen2_5_vl,
1591
    "qwen2_5_omni": run_qwen2_5_omni,
1592
    "skywork_chat": run_skyworkr1v,
1593
    "smolvlm": run_smolvlm,
1594
    "step3": run_step3,
汪志鹏's avatar
汪志鹏 committed
1595
    "tarsier": run_tarsier,
1596
    "tarsier2": run_tarsier2,
1597
1598
1599
}


1600
1601
1602
1603
1604
1605
1606
1607
1608
def get_multi_modal_input(args):
    """
    return {
        "data": image or video,
        "question": question,
    }
    """
    if args.modality == "image":
        # Input image and question
1609
        image = convert_image_mode(ImageAsset("cherry_blossom").pil_image, "RGB")
1610
1611
1612
1613
1614
1615
        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?",
        ]
1616
1617
1618

        return {
            "data": image,
1619
            "questions": img_questions,
1620
1621
1622
1623
        }

    if args.modality == "video":
        # Input video and question
1624
        video = VideoAsset(name="baby_reading", num_frames=args.num_frames).np_ndarrays
1625
        metadata = VideoAsset(name="baby_reading", num_frames=args.num_frames).metadata
1626
        vid_questions = ["Why is this video funny?"]
1627
1628

        return {
1629
            "data": [(video, metadata)] if args.model_type == "glm4_1v" else video,
1630
            "questions": vid_questions,
1631
1632
1633
1634
1635
1636
        }

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


1637
1638
1639
1640
def apply_image_repeat(
    image_repeat_prob, num_prompts, data, prompts: list[str], modality
):
    """Repeats images with provided probability of "image_repeat_prob".
1641
1642
    Used to simulate hit/miss for the MM preprocessor cache.
    """
1643
    assert image_repeat_prob <= 1.0 and image_repeat_prob >= 0
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
    no_yes = [0, 1]
    probs = [1.0 - image_repeat_prob, image_repeat_prob]

    inputs = []
    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)

1658
1659
1660
1661
        inputs.append(
            {
                "prompt": prompts[i % len(prompts)],
                "multi_modal_data": {modality: cur_image},
1662
            }
1663
        )
1664
1665
1666
1667

    return inputs


1668
1669
1670
1671
@contextmanager
def time_counter(enable: bool):
    if enable:
        import time
1672

1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
        start_time = time.time()
        yield
        elapsed_time = time.time() - start_time
        print("-" * 50)
        print("-- generate time = {}".format(elapsed_time))
        print("-" * 50)
    else:
        yield


1683
1684
def parse_args():
    parser = FlexibleArgumentParser(
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
        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`.",
    )
1718
1719

    parser.add_argument(
1720
        "--image-repeat-prob",
1721
1722
        type=float,
        default=None,
1723
1724
        help="Simulates the hit-ratio for multi-modal preprocessor cache (if enabled)",
    )
1725
1726

    parser.add_argument(
1727
        "--disable-mm-processor-cache",
1728
        action="store_true",
1729
        help="If True, disables caching of multi-modal processor.",
1730
    )
1731
1732

    parser.add_argument(
1733
1734
1735
1736
        "--time-generate",
        action="store_true",
        help="If True, then print the total generate() call time",
    )
1737
1738

    parser.add_argument(
1739
1740
1741
1742
1743
        "--use-different-prompt-per-request",
        action="store_true",
        help="If True, then use different prompt (with the same multi-modal "
        "data) for each request.",
    )
1744
1745
1746
    return parser.parse_args()


1747
1748
1749
1750
1751
def main(args):
    model = args.model_type
    if model not in model_example_map:
        raise ValueError(f"Model type {model} is not supported.")

1752
1753
1754
    modality = args.modality
    mm_input = get_multi_modal_input(args)
    data = mm_input["data"]
1755
    questions = mm_input["questions"]
1756

1757
1758
    req_data = model_example_map[model](questions, modality)

1759
1760
1761
    # 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(
1762
1763
        req_data.engine_args.limit_mm_per_prompt or {}
    )
1764
1765
1766

    engine_args = asdict(req_data.engine_args) | {
        "seed": args.seed,
1767
        "mm_processor_cache_gb": 0 if args.disable_mm_processor_cache else 4,
1768
    }
1769
1770
    llm = LLM(**engine_args)

1771
    # Don't want to check the flag multiple times, so just hijack `prompts`.
1772
1773
1774
1775
1776
    prompts = (
        req_data.prompts
        if args.use_different_prompt_per_request
        else [req_data.prompts[0]]
    )
1777
1778
1779

    # We set temperature to 0.2 so that outputs can be different
    # even when all prompts are identical when running batch inference.
1780
1781
1782
    sampling_params = SamplingParams(
        temperature=0.2, max_tokens=64, stop_token_ids=req_data.stop_token_ids
    )
1783
1784
1785
1786
1787

    assert args.num_prompts > 0
    if args.num_prompts == 1:
        # Single inference
        inputs = {
1788
            "prompt": prompts[0],
1789
            "multi_modal_data": {modality: data},
1790
1791
1792
        }
    else:
        # Batch inference
1793
1794
        if args.image_repeat_prob is not None:
            # Repeat images with specified probability of "image_repeat_prob"
1795
1796
1797
            inputs = apply_image_repeat(
                args.image_repeat_prob, args.num_prompts, data, prompts, modality
            )
1798
1799
        else:
            # Use the same image for all prompts
1800
1801
1802
1803
1804
1805
1806
            inputs = [
                {
                    "prompt": prompts[i % len(prompts)],
                    "multi_modal_data": {modality: data},
                }
                for i in range(args.num_prompts)
            ]
1807

1808
    # Add LoRA request if applicable
1809
1810
1811
    lora_request = (
        req_data.lora_requests * args.num_prompts if req_data.lora_requests else None
    )
1812

1813
1814
1815
1816
1817
1818
    with time_counter(args.time_generate):
        outputs = llm.generate(
            inputs,
            sampling_params=sampling_params,
            lora_request=lora_request,
        )
1819

1820
    print("-" * 50)
1821
1822
1823
    for o in outputs:
        generated_text = o.outputs[0].text
        print(generated_text)
1824
        print("-" * 50)
1825
1826
1827


if __name__ == "__main__":
1828
    args = parse_args()
1829
    main(args)