vision_language.py 66.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
from transformers import AutoProcessor, AutoTokenizer
19

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
from vllm.utils.argparse_utils import FlexibleArgumentParser
26

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
    sampling_params: list[SamplingParams] | None = None
34
35


36
37
38
39
# 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.

40

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

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

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

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

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


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

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=2048,
        max_num_seqs=2,
        mm_processor_kwargs={"crop_to_patches": True},
82
        limit_mm_per_prompt={modality: 1},
Jennifer Zhao's avatar
Jennifer Zhao committed
83
84
85
86
87
88
89
90
91
92
93
    )
    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,
    )


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


121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
def run_bagel(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"
    model_name = "ByteDance-Seed/BAGEL-7B-MoT"

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

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

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


147
# BLIP-2
148
def run_blip2(questions: list[str], modality: str) -> ModelRequestData:
149
150
151
152
    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
153
    prompts = [f"Question: {question} Answer:" for question in questions]
154
    engine_args = EngineArgs(
155
        model="Salesforce/blip2-opt-2.7b",
156
        limit_mm_per_prompt={modality: 1},
157
158
159
160
161
162
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
163
164
165


# Chameleon
166
def run_chameleon(questions: list[str], modality: str) -> ModelRequestData:
167
168
    assert modality == "image"

169
    prompts = [f"{question}<image>" for question in questions]
170
171
172
173
    engine_args = EngineArgs(
        model="facebook/chameleon-7b",
        max_model_len=4096,
        max_num_seqs=2,
174
        limit_mm_per_prompt={modality: 1},
175
176
177
178
179
180
    )

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


183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
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,
    )


206
# Deepseek-VL2
207
def run_deepseek_vl2(questions: list[str], modality: str) -> ModelRequestData:
208
209
    assert modality == "image"

210
    model_name = "deepseek-ai/deepseek-vl2-tiny"
211

212
213
214
215
216
    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=2,
        hf_overrides={"architectures": ["DeepseekVLV2ForCausalLM"]},
217
        limit_mm_per_prompt={modality: 1},
218
    )
219

220
    prompts = [
221
        f"<|User|>: <image>\n{question}\n\n<|Assistant|>:" for question in questions
222
    ]
223
224
225
226
227

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


230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
def run_deepseek_ocr(questions: list[str], modality: str) -> ModelRequestData:
    from vllm.model_executor.models.deepseek_ocr import NGramPerReqLogitsProcessor

    assert modality == "image"

    model_name = "deepseek-ai/DeepSeek-OCR"

    engine_args = EngineArgs(
        model=model_name,
        limit_mm_per_prompt={modality: 1},
        logits_processors=[NGramPerReqLogitsProcessor],
    )

    # deepseek-ocr use plain prompt template
    prompts = [f"<image>\n{question}" for question in questions]

    # The following sampling params config is taken from
    # the official Deepseek-OCR inference example.
    # (IMPORTANT) Use the custom logits processor and avoid skipping
    # special tokens for this model for the optimal OCR performance.
    sampling_params = [
        SamplingParams(
            temperature=0.0,
            max_tokens=8192,
            # ngram logit processor args
            extra_args=dict(
                ngram_size=30,
                window_size=90,
                # whitelist: <td>, </td>
                whitelist_token_ids={128821, 128822},
            ),
            skip_special_tokens=False,
        )
        for _ in questions
    ]

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


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


290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
# Eagle2.5-VL
def run_eagle2_5(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"

    model_name = "nvidia/Eagle2.5-8B"

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

    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 Eagle2.5 (Qwen2 based)
    stop_tokens = ["<|endoftext|>", "<|im_start|>", "<|im_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]

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


324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
# 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,
    )


355
# Fuyu
356
def run_fuyu(questions: list[str], modality: str) -> ModelRequestData:
357
358
    assert modality == "image"

359
    prompts = [f"{question}\n" for question in questions]
360
361
362
363
    engine_args = EngineArgs(
        model="adept/fuyu-8b",
        max_model_len=2048,
        max_num_seqs=2,
364
        limit_mm_per_prompt={modality: 1},
365
366
367
368
369
370
    )

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


373
# Gemma 3
374
def run_gemma3(questions: list[str], modality: str) -> ModelRequestData:
375
376
377
    assert modality == "image"
    model_name = "google/gemma-3-4b-it"

378
    engine_args = EngineArgs(
379
380
381
        model=model_name,
        max_model_len=2048,
        max_num_seqs=2,
382
        mm_processor_kwargs={"do_pan_and_scan": True},
383
        limit_mm_per_prompt={modality: 1},
384
    )
385

386
387
388
389
390
391
392
393
    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
394
395
396
397
398
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )

399

Nicolò Lucchesi's avatar
Nicolò Lucchesi committed
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
# 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
    ]
421
422
423
424
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
425
426


427
# GLM-4v
428
def run_glm4v(questions: list[str], modality: str) -> ModelRequestData:
429
    assert modality == "image"
430
    model_name = "zai-org/glm-4v-9b"
431

432
433
434
435
436
437
438
    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"]},
439
        limit_mm_per_prompt={modality: 1},
440
    )
441

442
    prompts = [
443
444
445
446
        (
            "<|user|>\n<|begin_of_image|><|endoftext|><|end_of_image|>"
            f"{question}<|assistant|>"
        )
447
        for question in questions
448
    ]
449

450
    stop_token_ids = [151329, 151336, 151338]
451
452
453
454
455
456

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
457
458


459
460
# GLM-4.1V
def run_glm4_1v(questions: list[str], modality: str) -> ModelRequestData:
461
    model_name = "zai-org/GLM-4.1V-9B-Thinking"
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

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


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


569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
# GLM-OCR
def run_glm_ocr(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "zai-org/GLM-OCR"

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


605
# H2OVL-Mississippi
606
def run_h2ovl(questions: list[str], modality: str) -> ModelRequestData:
607
608
    assert modality == "image"

609
    model_name = "h2oai/h2ovl-mississippi-800m"
610

611
    engine_args = EngineArgs(
612
613
614
        model=model_name,
        trust_remote_code=True,
        max_model_len=8192,
615
        limit_mm_per_prompt={modality: 1},
616
617
    )

618
619
620
621
622
623
624
    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
    )
625
626

    # Stop tokens for H2OVL-Mississippi
627
    # https://huggingface.co/h2oai/h2ovl-mississippi-800m
628
    stop_token_ids = [tokenizer.eos_token_id]
629
630
631
632
633
634

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
635
636


637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
# HunyuanOCR
def run_hunyuan_vl(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"

    model_name = "tencent/HunyuanOCR"

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

    placeholder = "<|hy_place▁holder▁no▁100|><|hy_place▁holder▁no▁102|><|hy_place▁holder▁no▁101|>"  # noqa: E501
    prompts = [
        f"<|hy_begin▁of▁sentence|>{placeholder}{question}<|hy_User|>"
        for question in questions
    ]

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


662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
# 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":
            """
680
681
            ocr: List the words in the image in raster order.
                Even if the word order feels unnatural for reading,
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
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
740
                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,
    )


741
# Idefics3-8B-Llama3
742
def run_idefics3(questions: list[str], modality: str) -> ModelRequestData:
743
744
745
    assert modality == "image"
    model_name = "HuggingFaceM4/Idefics3-8B-Llama3"

746
    engine_args = EngineArgs(
747
748
749
750
751
752
753
        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={
754
            "size": {"longest_edge": 3 * 364},
755
        },
756
        limit_mm_per_prompt={modality: 1},
757
    )
758
759
760
761
    prompts = [
        (f"<|begin_of_text|>User:<image>{question}<end_of_utterance>\nAssistant:")
        for question in questions
    ]
762
763
764
765
766

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


Lyu Han's avatar
Lyu Han committed
769
770
# Intern-S1
def run_interns1(questions: list[str], modality: str) -> ModelRequestData:
771
    model_name = "internlm/Intern-S1-mini"
Lyu Han's avatar
Lyu Han committed
772
773
774
775
776
777
778
779
780
781

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

782
783
784
785
786
    if modality == "image":
        placeholder = "<IMG_CONTEXT>"
    elif modality == "video":
        placeholder = "<video>"

Lyu Han's avatar
Lyu Han committed
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
    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,
    )


802
# InternVL
803
def run_internvl(questions: list[str], modality: str) -> ModelRequestData:
804
    model_name = "OpenGVLab/InternVL3-2B"
805

806
    engine_args = EngineArgs(
807
808
        model=model_name,
        trust_remote_code=True,
809
        max_model_len=8192,
810
        limit_mm_per_prompt={modality: 1},
811
812
    )

813
814
815
816
817
    if modality == "image":
        placeholder = "<image>"
    elif modality == "video":
        placeholder = "<video>"

818
819
820
821
822
823
824
825
    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
    )
826
827
828
829
830
831
832

    # 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]
833
    stop_token_ids = [token_id for token_id in stop_token_ids if token_id is not None]
834
835
836
837
838
839

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
840
841


842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
# Kanana-V
def run_kanana_v(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"

    model_name = "kakaocorp/kanana-1.5-v-3b-instruct"

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

    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
    )

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


869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
# 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,
    )


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
925
926
927
928
929
930
# 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,
    )


931
932
933
934
935
936
937
# 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|>"
938
939
        "<|im_assistant|>assistant<|im_middle|>"
        for question in questions
940
941
942
943
944
    ]

    engine_args = EngineArgs(
        model="moonshotai/Kimi-VL-A3B-Instruct",
        trust_remote_code=True,
Cyrus Leung's avatar
Cyrus Leung committed
945
        max_model_len=4096,
946
        limit_mm_per_prompt={modality: 1},
947
948
949
950
951
952
953
954
    )

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


955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
# 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,
    )


975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
def run_lfm2_vl(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"

    model_name = "LiquidAI/LFM2-VL-450M"

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

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

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


1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
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,
    )


1041
# LLaVA-1.5
1042
def run_llava(questions: list[str], modality: str) -> ModelRequestData:
1043
    assert modality == "image"
1044

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

1047
1048
1049
    engine_args = EngineArgs(
        model="llava-hf/llava-1.5-7b-hf",
        max_model_len=4096,
1050
        limit_mm_per_prompt={modality: 1},
1051
1052
1053
1054
1055
1056
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
1057
1058
1059


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

1063
    prompts = [f"[INST] <image>\n{question} [/INST]" for question in questions]
1064
1065
1066
    engine_args = EngineArgs(
        model="llava-hf/llava-v1.6-mistral-7b-hf",
        max_model_len=8192,
1067
        limit_mm_per_prompt={modality: 1},
1068
1069
1070
1071
1072
1073
    )

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


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

1081
    prompts = [f"USER: <video>\n{question} ASSISTANT:" for question in questions]
1082
1083
1084
    engine_args = EngineArgs(
        model="llava-hf/LLaVA-NeXT-Video-7B-hf",
        max_model_len=8192,
1085
        max_num_seqs=2,
1086
        limit_mm_per_prompt={modality: 1},
1087
1088
1089
1090
1091
1092
    )

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


1095
# LLaVA-OneVision
1096
def run_llava_onevision(questions: list[str], modality: str) -> ModelRequestData:
1097
    if modality == "video":
1098
        prompts = [
1099
            f"<|im_start|>user <video>\n{question}<|im_end|><|im_start|>assistant\n"
1100
            for question in questions
1101
        ]
1102
1103

    elif modality == "image":
1104
        prompts = [
1105
            f"<|im_start|>user <image>\n{question}<|im_end|><|im_start|>assistant\n"
1106
            for question in questions
1107
        ]
1108

1109
1110
1111
    engine_args = EngineArgs(
        model="llava-hf/llava-onevision-qwen2-7b-ov-hf",
        max_model_len=16384,
1112
        limit_mm_per_prompt={modality: 1},
1113
1114
1115
1116
1117
1118
    )

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


1121
# Mantis
1122
def run_mantis(questions: list[str], modality: str) -> ModelRequestData:
1123
    assert modality == "image"
1124

1125
1126
    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]
1127

1128
    engine_args = EngineArgs(
1129
        model="TIGER-Lab/Mantis-8B-siglip-llama3",
1130
        max_model_len=4096,
1131
        hf_overrides={"architectures": ["MantisForConditionalGeneration"]},
1132
        limit_mm_per_prompt={modality: 1},
1133
    )
1134
    stop_token_ids = [128009]
1135
1136
1137
1138
1139
1140

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
1141
1142
1143


# MiniCPM-V
1144
def run_minicpmv_base(questions: list[str], modality: str, model_name):
1145
1146
    assert modality in ["image", "video"]
    # If you want to use `MiniCPM-o-2_6` with audio inputs, check `audio_language.py` # noqa
1147
1148
1149
1150
1151
1152
1153

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

1156
    # 2.6
1157
1158
1159
1160
1161
1162
1163
1164
1165
    # 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"
1166
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
1167
    engine_args = EngineArgs(
1168
        model=model_name,
1169
1170
        max_model_len=4096,
        max_num_seqs=2,
1171
        trust_remote_code=True,
1172
        limit_mm_per_prompt={modality: 1},
1173
    )
1174
1175
1176
1177
1178
1179
1180
    # 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]

1181
    # 2.6 / o2.6
1182
    stop_tokens = ["<|im_end|>", "<|endoftext|>"]
1183
    stop_token_ids = [tokenizer.convert_tokens_to_ids(i) for i in stop_tokens]
1184

1185
1186
1187
1188
1189
    modality_placeholder = {
        "image": "(<image>./</image>)",
        "video": "(<video>./</video>)",
    }

1190
1191
    prompts = [
        tokenizer.apply_chat_template(
1192
1193
1194
1195
1196
1197
            [
                {
                    "role": "user",
                    "content": f"{modality_placeholder[modality]}\n{question}",
                }
            ],
1198
            tokenize=False,
1199
1200
1201
            add_generation_prompt=True,
        )
        for question in questions
1202
    ]
1203
1204
1205
1206
1207
1208

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        stop_token_ids=stop_token_ids,
    )
1209
1210


1211
def run_minicpmo(questions: list[str], modality: str) -> ModelRequestData:
1212
    return run_minicpmv_base(questions, modality, "openbmb/MiniCPM-o-2_6")
1213
1214


1215
def run_minicpmv(questions: list[str], modality: str) -> ModelRequestData:
1216
    return run_minicpmv_base(questions, modality, "openbmb/MiniCPM-V-2_6")
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
1248
1249
1250
1251
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,
    )


1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
# 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,
1264
        limit_mm_per_prompt={modality: 1},
1265
        ignore_patterns=["consolidated.safetensors"],
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
    )

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

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


1276
1277
# Molmo
def run_molmo(questions: list[str], modality: str) -> ModelRequestData:
1278
1279
    assert modality == "image"

1280
    model_name = "allenai/Molmo-7B-D-0924"
1281
1282
1283

    engine_args = EngineArgs(
        model=model_name,
1284
1285
        trust_remote_code=True,
        dtype="bfloat16",
1286
        limit_mm_per_prompt={modality: 1},
1287
1288
    )

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

1294
1295
1296
1297
1298
1299
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


1300
1301
1302
1303
1304
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
# Molmo2
def run_molmo2(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "allenai/Molmo2-8B"

    engine_args = EngineArgs(
        model=model_name,
        trust_remote_code=True,
        dtype="bfloat16",
        limit_mm_per_prompt={modality: 1},
        max_num_batched_tokens=36864,
    )

    if modality == "image":
        placeholder = "<|image|>"
    elif modality == "video":
        placeholder = "<|video|>"
    else:
        raise ValueError(f"Unsupported modality for molmo2: {modality}")

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

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


1330
1331
1332
# Nemontron_VL
def run_nemotron_vl(questions: list[str], modality: str) -> ModelRequestData:
    model_name = "nvidia/Llama-3.1-Nemotron-Nano-VL-8B-V1"
1333

1334
    engine_args = EngineArgs(
1335
        model=model_name,
1336
        trust_remote_code=True,
1337
        max_model_len=8192,
1338
        limit_mm_per_prompt={modality: 1},
1339
    )
1340

1341
1342
1343
1344
1345
1346
    assert modality == "image"
    placeholder = "<image>"

    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
    messages = [
        [{"role": "user", "content": f"{placeholder}\n{question}"}]
1347
        for question in questions
1348
    ]
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
    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]
1360
1361
1362
1363

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
1364
        stop_token_ids=stop_token_ids,
1365
    )
1366
1367


1368
# NVLM-D
1369
def run_nvlm_d(questions: list[str], modality: str) -> ModelRequestData:
1370
1371
1372
1373
1374
    assert modality == "image"

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

    # Adjust this as necessary to fit in GPU
1375
    engine_args = EngineArgs(
1376
1377
1378
1379
        model=model_name,
        trust_remote_code=True,
        max_model_len=4096,
        tensor_parallel_size=4,
1380
        limit_mm_per_prompt={modality: 1},
1381
1382
    )

1383
1384
1385
1386
1387
1388
1389
    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
    )
1390
1391
1392
1393
1394

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


1397
1398
# Ovis
def run_ovis(questions: list[str], modality: str) -> ModelRequestData:
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
    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",
1409
        limit_mm_per_prompt={modality: 1},
1410
1411
    )

1412
1413
1414
1415
1416
1417
1418
    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
    )
1419
1420
1421
1422
1423
1424
1425

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


1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
# 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>"

1443
1444
    prompts = [
        f"<|im_start|>user\n\n{placeholder}\n{question}<|im_end|>\n<|im_start|>assistant\n"
1445
1446
1447
1448
1449
1450
1451
1452
1453
        for question in questions
    ]

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


1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
# PaddleOCR-VL
def run_paddleocr_vl(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"

    model_name = "PaddlePaddle/PaddleOCR-VL"

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

    placeholder = "<|IMAGE_START|><|IMAGE_PLACEHOLDER|><|IMAGE_END|>"
    prompts = [
        (f"<|begin_of_sentence|>User: {question}{placeholder}\nAssistant: ")
        for question in questions
    ]

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


1480
# PaliGemma
1481
def run_paligemma(questions: list[str], modality: str) -> ModelRequestData:
1482
    assert modality == "image"
1483

1484
    # PaliGemma has special prompt format for VQA
1485
1486
1487
    prompts = ["caption en" for _ in questions]
    engine_args = EngineArgs(
        model="google/paligemma-3b-mix-224",
1488
        limit_mm_per_prompt={modality: 1},
1489
    )
1490
1491
1492
1493
1494

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


1497
# PaliGemma 2
1498
def run_paligemma2(questions: list[str], modality: str) -> ModelRequestData:
1499
    assert modality == "image"
1500

1501
    # PaliGemma 2 has special prompt format for VQA
1502
1503
1504
    prompts = ["caption en" for _ in questions]
    engine_args = EngineArgs(
        model="google/paligemma2-3b-ft-docci-448",
1505
        limit_mm_per_prompt={modality: 1},
1506
    )
1507
1508
1509
1510
1511

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


1514
# Phi-3-Vision
1515
def run_phi3v(questions: list[str], modality: str) -> ModelRequestData:
1516
1517
    assert modality == "image"

1518
1519
1520
1521
    prompts = [
        f"<|user|>\n<|image_1|>\n{question}<|end|>\n<|assistant|>\n"
        for question in questions
    ]
1522

1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
    # 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
1535
    engine_args = EngineArgs(
1536
1537
        model="microsoft/Phi-3.5-vision-instruct",
        trust_remote_code=True,
1538
        max_model_len=4096,
1539
        max_num_seqs=2,
1540
        # Note - mm_processor_kwargs can also be passed to generate/chat calls
1541
        mm_processor_kwargs={"num_crops": 16},
1542
        limit_mm_per_prompt={modality: 1},
1543
    )
1544
1545
1546
1547
1548

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


1551
# Phi-4-multimodal-instruct
1552
def run_phi4mm(questions: list[str], modality: str) -> ModelRequestData:
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
    """
    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 = [
1563
        f"<|user|><|image_1|>{question}<|end|><|assistant|>" for question in questions
1564
    ]
1565
    engine_args = EngineArgs(
1566
1567
        model=model_path,
        trust_remote_code=True,
1568
        max_model_len=5120,
1569
        max_num_seqs=2,
1570
        max_num_batched_tokens=12800,
1571
1572
        enable_lora=True,
        max_lora_rank=320,
1573
1574
        # Note - mm_processor_kwargs can also be passed to generate/chat calls
        mm_processor_kwargs={"dynamic_hd": 16},
1575
        limit_mm_per_prompt={modality: 1},
1576
1577
    )

1578
1579
1580
1581
1582
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
        lora_requests=[LoRARequest("vision", 1, vision_lora_path)],
    )
1583
1584


1585
# Pixtral HF-format
1586
def run_pixtral_hf(questions: list[str], modality: str) -> ModelRequestData:
1587
1588
1589
1590
    assert modality == "image"

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

1591
    # NOTE: Need L40 (or equivalent) to avoid OOM
1592
    engine_args = EngineArgs(
1593
        model=model_name,
1594
        max_model_len=6144,
1595
        max_num_seqs=2,
1596
        limit_mm_per_prompt={modality: 1},
1597
1598
    )

1599
    prompts = [f"<s>[INST]{question}\n[IMG][/INST]" for question in questions]
1600
1601
1602
1603
1604

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


1607
# Qwen-VL
1608
def run_qwen_vl(questions: list[str], modality: str) -> ModelRequestData:
1609
1610
    assert modality == "image"

1611
    engine_args = EngineArgs(
1612
        model="Qwen/Qwen-VL",
1613
        trust_remote_code=True,
1614
1615
        max_model_len=1024,
        max_num_seqs=2,
1616
        hf_overrides={"architectures": ["QwenVLForConditionalGeneration"]},
1617
        limit_mm_per_prompt={modality: 1},
1618
1619
    )

1620
    prompts = [f"{question}Picture 1: <img></img>\n" for question in questions]
1621
1622
1623
1624
1625

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


1628
# Qwen2-VL
1629
def run_qwen2_vl(questions: list[str], modality: str) -> ModelRequestData:
1630
    model_name = "Qwen/Qwen2-VL-7B-Instruct"
1631

1632
    engine_args = EngineArgs(
1633
        model=model_name,
1634
1635
1636
        max_model_len=4096,
        max_num_seqs=5,
        # Note - mm_processor_kwargs can also be passed to generate/chat calls
1637
        mm_processor_kwargs={
1638
1639
            "min_pixels": 28 * 28,
            "max_pixels": 1280 * 28 * 28,
1640
        },
1641
        limit_mm_per_prompt={modality: 1},
1642
    )
1643

1644
1645
1646
1647
1648
    if modality == "image":
        placeholder = "<|image_pad|>"
    elif modality == "video":
        placeholder = "<|video_pad|>"

1649
    prompts = [
1650
1651
1652
1653
1654
1655
1656
        (
            "<|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
1657
    ]
1658
1659
1660
1661
1662

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


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

1669
    engine_args = EngineArgs(
Roger Wang's avatar
Roger Wang committed
1670
1671
1672
1673
1674
1675
1676
1677
        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,
        },
1678
        limit_mm_per_prompt={modality: 1},
Roger Wang's avatar
Roger Wang committed
1679
1680
1681
1682
1683
1684
1685
    )

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

1686
    prompts = [
1687
1688
1689
1690
1691
1692
1693
        (
            "<|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
1694
    ]
1695
1696
1697
1698
1699

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )
Roger Wang's avatar
Roger Wang committed
1700
1701


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
# 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,
1713
            "fps": 1,
1714
        },
1715
        limit_mm_per_prompt={modality: 1},
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
    )

    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 "
1726
1727
        "generating text and speech."
    )
1728

1729
1730
1731
1732
1733
1734
1735
1736
1737
    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
    ]
1738
1739
1740
1741
1742
1743
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
    )


1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
# 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,
    )


1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
# 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,
    )


1840
1841
# SkyworkR1V
def run_skyworkr1v(questions: list[str], modality: str) -> ModelRequestData:
1842
    assert modality == "image"
1843
1844

    model_name = "Skywork/Skywork-R1V-38B"
1845
1846
1847
1848
1849
1850
1851

    engine_args = EngineArgs(
        model=model_name,
        trust_remote_code=True,
        max_model_len=4096,
        limit_mm_per_prompt={modality: 1},
    )
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864

    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]
1865
1866
1867
1868

    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
1869
        stop_token_ids=stop_token_ids,
1870
1871
1872
    )


1873
1874
1875
1876
# SmolVLM2-2.2B-Instruct
def run_smolvlm(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"
    model_name = "HuggingFaceTB/SmolVLM2-2.2B-Instruct"
1877
1878
1879

    engine_args = EngineArgs(
        model=model_name,
1880
1881
1882
1883
1884
1885
        max_model_len=8192,
        max_num_seqs=2,
        enforce_eager=True,
        mm_processor_kwargs={
            "max_image_size": {"longest_edge": 384},
        },
1886
1887
        limit_mm_per_prompt={modality: 1},
    )
1888
1889
1890
1891
    prompts = [
        (f"<|im_start|>User:<image>{question}<end_of_utterance>\nAssistant:")
        for question in questions
    ]
1892

1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
    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",
    )
1915
1916

    prompts = [
1917
1918
        "<|begin▁of▁sentence|> You are a helpful assistant. <|BOT|>user\n "
        f"<im_patch>{question} <|EOT|><|BOT|>assistant\n<think>\n"
1919
1920
1921
1922
1923
1924
1925
1926
1927
        for question in questions
    ]

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


1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
# StepVL10B
def run_step_vl(questions: list[str], modality: str) -> ModelRequestData:
    assert modality == "image"

    model_name = "stepfun-ai/Step3-VL-10B"
    engine_args = EngineArgs(
        model=model_name,
        max_num_batched_tokens=4096,
        tensor_parallel_size=1,
        trust_remote_code=True,
        limit_mm_per_prompt={modality: 1},
        reasoning_parser="deepseek_r1",
    )

    prompts = [
        "<|begin▁of▁sentence|> You are a helpful assistant.<|BOT|>user\n "
        f"<im_patch>{question} <|EOT|><|BOT|>assistant\n<think>\n"
        for question in questions
    ]

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


1954
1955
# omni-research/Tarsier-7b
def run_tarsier(questions: list[str], modality: str) -> ModelRequestData:
1956
    assert modality == "image"
1957
    model_name = "omni-research/Tarsier-7b"
1958
1959
1960
1961
1962

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

1967
1968
1969
    return ModelRequestData(
        engine_args=engine_args,
        prompts=prompts,
1970
    )
1971

1972
1973
1974
1975
1976
1977
1978

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,
1979
1980
1981
1982
        hf_overrides={
            "architectures": ["Tarsier2ForConditionalGeneration"],
            "model_type": "tarsier2",
        },
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
        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
    ]
2000
2001
2002
2003
2004
2005
2006

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


2007
model_example_map = {
2008
    "aria": run_aria,
Jennifer Zhao's avatar
Jennifer Zhao committed
2009
    "aya_vision": run_aya_vision,
2010
    "bagel": run_bagel,
2011
    "bee": run_bee,
2012
2013
    "blip-2": run_blip2,
    "chameleon": run_chameleon,
2014
    "command_a_vision": run_command_a_vision,
2015
    "deepseek_vl_v2": run_deepseek_vl2,
2016
2017
    "deepseek_ocr": run_deepseek_ocr,
    "dots_ocr": run_dots_ocr,
2018
    "eagle2_5": run_eagle2_5,
2019
    "ernie45_vl": run_ernie45_vl,
2020
    "fuyu": run_fuyu,
2021
    "gemma3": run_gemma3,
Nicolò Lucchesi's avatar
Nicolò Lucchesi committed
2022
    "gemma3n": run_gemma3n,
2023
    "glm4v": run_glm4v,
2024
    "glm4_1v": run_glm4_1v,
2025
2026
    "glm4_5v": run_glm4_5v,
    "glm4_5v_fp8": run_glm4_5v_fp8,
2027
    "glm_ocr": run_glm_ocr,
2028
    "h2ovl_chat": run_h2ovl,
2029
    "hunyuan_vl": run_hunyuan_vl,
2030
    "hyperclovax_seed_vision": run_hyperclovax_seed_vision,
2031
    "idefics3": run_idefics3,
Lyu Han's avatar
Lyu Han committed
2032
    "interns1": run_interns1,
2033
    "internvl_chat": run_internvl,
2034
    "kanana_v": run_kanana_v,
2035
    "keye_vl": run_keye_vl,
2036
    "keye_vl1_5": run_keye_vl1_5,
2037
    "kimi_vl": run_kimi_vl,
2038
    "lightonocr": run_lightonocr,
2039
    "lfm2_vl": run_lfm2_vl,
2040
    "llama4": run_llama4,
2041
2042
    "llava": run_llava,
    "llava-next": run_llava_next,
2043
    "llava-next-video": run_llava_next_video,
2044
    "llava-onevision": run_llava_onevision,
2045
    "mantis": run_mantis,
2046
    "minicpmo": run_minicpmo,
2047
    "minicpmv": run_minicpmv,
2048
    "minimax_vl_01": run_minimax_vl_01,
2049
    "mistral3": run_mistral3,
2050
    "molmo": run_molmo,
2051
    "molmo2": run_molmo2,
2052
    "nemotron_vl": run_nemotron_vl,
2053
    "NVLM_D": run_nvlm_d,
2054
    "ovis": run_ovis,
2055
    "ovis2_5": run_ovis2_5,
2056
    "paddleocr_vl": run_paddleocr_vl,
2057
2058
2059
    "paligemma": run_paligemma,
    "paligemma2": run_paligemma2,
    "phi3_v": run_phi3v,
2060
    "phi4_mm": run_phi4mm,
2061
    "pixtral_hf": run_pixtral_hf,
2062
    "qwen_vl": run_qwen_vl,
2063
    "qwen2_vl": run_qwen2_vl,
Roger Wang's avatar
Roger Wang committed
2064
    "qwen2_5_vl": run_qwen2_5_vl,
2065
    "qwen2_5_omni": run_qwen2_5_omni,
2066
2067
    "qwen3_vl": run_qwen3_vl,
    "qwen3_vl_moe": run_qwen3_vl_moe,
2068
    "rvl": run_r_vl,
2069
    "skywork_chat": run_skyworkr1v,
2070
    "smolvlm": run_smolvlm,
2071
    "step3": run_step3,
2072
    "stepvl": run_step_vl,
汪志鹏's avatar
汪志鹏 committed
2073
    "tarsier": run_tarsier,
2074
    "tarsier2": run_tarsier2,
2075
2076
2077
}


2078
2079
MODELS_NEED_VIDEO_METADATA = [
    "glm4_1v",
2080
    "glm_ocr",
2081
2082
    "glm4_5v",
    "glm4_5v_fp8",
2083
    "molmo2",
2084
2085
    "qwen3_vl",
    "qwen3_vl_moe",
2086
2087
2088
]


2089
2090
2091
2092
2093
2094
2095
2096
2097
def get_multi_modal_input(args):
    """
    return {
        "data": image or video,
        "question": question,
    }
    """
    if args.modality == "image":
        # Input image and question
2098
        image = convert_image_mode(ImageAsset("cherry_blossom").pil_image, "RGB")
2099
2100
2101
2102
2103
2104
        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?",
        ]
2105
2106
2107

        return {
            "data": image,
2108
            "questions": img_questions,
2109
2110
2111
2112
        }

    if args.modality == "video":
        # Input video and question
2113
        needs_metadata = args.model_type in MODELS_NEED_VIDEO_METADATA
2114
        video = VideoAsset(name="baby_reading", num_frames=args.num_frames).np_ndarrays
2115
        metadata = VideoAsset(name="baby_reading", num_frames=args.num_frames).metadata
2116
        vid_questions = ["Why is this video funny?"]
2117
2118

        return {
2119
            "data": ([(video, metadata)] if needs_metadata else video),
2120
            "questions": vid_questions,
2121
2122
2123
2124
2125
2126
        }

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


2127
2128
2129
2130
def apply_image_repeat(
    image_repeat_prob, num_prompts, data, prompts: list[str], modality
):
    """Repeats images with provided probability of "image_repeat_prob".
2131
2132
    Used to simulate hit/miss for the MM preprocessor cache.
    """
2133
    assert image_repeat_prob <= 1.0 and image_repeat_prob >= 0
2134
2135
2136
2137
    no_yes = [0, 1]
    probs = [1.0 - image_repeat_prob, image_repeat_prob]

    inputs = []
2138
    inputs_with_empty_media = []
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
    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)

2149
2150
        uuid = "uuid_{}".format(i)

2151
2152
2153
2154
        inputs.append(
            {
                "prompt": prompts[i % len(prompts)],
                "multi_modal_data": {modality: cur_image},
2155
2156
2157
2158
2159
2160
2161
2162
2163
                "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},
2164
            }
2165
        )
2166

2167
    return inputs, inputs_with_empty_media
2168
2169


2170
2171
2172
2173
@contextmanager
def time_counter(enable: bool):
    if enable:
        import time
2174

2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
        start_time = time.time()
        yield
        elapsed_time = time.time() - start_time
        print("-" * 50)
        print("-- generate time = {}".format(elapsed_time))
        print("-" * 50)
    else:
        yield


2185
2186
def parse_args():
    parser = FlexibleArgumentParser(
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
        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,
2217
        default=0,
2218
2219
        help="Set the seed when initializing `vllm.LLM`.",
    )
2220
2221

    parser.add_argument(
2222
        "--image-repeat-prob",
2223
2224
        type=float,
        default=None,
2225
2226
        help="Simulates the hit-ratio for multi-modal preprocessor cache (if enabled)",
    )
2227
2228

    parser.add_argument(
2229
        "--disable-mm-processor-cache",
2230
        action="store_true",
2231
        help="If True, disables caching of multi-modal processor.",
2232
    )
2233
2234

    parser.add_argument(
2235
2236
2237
2238
        "--time-generate",
        action="store_true",
        help="If True, then print the total generate() call time",
    )
2239
2240

    parser.add_argument(
2241
2242
2243
2244
2245
        "--use-different-prompt-per-request",
        action="store_true",
        help="If True, then use different prompt (with the same multi-modal "
        "data) for each request.",
    )
2246
2247
2248
2249
2250
2251
2252

    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.",
    )
2253
2254
2255
2256
2257
2258
2259
    parser.add_argument(
        "--tensor-parallel-size",
        "-tp",
        type=int,
        default=None,
        help="Tensor parallel size to override the model's default setting. ",
    )
2260
2261
2262
    return parser.parse_args()


2263
2264
2265
2266
2267
def main(args):
    model = args.model_type
    if model not in model_example_map:
        raise ValueError(f"Model type {model} is not supported.")

2268
2269
2270
2271
2272
2273
    if args.tensor_parallel_size is not None and args.tensor_parallel_size < 1:
        raise ValueError(
            f"tensor_parallel_size must be a positive integer, "
            f"got {args.tensor_parallel_size}"
        )

2274
2275
2276
    modality = args.modality
    mm_input = get_multi_modal_input(args)
    data = mm_input["data"]
2277
    questions = mm_input["questions"]
2278

2279
2280
    req_data = model_example_map[model](questions, modality)

2281
2282
2283
    # 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(
2284
2285
        req_data.engine_args.limit_mm_per_prompt or {}
    )
2286
2287
2288

    engine_args = asdict(req_data.engine_args) | {
        "seed": args.seed,
2289
        "mm_processor_cache_gb": 0 if args.disable_mm_processor_cache else 4,
2290
    }
2291
2292
    if args.tensor_parallel_size is not None:
        engine_args["tensor_parallel_size"] = args.tensor_parallel_size
2293
2294
    llm = LLM(**engine_args)

2295
    # Don't want to check the flag multiple times, so just hijack `prompts`.
2296
2297
2298
2299
2300
    prompts = (
        req_data.prompts
        if args.use_different_prompt_per_request
        else [req_data.prompts[0]]
    )
2301
2302
2303

    # We set temperature to 0.2 so that outputs can be different
    # even when all prompts are identical when running batch inference.
2304
2305
2306
2307
2308
2309
    sampling_params = (
        SamplingParams(
            temperature=0.2, max_tokens=64, stop_token_ids=req_data.stop_token_ids
        )
        if req_data.sampling_params is None
        else req_data.sampling_params
2310
    )
2311
2312
2313
2314

    assert args.num_prompts > 0
    if args.num_prompts == 1:
        # Single inference
2315
        uuid = "uuid_0"
2316
        inputs = {
2317
            "prompt": prompts[0],
2318
            "multi_modal_data": {modality: data},
2319
2320
2321
2322
2323
2324
            "multi_modal_uuids": {modality: uuid},
        }
        inputs_with_empty_media = {
            "prompt": prompts[0],
            "multi_modal_data": {modality: None},
            "multi_modal_uuids": {modality: uuid},
2325
2326
2327
        }
    else:
        # Batch inference
2328
2329
        if args.image_repeat_prob is not None:
            # Repeat images with specified probability of "image_repeat_prob"
2330
2331
2332
2333
2334
2335
            inputs, inputs_with_empty_media = apply_image_repeat(
                args.image_repeat_prob,
                args.num_prompts,
                data,
                prompts,
                modality,
2336
            )
2337
2338
        else:
            # Use the same image for all prompts
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
            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},
                    }
                )
2357

2358
    # Add LoRA request if applicable
2359
2360
2361
    lora_request = (
        req_data.lora_requests * args.num_prompts if req_data.lora_requests else None
    )
2362

2363
2364
2365
2366
2367
2368
    with time_counter(args.time_generate):
        outputs = llm.generate(
            inputs,
            sampling_params=sampling_params,
            lora_request=lora_request,
        )
2369

2370
    print("-" * 50)
2371
2372
2373
    for o in outputs:
        generated_text = o.outputs[0].text
        print(generated_text)
2374
        print("-" * 50)
2375

2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
    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}")

2396
2397

if __name__ == "__main__":
2398
    args = parse_args()
2399
    main(args)