vision_language_multi_image.py 51.1 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3
4
"""
This example shows how to use vLLM for running offline inference with
Cyrus Leung's avatar
Cyrus Leung committed
5
6
multi-image input on vision language models for text generation,
using the chat template defined by the model.
7
"""
8

9
import os
10
from argparse import Namespace
11
from typing import NamedTuple
12

13
from huggingface_hub import snapshot_download
14
from PIL.Image import Image
15
from transformers import AutoProcessor, AutoTokenizer
16

17
from vllm import LLM, EngineArgs, SamplingParams
18
from vllm.lora.request import LoRARequest
19
from vllm.multimodal.utils import fetch_image
20
from vllm.utils.argparse_utils import FlexibleArgumentParser
21
22
23

QUESTION = "What is the content of each image?"
IMAGE_URLS = [
24
25
26
27
28
29
30
31
32
33
34
35
    "https://vllm-public-assets.s3.us-west-2.amazonaws.com/multimodal_asset/duck.jpg",
    "https://vllm-public-assets.s3.us-west-2.amazonaws.com/multimodal_asset/lion.jpg",
    "https://vllm-public-assets.s3.us-west-2.amazonaws.com/multimodal_asset/flycatcher.jpeg",
    "https://vllm-public-assets.s3.us-west-2.amazonaws.com/multimodal_asset/somefish.jpg",
    "https://vllm-public-assets.s3.us-west-2.amazonaws.com/multimodal_asset/starfish.jpg",
    "https://vllm-public-assets.s3.us-west-2.amazonaws.com/multimodal_asset/snail.jpg",
    "https://vllm-public-assets.s3.us-west-2.amazonaws.com/multimodal_asset/thistle.jpg",
    "https://vllm-public-assets.s3.us-west-2.amazonaws.com/multimodal_asset/husky.jpg",
    "https://vllm-public-assets.s3.us-west-2.amazonaws.com/multimodal_asset/orangetabbycat.jpg",
    "https://vllm-public-assets.s3.us-west-2.amazonaws.com/multimodal_asset/guineapig.jpg",
    "https://vllm-public-assets.s3.us-west-2.amazonaws.com/multimodal_asset/rabbit.jpg",
    "https://vllm-public-assets.s3.us-west-2.amazonaws.com/multimodal_asset/horsepony.jpg",
36
37
38
]


39
class ModelRequestData(NamedTuple):
40
    engine_args: EngineArgs
41
    prompt: str
42
    image_data: list[Image]
43
44
45
    stop_token_ids: list[int] | None = None
    chat_template: str | None = None
    lora_requests: list[LoRARequest] | None = None
46
    sampling_params: SamplingParams | None = None
47
48


49
50
51
52
53
# 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.


54
def load_aria(question: str, image_urls: list[str]) -> ModelRequestData:
55
    model_name = "rhymes-ai/Aria"
56
57
58
59
60
61
62
    engine_args = EngineArgs(
        model=model_name,
        tokenizer_mode="slow",
        trust_remote_code=True,
        dtype="bfloat16",
        limit_mm_per_prompt={"image": len(image_urls)},
    )
63
    placeholders = "<fim_prefix><|img|><fim_suffix>\n" * len(image_urls)
64
65
66
    prompt = (
        f"<|im_start|>user\n{placeholders}{question}<|im_end|>\n<|im_start|>assistant\n"
    )
67
    stop_token_ids = [93532, 93653, 944, 93421, 1019, 93653, 93519]
68

69
    return ModelRequestData(
70
        engine_args=engine_args,
71
72
73
        prompt=prompt,
        stop_token_ids=stop_token_ids,
        image_data=[fetch_image(url) for url in image_urls],
74
    )
75

76

Jennifer Zhao's avatar
Jennifer Zhao committed
77
def load_aya_vision(question: str, image_urls: list[str]) -> ModelRequestData:
78
    model_name = "CohereLabs/aya-vision-8b"
Jennifer Zhao's avatar
Jennifer Zhao committed
79
80
81
82
83
84
85
86

    engine_args = EngineArgs(
        model=model_name,
        max_num_seqs=2,
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
87
88
89
90
91
92
93
94
95
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        }
    ]
Jennifer Zhao's avatar
Jennifer Zhao committed
96
97
98

    processor = AutoProcessor.from_pretrained(model_name)

99
100
101
    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
Jennifer Zhao's avatar
Jennifer Zhao committed
102
103
104
105
106
107
108
109

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
def load_bee(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "Open-Bee/Bee-8B-RL"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=16384,
        max_num_seqs=16,
        limit_mm_per_prompt={"image": len(image_urls)},
        trust_remote_code=True,
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        }
    ]

    processor = AutoProcessor.from_pretrained(model_name, trust_remote_code=True)

    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
def load_command_a_vision(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "CohereLabs/command-a-vision-07-2025"

    # NOTE: This model is 122B parameters and requires tensor parallelism
    # Recommended to use tp=4 on H100 GPUs
    engine_args = EngineArgs(
        model=model_name,
        max_model_len=32768,
        tensor_parallel_size=4,
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        }
    ]

    processor = AutoProcessor.from_pretrained(model_name)

    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


181
def load_deepseek_vl2(question: str, image_urls: list[str]) -> ModelRequestData:
182
    model_name = "deepseek-ai/deepseek-vl2-tiny"
183

184
185
186
187
188
189
190
    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=2,
        hf_overrides={"architectures": ["DeepseekVLV2ForCausalLM"]},
        limit_mm_per_prompt={"image": len(image_urls)},
    )
191

192
193
194
    placeholder = "".join(
        f"image_{i}:<image>\n" for i, _ in enumerate(image_urls, start=1)
    )
195
196
197
    prompt = f"<|User|>: {placeholder}{question}\n\n<|Assistant|>:"

    return ModelRequestData(
198
        engine_args=engine_args,
199
200
201
202
203
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
def load_deepseek_ocr(question: str, image_urls: list[str]) -> ModelRequestData:
    from vllm.model_executor.models.deepseek_ocr import NGramPerReqLogitsProcessor

    model_name = "deepseek-ai/DeepSeek-OCR"

    engine_args = EngineArgs(
        model=model_name,
        max_num_seqs=2,
        limit_mm_per_prompt={"image": len(image_urls)},
        logits_processors=[NGramPerReqLogitsProcessor],
    )

    placeholder = "<image>\n" * len(image_urls)
    prompt = placeholder + question

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

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
        sampling_params=sampling_params,
    )


Kyungmin Lee's avatar
Kyungmin Lee committed
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
# exaone4_5
def load_exaone4_5(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "LGAI-EXAONE/EXAONE-4.5-33B"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=8192,
        max_num_seqs=2,
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        }
    ]

    processor = AutoProcessor.from_pretrained(model_name)

    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


279
def load_gemma3(question: str, image_urls: list[str]) -> ModelRequestData:
280
281
    model_name = "google/gemma-3-4b-it"

282
    engine_args = EngineArgs(
283
284
285
286
287
        model=model_name,
        max_model_len=8192,
        max_num_seqs=2,
        limit_mm_per_prompt={"image": len(image_urls)},
    )
288
289

    placeholders = [{"type": "image", "image": url} for url in image_urls]
290
291
292
293
294
295
296
297
298
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        }
    ]
299
300
301

    processor = AutoProcessor.from_pretrained(model_name)

302
303
304
    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
305
306

    return ModelRequestData(
307
        engine_args=engine_args,
308
309
310
311
312
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
def load_granite4_vision(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "ibm-granite/granite-vision-4.1-4b"
    engine_args = EngineArgs(
        model=model_name,
        max_model_len=4096,
        max_num_seqs=16,
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        }
    ]

    processor = AutoProcessor.from_pretrained(model_name)
    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


345
def load_h2ovl(question: str, image_urls: list[str]) -> ModelRequestData:
346
    model_name = "h2oai/h2ovl-mississippi-800m"
347

348
    engine_args = EngineArgs(
349
350
351
352
        model=model_name,
        trust_remote_code=True,
        max_model_len=8192,
        limit_mm_per_prompt={"image": len(image_urls)},
353
        mm_processor_kwargs={"max_dynamic_patch": 4},
354
355
    )

356
357
358
359
    placeholders = "\n".join(
        f"Image-{i}: <image>\n" for i, _ in enumerate(image_urls, start=1)
    )
    messages = [{"role": "user", "content": f"{placeholders}\n{question}"}]
360

361
362
363
364
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
    prompt = tokenizer.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
365
366

    # Stop tokens for H2OVL-Mississippi
367
    # https://huggingface.co/h2oai/h2ovl-mississippi-800m
368
369
370
    stop_token_ids = [tokenizer.eos_token_id]

    return ModelRequestData(
371
        engine_args=engine_args,
372
373
374
375
376
377
        prompt=prompt,
        stop_token_ids=stop_token_ids,
        image_data=[fetch_image(url) for url in image_urls],
    )


378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
# HunyuanOCR
def load_hunyuan_vl(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "tencent/HunyuanOCR"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=8192,
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholder = (
        "<|hy_place▁holder▁no▁100|><|hy_place▁holder▁no▁102|><|hy_place▁holder▁no▁101|>"  # noqa: E501
    ) * len(image_urls)
    prompt = f"<|hy_begin▁of▁sentence|>{placeholder}{question}<|hy_User|>"

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


400
401
402
403
404
def load_hyperclovax_seed_vision(
    question: str, image_urls: list[str]
) -> ModelRequestData:
    model_name = "naver-hyperclovax/HyperCLOVAX-SEED-Vision-Instruct-3B"
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
405

406
    engine_args = EngineArgs(
407
        model=model_name,
408
409
        trust_remote_code=True,
        max_model_len=16384,
410
411
412
        limit_mm_per_prompt={"image": len(image_urls)},
    )

413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
    message = {"role": "user", "content": list()}
    for _image_url in image_urls:
        message["content"].append(
            {
                "type": "image",
                "image": _image_url,
                "ocr": "",
                "lens_keywords": "",
                "lens_local_keywords": "",
            }
        )
    message["content"].append(
        {
            "type": "text",
            "text": question,
        }
429
    )
430
431
432
433
434
435
436
437
438

    prompt = tokenizer.apply_chat_template(
        [
            message,
        ],
        tokenize=False,
        add_generation_prompt=True,
    )

439
    return ModelRequestData(
440
        engine_args=engine_args,
441
        prompt=prompt,
442
        stop_token_ids=None,
443
444
445
446
        image_data=[fetch_image(url) for url in image_urls],
    )


447
448
def load_idefics3(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "HuggingFaceM4/Idefics3-8B-Llama3"
449
450
451
452
453
454
455
456

    # The configuration below has been confirmed to launch on a single L40 GPU.
    engine_args = EngineArgs(
        model=model_name,
        max_model_len=8192,
        max_num_seqs=16,
        enforce_eager=True,
        limit_mm_per_prompt={"image": len(image_urls)},
457
458
        # if you are running out of memory, you can reduce the "longest_edge".
        # see: https://huggingface.co/HuggingFaceM4/Idefics3-8B-Llama3#model-optimizations
459
        mm_processor_kwargs={
460
            "size": {"longest_edge": 2 * 364},
461
462
463
        },
    )

464
465
466
    placeholders = "\n".join(
        f"Image-{i}: <image>\n" for i, _ in enumerate(image_urls, start=1)
    )
467
    prompt = f"<|begin_of_text|>User:{placeholders}\n{question}<end_of_utterance>\nAssistant:"  # noqa: E501
468
469
470
471
472
473
474
    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


Lyu Han's avatar
Lyu Han committed
475
def load_interns1(question: str, image_urls: list[str]) -> ModelRequestData:
476
    model_name = "internlm/Intern-S1-mini"
Lyu Han's avatar
Lyu Han committed
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

    engine_args = EngineArgs(
        model=model_name,
        trust_remote_code=True,
        max_model_len=4096,
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = "\n".join(
        f"Image-{i}: <IMG_CONTEXT>\n" for i, _ in enumerate(image_urls, start=1)
    )
    messages = [{"role": "user", "content": f"{placeholders}\n{question}"}]

    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
    prompt = tokenizer.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


502
def load_internvl(question: str, image_urls: list[str]) -> ModelRequestData:
503
504
    model_name = "OpenGVLab/InternVL2-2B"

505
    engine_args = EngineArgs(
506
507
508
509
        model=model_name,
        trust_remote_code=True,
        max_model_len=4096,
        limit_mm_per_prompt={"image": len(image_urls)},
510
        mm_processor_kwargs={"max_dynamic_patch": 4},
511
512
    )

513
514
515
516
    placeholders = "\n".join(
        f"Image-{i}: <image>\n" for i, _ in enumerate(image_urls, start=1)
    )
    messages = [{"role": "user", "content": f"{placeholders}\n{question}"}]
517

518
519
520
521
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
    prompt = tokenizer.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
522
523
524
525

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

530
    return ModelRequestData(
531
        engine_args=engine_args,
532
533
534
535
        prompt=prompt,
        stop_token_ids=stop_token_ids,
        image_data=[fetch_image(url) for url in image_urls],
    )
536
537


538
539
def load_keye_vl(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "Kwai-Keye/Keye-VL-8B-Preview"
540

541
542
    engine_args = EngineArgs(
        model=model_name,
543
544
545
        trust_remote_code=True,
        max_model_len=8192,
        max_num_seqs=5,
546
547
548
549
550
551
552
553
554
555
556
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
557
        },
558
559
    ]

560
    processor = AutoProcessor.from_pretrained(model_name, trust_remote_code=True)
561
562
563
564
565

    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

566
567
    image_data = [fetch_image(url) for url in image_urls]

568
569
570
    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
571
        image_data=image_data,
572
573
574
    )


575
576
577
def load_keye_vl1_5(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "Kwai-Keye/Keye-VL-1_5-8B"

578
579
    engine_args = EngineArgs(
        model=model_name,
580
581
582
        trust_remote_code=True,
        max_model_len=32768,
        max_num_seqs=5,
583
584
585
586
587
588
589
590
591
592
593
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
594
        },
595
596
    ]

597
    processor = AutoProcessor.from_pretrained(model_name, trust_remote_code=True)
598
599
600
601
602

    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

603
604
    image_data = [fetch_image(url) for url in image_urls]

605
606
607
    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
608
        image_data=image_data,
609
610
611
    )


612
613
614
def load_kimi_vl(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "moonshotai/Kimi-VL-A3B-Instruct"

615
616
    engine_args = EngineArgs(
        model=model_name,
617
618
619
        trust_remote_code=True,
        max_model_len=4096,
        max_num_seqs=4,
620
621
622
623
624
625
626
627
628
629
630
631
632
633
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        }
    ]

634
    processor = AutoProcessor.from_pretrained(model_name, trust_remote_code=True)
635
636
637
638
639
640
641
642
643
644
645
646

    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


647
648
649
def load_llama4(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "meta-llama/Llama-4-Scout-17B-16E-Instruct"

650
651
    engine_args = EngineArgs(
        model=model_name,
652
653
        max_model_len=131072,
        tensor_parallel_size=8,
654
655
656
657
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
658
659
660
661
662
663
664
665
666
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        }
    ]
667
668
669

    processor = AutoProcessor.from_pretrained(model_name)

670
671
672
    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
673
674
675
676
677
678
679
680

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


681
682
683
684
def load_llava(question: str, image_urls: list[str]) -> ModelRequestData:
    # NOTE: CAUTION! Original Llava models wasn't really trained on multi-image inputs,
    # it will generate poor response for multi-image inputs!
    model_name = "llava-hf/llava-1.5-7b-hf"
685
686
    engine_args = EngineArgs(
        model=model_name,
687
        max_num_seqs=16,
688
689
690
691
692
693
694
695
696
697
698
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
699
        }
700
701
    ]

702
    processor = AutoProcessor.from_pretrained(model_name)
703
704
705
706
707
708
709
710

    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
711
        image_data=[fetch_image(url) for url in image_urls],
712
713
714
    )


715
716
def load_llava_next(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "llava-hf/llava-v1.6-mistral-7b-hf"
717
718
    engine_args = EngineArgs(
        model=model_name,
719
720
        max_model_len=8192,
        max_num_seqs=16,
721
722
723
724
725
726
727
728
729
730
731
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
732
        }
733
734
    ]

735
    processor = AutoProcessor.from_pretrained(model_name)
736
737
738
739
740
741
742
743

    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
744
        image_data=[fetch_image(url) for url in image_urls],
745
746
747
    )


748
749
def load_llava_onevision(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "llava-hf/llava-onevision-qwen2-7b-ov-hf"
750
751
    engine_args = EngineArgs(
        model=model_name,
752
753
        max_model_len=16384,
        max_num_seqs=16,
754
755
756
757
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
758
759
760
761
762
763
764
765
766
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        }
    ]
767

768
    processor = AutoProcessor.from_pretrained(model_name)
769

770
771
772
    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
773
774
775
776
777
778
779
780

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


781
782
783
784
785
786
787
788
789
790
def load_mistral3(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "mistralai/Mistral-Small-3.1-24B-Instruct-2503"

    # Adjust this as necessary to fit in GPU
    engine_args = EngineArgs(
        model=model_name,
        max_model_len=8192,
        max_num_seqs=2,
        tensor_parallel_size=2,
        limit_mm_per_prompt={"image": len(image_urls)},
791
        ignore_patterns=["consolidated.safetensors"],
792
793
794
795
796
797
798
799
800
801
802
803
    )

    placeholders = "[IMG]" * len(image_urls)
    prompt = f"<s>[INST]{question}\n{placeholders}[/INST]"

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


804
def load_nvlm_d(question: str, image_urls: list[str]) -> ModelRequestData:
805
806
807
    model_name = "nvidia/NVLM-D-72B"

    # Adjust this as necessary to fit in GPU
808
    engine_args = EngineArgs(
809
810
811
812
813
814
815
816
        model=model_name,
        trust_remote_code=True,
        max_model_len=8192,
        tensor_parallel_size=4,
        limit_mm_per_prompt={"image": len(image_urls)},
        mm_processor_kwargs={"max_dynamic_patch": 4},
    )

817
818
819
820
    placeholders = "\n".join(
        f"Image-{i}: <image>\n" for i, _ in enumerate(image_urls, start=1)
    )
    messages = [{"role": "user", "content": f"{placeholders}\n{question}"}]
821

822
823
824
825
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
    prompt = tokenizer.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
826
827

    return ModelRequestData(
828
        engine_args=engine_args,
829
830
831
832
833
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
# OpenPangu
def load_openpangu_vl(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "FreedomIntelligence/openPangu-VL-7B"

    engine_args = EngineArgs(
        model=model_name,
        trust_remote_code=True,
        max_model_len=8192,
        max_num_seqs=2,
        enforce_eager=True,
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = "[unused18][unused19][unused20]" * len(image_urls)
    prompt = (
        f"<s>[unused9]系统:[unused10][unused9]用户:{question}{placeholders}"
        "[unused10][unused9]助手:"
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


860
861
# Ovis
def load_ovis(question: str, image_urls: list[str]) -> ModelRequestData:
862
863
864
865
866
867
868
869
870
871
872
    model_name = "AIDC-AI/Ovis2-1B"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=8192,
        max_num_seqs=2,
        trust_remote_code=True,
        dtype="half",
        limit_mm_per_prompt={"image": len(image_urls)},
    )

873
874
875
876
    placeholders = "\n".join(
        f"Image-{i}: <image>\n" for i, _ in enumerate(image_urls, start=1)
    )
    messages = [{"role": "user", "content": f"{placeholders}\n{question}"}]
877

878
879
880
881
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
    prompt = tokenizer.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
882
883
884
885
886
887
888
889

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
# ovis2_5
def load_ovis2_5(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "AIDC-AI/Ovis2.5-2B"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=8192,
        max_num_seqs=2,
        trust_remote_code=True,
        dtype="half",
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = "\n".join(
        f"Image-{i}: <image>\n" for i, _ in enumerate(image_urls, start=1)
    )
906
907
908
    prompt = (
        f"<|im_start|>user\n\n{placeholders}\n{question}<|im_end|>\n"
        "<|im_start|>assistant\n"
909
910
911
912
913
914
915
916
917
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
def load_paddleocr_vl(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "PaddlePaddle/PaddleOCR-VL"

    engine_args = EngineArgs(
        model=model_name,
        trust_remote_code=True,
        max_model_len=8192,
        max_num_seqs=2,
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = "<|IMAGE_START|><|IMAGE_PLACEHOLDER|><|IMAGE_END|>" * len(image_urls)
    prompt = f"<|begin_of_sentence|>User: {question}{placeholders}\nAssistant: "

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


939
def load_pixtral_hf(question: str, image_urls: list[str]) -> ModelRequestData:
940
941
942
    model_name = "mistral-community/pixtral-12b"

    # Adjust this as necessary to fit in GPU
943
    engine_args = EngineArgs(
944
945
946
947
948
949
950
951
952
953
954
        model=model_name,
        max_model_len=8192,
        max_num_seqs=2,
        tensor_parallel_size=2,
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = "[IMG]" * len(image_urls)
    prompt = f"<s>[INST]{question}\n{placeholders}[/INST]"

    return ModelRequestData(
955
        engine_args=engine_args,
956
957
958
959
960
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


961
def load_phi3v(question: str, image_urls: list[str]) -> ModelRequestData:
962
963
964
965
966
967
968
969
970
971
972
973
    # 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
974
    engine_args = EngineArgs(
975
976
977
978
979
980
981
        model="microsoft/Phi-3.5-vision-instruct",
        trust_remote_code=True,
        max_model_len=4096,
        max_num_seqs=2,
        limit_mm_per_prompt={"image": len(image_urls)},
        mm_processor_kwargs={"num_crops": 4},
    )
982
983
984
    placeholders = "\n".join(
        f"<|image_{i}|>" for i, _ in enumerate(image_urls, start=1)
    )
985
986
987
    prompt = f"<|user|>\n{placeholders}\n{question}<|end|>\n<|assistant|>\n"

    return ModelRequestData(
988
        engine_args=engine_args,
989
990
991
992
993
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


994
995
996
997
998
999
1000
1001
1002
1003
def load_phi4mm(question: str, image_urls: list[str]) -> ModelRequestData:
    """
    Phi-4-multimodal-instruct supports both image and audio inputs. Here, we
    show how to process multi images inputs.
    """

    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")
1004
    engine_args = EngineArgs(
1005
1006
        model=model_path,
        trust_remote_code=True,
1007
        max_model_len=4096,
1008
1009
1010
1011
        max_num_seqs=2,
        limit_mm_per_prompt={"image": len(image_urls)},
        enable_lora=True,
        max_lora_rank=320,
1012
1013
        # Note - mm_processor_kwargs can also be passed to generate/chat calls
        mm_processor_kwargs={"dynamic_hd": 4},
1014
1015
    )

1016
    placeholders = "".join(f"<|image_{i}|>" for i, _ in enumerate(image_urls, start=1))
1017
1018
1019
    prompt = f"<|user|>{placeholders}{question}<|end|><|assistant|>"

    return ModelRequestData(
1020
        engine_args=engine_args,
1021
1022
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
1023
        lora_requests=[LoRARequest("vision", 1, vision_lora_path)],
1024
1025
1026
    )


1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
def load_phi4siglip(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "microsoft/Phi-4-reasoning-vision-15B"
    placeholders = "\n".join("<image>" for _ in image_urls)
    prompt = f"<|user|>\n{placeholders}\n{question}<|end|>\n<|assistant|>\n"
    engine_args = EngineArgs(
        model=model_name,
        trust_remote_code=True,
        max_model_len=8192,
        max_num_seqs=2,
        limit_mm_per_prompt={"image": len(image_urls)},
    )
    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


1045
def load_qwen_vl_chat(question: str, image_urls: list[str]) -> ModelRequestData:
1046
    model_name = "Qwen/Qwen-VL-Chat"
1047
    engine_args = EngineArgs(
1048
1049
1050
1051
        model=model_name,
        trust_remote_code=True,
        max_model_len=1024,
        max_num_seqs=2,
1052
        hf_overrides={"architectures": ["QwenVLForConditionalGeneration"]},
1053
1054
        limit_mm_per_prompt={"image": len(image_urls)},
    )
1055
1056
1057
    placeholders = "".join(
        f"Picture {i}: <img></img>\n" for i, _ in enumerate(image_urls, start=1)
    )
1058
1059
1060
1061
1062

    # This model does not have a chat_template attribute on its tokenizer,
    # so we need to explicitly pass it. We use ChatML since it's used in the
    # generation utils of the model:
    # https://huggingface.co/Qwen/Qwen-VL-Chat/blob/main/qwen_generation_utils.py#L265
1063
    tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
1064
1065
1066
1067

    # Copied from: https://huggingface.co/docs/transformers/main/en/chat_templating
    chat_template = "{% if not add_generation_prompt is defined %}{% set add_generation_prompt = false %}{% endif %}{% for message in messages %}{{'<|im_start|>' + message['role'] + '\n' + message['content'] + '<|im_end|>' + '\n'}}{% endfor %}{% if add_generation_prompt %}{{ '<|im_start|>assistant\n' }}{% endif %}"  # noqa: E501

1068
1069
1070
1071
1072
1073
1074
    messages = [{"role": "user", "content": f"{placeholders}\n{question}"}]
    prompt = tokenizer.apply_chat_template(
        messages,
        tokenize=False,
        add_generation_prompt=True,
        chat_template=chat_template,
    )
1075
1076
1077

    stop_tokens = ["<|endoftext|>", "<|im_start|>", "<|im_end|>"]
    stop_token_ids = [tokenizer.convert_tokens_to_ids(i) for i in stop_tokens]
1078

1079
    return ModelRequestData(
1080
        engine_args=engine_args,
1081
1082
1083
1084
1085
1086
1087
        prompt=prompt,
        stop_token_ids=stop_token_ids,
        image_data=[fetch_image(url) for url in image_urls],
        chat_template=chat_template,
    )


1088
def load_qwen2_vl(question: str, image_urls: list[str]) -> ModelRequestData:
1089
    try:
汪志鹏's avatar
汪志鹏 committed
1090
        from qwen_vl_utils import smart_resize
1091
    except ModuleNotFoundError:
1092
1093
1094
1095
1096
        print(
            "WARNING: `qwen-vl-utils` not installed, input images will not "
            "be automatically resized. You can enable this functionality by "
            "`pip install qwen-vl-utils`."
        )
汪志鹏's avatar
汪志鹏 committed
1097
        smart_resize = None
1098
1099
1100

    model_name = "Qwen/Qwen2-VL-7B-Instruct"

1101
    # Tested on L40
1102
    engine_args = EngineArgs(
1103
        model=model_name,
汪志鹏's avatar
汪志鹏 committed
1104
        max_model_len=32768 if smart_resize is None else 4096,
1105
        max_num_seqs=5,
1106
1107
1108
1109
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
    messages = [
        {"role": "system", "content": "You are a helpful assistant."},
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        },
    ]
1120
1121
1122

    processor = AutoProcessor.from_pretrained(model_name)

1123
1124
1125
    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
1126

汪志鹏's avatar
汪志鹏 committed
1127
    if smart_resize is None:
1128
1129
        image_data = [fetch_image(url) for url in image_urls]
    else:
汪志鹏's avatar
汪志鹏 committed
1130
1131
1132
1133
1134
1135
1136
1137
1138

        def post_process_image(image: Image) -> Image:
            width, height = image.size
            resized_height, resized_width = smart_resize(
                height, width, max_pixels=1024 * 28 * 28
            )
            return image.resize((resized_width, resized_height))

        image_data = [post_process_image(fetch_image(url)) for url in image_urls]
1139

1140
    return ModelRequestData(
1141
        engine_args=engine_args,
1142
1143
1144
        prompt=prompt,
        image_data=image_data,
    )
1145
1146


1147
def load_qwen2_5_vl(question: str, image_urls: list[str]) -> ModelRequestData:
Roger Wang's avatar
Roger Wang committed
1148
    try:
汪志鹏's avatar
汪志鹏 committed
1149
        from qwen_vl_utils import smart_resize
Roger Wang's avatar
Roger Wang committed
1150
    except ModuleNotFoundError:
1151
1152
1153
1154
1155
        print(
            "WARNING: `qwen-vl-utils` not installed, input images will not "
            "be automatically resized. You can enable this functionality by "
            "`pip install qwen-vl-utils`."
        )
汪志鹏's avatar
汪志鹏 committed
1156
        smart_resize = None
Roger Wang's avatar
Roger Wang committed
1157
1158
1159

    model_name = "Qwen/Qwen2.5-VL-3B-Instruct"

1160
    engine_args = EngineArgs(
Roger Wang's avatar
Roger Wang committed
1161
        model=model_name,
汪志鹏's avatar
汪志鹏 committed
1162
        max_model_len=32768 if smart_resize is None else 4096,
Roger Wang's avatar
Roger Wang committed
1163
1164
1165
1166
1167
        max_num_seqs=5,
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
    messages = [
        {"role": "system", "content": "You are a helpful assistant."},
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        },
    ]
Roger Wang's avatar
Roger Wang committed
1178
1179
1180

    processor = AutoProcessor.from_pretrained(model_name)

1181
1182
1183
    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
Roger Wang's avatar
Roger Wang committed
1184

汪志鹏's avatar
汪志鹏 committed
1185
    if smart_resize is None:
Roger Wang's avatar
Roger Wang committed
1186
1187
        image_data = [fetch_image(url) for url in image_urls]
    else:
汪志鹏's avatar
汪志鹏 committed
1188
1189
1190
1191
1192
1193
1194
1195
1196

        def post_process_image(image: Image) -> Image:
            width, height = image.size
            resized_height, resized_width = smart_resize(
                height, width, max_pixels=1024 * 28 * 28
            )
            return image.resize((resized_width, resized_height))

        image_data = [post_process_image(fetch_image(url)) for url in image_urls]
Roger Wang's avatar
Roger Wang committed
1197
1198

    return ModelRequestData(
1199
        engine_args=engine_args,
Roger Wang's avatar
Roger Wang committed
1200
1201
1202
1203
1204
        prompt=prompt,
        image_data=image_data,
    )


1205
1206
1207
1208
1209
1210
def load_r_vl(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "YannQi/R-4B"
    engine_args = EngineArgs(
        model=model_name,
        max_model_len=16384,
        max_num_seqs=16,
1211
        trust_remote_code=True,
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
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        }
    ]

    processor = AutoProcessor.from_pretrained(model_name, trust_remote_code=True)

    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
def load_smolvlm(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "HuggingFaceTB/SmolVLM2-2.2B-Instruct"

    # The configuration below has been confirmed to launch on a single L40 GPU.
    engine_args = EngineArgs(
        model=model_name,
        max_model_len=8192,
        max_num_seqs=16,
        enforce_eager=True,
        limit_mm_per_prompt={"image": len(image_urls)},
        mm_processor_kwargs={
            "max_image_size": {"longest_edge": 384},
        },
    )

    placeholders = "\n".join(
        f"Image-{i}: <image>\n" for i, _ in enumerate(image_urls, start=1)
    )
    prompt = (
        f"<|im_start|>User:{placeholders}\n{question}<end_of_utterance>\nAssistant:"  # noqa: E501
    )
    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=[fetch_image(url) for url in image_urls],
    )


def load_step3(question: str, image_urls: list[str]) -> ModelRequestData:
    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={"image": len(image_urls)},
        reasoning_parser="step3",
    )

    prompt = (
        "<|begin▁of▁sentence|> You are a helpful assistant. <|BOT|>user\n "
        f"{'<im_patch>' * len(image_urls)}{question} <|EOT|><|BOT|"
        ">assistant\n<think>\n"
    )
    image_data = [fetch_image(url) for url in image_urls]

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=image_data,
    )


1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
def load_step_vl(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "stepfun-ai/Step3-VL-10B"

    engine_args = EngineArgs(
        model=model_name,
        max_num_batched_tokens=4096,
        limit_mm_per_prompt={"image": len(image_urls)},
        hf_overrides={"vision_config": {"enable_patch": False}},
        trust_remote_code=True,
        reasoning_parser="deepseek_r1",
    )

    prompt = (
        "<|begin▁of▁sentence|> You are a helpful assistant.<|BOT|>user\n "
        f"{'<im_patch>' * len(image_urls)}{question}<|EOT|><|BOT|>"
        "assistant\n<think>\n"
    )
    image_data = [fetch_image(url) for url in image_urls]

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=image_data,
    )


汪志鹏's avatar
汪志鹏 committed
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
def load_tarsier(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "omni-research/Tarsier-7b"

    engine_args = EngineArgs(
        model=model_name,
        trust_remote_code=True,
        max_model_len=4096,
        limit_mm_per_prompt={"image": len(image_urls)},
    )

    prompt = f"USER: {'<image>' * len(image_urls)}\n{question}\n ASSISTANT:"
    image_data = [fetch_image(url) for url in image_urls]

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=image_data,
    )


1341
1342
1343
1344
1345
1346
1347
1348
def load_tarsier2(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "omni-research/Tarsier2-Recap-7b"

    engine_args = EngineArgs(
        model=model_name,
        trust_remote_code=True,
        max_model_len=32768,
        limit_mm_per_prompt={"image": len(image_urls)},
1349
1350
1351
1352
        hf_overrides={
            "architectures": ["Tarsier2ForConditionalGeneration"],
            "model_type": "tarsier2",
        },
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
    )

    prompt = (
        "<|im_start|>system\nYou are a helpful assistant.<|im_end|>\n"
        f"<|im_start|>user\n<|vision_start|>{'<|image_pad|>' * len(image_urls)}"
        f"<|vision_end|>{question}<|im_end|>\n"
        "<|im_start|>assistant\n"
    )
    image_data = [fetch_image(url) for url in image_urls]

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=image_data,
    )


1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
# GLM-4.1V
def load_glm4_1v(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "zai-org/GLM-4.1V-9B-Thinking"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=45082,
        max_num_seqs=2,
        limit_mm_per_prompt={"image": len(image_urls)},
        enforce_eager=True,
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        }
    ]

    processor = AutoProcessor.from_pretrained(model_name)
    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
    image_data = [fetch_image(url) for url in image_urls]

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=image_data,
    )


1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
# GLM-4.5V
def load_glm4_5v(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "zai-org/GLM-4.5V"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=32768,
        max_num_seqs=2,
        limit_mm_per_prompt={"image": len(image_urls)},
        enforce_eager=True,
        tensor_parallel_size=4,
    )
    placeholders = [{"type": "image", "image": url} for url in image_urls]
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        }
    ]
    processor = AutoProcessor.from_pretrained(model_name)
    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
    image_data = [fetch_image(url) for url in image_urls]

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=image_data,
    )


# GLM-4.5V-FP8
def load_glm4_5v_fp8(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "zai-org/GLM-4.5V-FP8"

    engine_args = EngineArgs(
        model=model_name,
        max_model_len=32768,
        max_num_seqs=2,
        limit_mm_per_prompt={"image": len(image_urls)},
        enforce_eager=True,
        tensor_parallel_size=4,
    )
    placeholders = [{"type": "image", "image": url} for url in image_urls]
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        }
    ]
    processor = AutoProcessor.from_pretrained(model_name)
    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )
    image_data = [fetch_image(url) for url in image_urls]

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=image_data,
    )


1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
def load_molmo2(question: str, image_urls: list[str]) -> ModelRequestData:
    model_name = "allenai/Molmo2-8B"

    engine_args = EngineArgs(
        model=model_name,
        trust_remote_code=True,
        dtype="bfloat16",
        limit_mm_per_prompt={"image": len(image_urls)},
        max_num_batched_tokens=36864,
    )

    placeholders = [{"type": "image", "image": url} for url in image_urls]
    messages = [
        {
            "role": "user",
            "content": [
                *placeholders,
                {"type": "text", "text": question},
            ],
        },
    ]

    processor = AutoProcessor.from_pretrained(model_name)

    prompt = processor.apply_chat_template(
        messages, tokenize=False, add_generation_prompt=True
    )

    image_data = [fetch_image(url) for url in image_urls]

    return ModelRequestData(
        engine_args=engine_args,
        prompt=prompt,
        image_data=image_data,
    )


1513
model_example_map = {
1514
    "aria": load_aria,
Jennifer Zhao's avatar
Jennifer Zhao committed
1515
    "aya_vision": load_aya_vision,
1516
    "bee": load_bee,
1517
    "command_a_vision": load_command_a_vision,
1518
    "deepseek_vl_v2": load_deepseek_vl2,
1519
    "deepseek_ocr": load_deepseek_ocr,
Kyungmin Lee's avatar
Kyungmin Lee committed
1520
    "exaone4_5": load_exaone4_5,
1521
    "gemma3": load_gemma3,
1522
    "granite4_vision": load_granite4_vision,
1523
    "h2ovl_chat": load_h2ovl,
1524
    "hunyuan_vl": load_hunyuan_vl,
1525
    "hyperclovax_seed_vision": load_hyperclovax_seed_vision,
1526
    "idefics3": load_idefics3,
Lyu Han's avatar
Lyu Han committed
1527
    "interns1": load_interns1,
1528
    "internvl_chat": load_internvl,
1529
    "keye_vl": load_keye_vl,
1530
    "keye_vl1_5": load_keye_vl1_5,
1531
    "kimi_vl": load_kimi_vl,
1532
    "llama4": load_llama4,
1533
1534
1535
    "llava": load_llava,
    "llava-next": load_llava_next,
    "llava-onevision": load_llava_onevision,
1536
    "mistral3": load_mistral3,
1537
    "molmo2": load_molmo2,
1538
    "NVLM_D": load_nvlm_d,
1539
    "openpangu_vl": load_openpangu_vl,
1540
    "ovis": load_ovis,
1541
    "ovis2_5": load_ovis2_5,
1542
    "paddleocr_vl": load_paddleocr_vl,
1543
    "phi3_v": load_phi3v,
1544
    "phi4_mm": load_phi4mm,
1545
    "phi4_siglip": load_phi4siglip,
1546
1547
    "pixtral_hf": load_pixtral_hf,
    "qwen_vl_chat": load_qwen_vl_chat,
1548
    "qwen2_vl": load_qwen2_vl,
Roger Wang's avatar
Roger Wang committed
1549
    "qwen2_5_vl": load_qwen2_5_vl,
1550
    "rvl": load_r_vl,
1551
    "smolvlm": load_smolvlm,
1552
    "step3": load_step3,
1553
    "stepvl": load_step_vl,
汪志鹏's avatar
汪志鹏 committed
1554
    "tarsier": load_tarsier,
1555
    "tarsier2": load_tarsier2,
1556
    "glm4_1v": load_glm4_1v,
1557
1558
    "glm4_5v": load_glm4_5v,
    "glm4_5v_fp8": load_glm4_5v_fp8,
1559
1560
1561
}


1562
1563
1564
1565
def run_generate(
    model,
    question: str,
    image_urls: list[str],
1566
    seed: int,
1567
1568
    tensor_parallel_size: int | None,
):
1569
    req_data = model_example_map[model](question, image_urls)
1570

1571
1572
    engine_args = req_data.engine_args
    engine_args.seed = seed
1573
    if tensor_parallel_size is not None:
1574
1575
        engine_args.tensor_parallel_size = tensor_parallel_size
    llm = LLM.from_engine_args(engine_args)
1576

1577
1578
1579
    sampling_params = SamplingParams(
        temperature=0.0, max_tokens=256, stop_token_ids=req_data.stop_token_ids
    )
1580

1581
    outputs = llm.generate(
1582
        {
1583
            "prompt": req_data.prompt,
1584
            "multi_modal_data": {"image": req_data.image_data},
1585
        },
1586
1587
1588
        sampling_params=sampling_params,
        lora_request=req_data.lora_requests,
    )
1589

1590
    print("-" * 50)
1591
1592
1593
    for o in outputs:
        generated_text = o.outputs[0].text
        print(generated_text)
1594
        print("-" * 50)
1595
1596


1597
1598
1599
1600
def run_chat(
    model: str,
    question: str,
    image_urls: list[str],
1601
    seed: int,
1602
1603
    tensor_parallel_size: int | None,
):
1604
    req_data = model_example_map[model](question, image_urls)
1605

1606
1607
1608
    # 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(
1609
1610
        req_data.engine_args.limit_mm_per_prompt or {}
    )
1611

1612
1613
    engine_args = req_data.engine_args
    engine_args.seed = seed
1614
    if tensor_parallel_size is not None:
1615
1616
        engine_args.tensor_parallel_size = tensor_parallel_size
    llm = LLM.from_engine_args(engine_args)
1617

1618
1619
1620
1621
1622
1623
    sampling_params = (
        SamplingParams(
            temperature=0.0, max_tokens=256, stop_token_ids=req_data.stop_token_ids
        )
        if req_data.sampling_params is None
        else req_data.sampling_params
1624
    )
1625
    outputs = llm.chat(
1626
1627
1628
1629
1630
1631
1632
        [
            {
                "role": "user",
                "content": [
                    {
                        "type": "text",
                        "text": question,
1633
                    },
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
                    *(
                        {
                            "type": "image_url",
                            "image_url": {"url": image_url},
                        }
                        for image_url in image_urls
                    ),
                ],
            }
        ],
1644
        sampling_params=sampling_params,
1645
        chat_template=req_data.chat_template,
1646
        lora_request=req_data.lora_requests,
1647
    )
1648

1649
    print("-" * 50)
1650
1651
1652
    for o in outputs:
        generated_text = o.outputs[0].text
        print(generated_text)
1653
        print("-" * 50)
1654
1655


1656
def parse_args():
1657
    parser = FlexibleArgumentParser(
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
        description="Demo on using vLLM for offline inference with "
        "vision language models that support multi-image input for text "
        "generation"
    )
    parser.add_argument(
        "--model-type",
        "-m",
        type=str,
        default="phi3_v",
        choices=model_example_map.keys(),
        help='Huggingface "model_type".',
    )
    parser.add_argument(
        "--method",
        type=str,
        default="generate",
        choices=["generate", "chat"],
        help="The method to run in `vllm.LLM`.",
    )
    parser.add_argument(
        "--seed",
        type=int,
1680
        default=0,
1681
1682
        help="Set the seed when initializing `vllm.LLM`.",
    )
1683
1684
1685
    parser.add_argument(
        "--num-images",
        "-n",
1686
        type=int,
1687
        choices=list(range(1, len(IMAGE_URLS) + 1)),  # the max number of images
1688
        default=2,
1689
1690
        help="Number of images to use for the demo.",
    )
1691
1692
1693
1694
1695
1696
1697
    parser.add_argument(
        "--tensor-parallel-size",
        "-tp",
        type=int,
        default=None,
        help="Tensor parallel size to override the model's default setting. ",
    )
1698
1699
    return parser.parse_args()

1700

1701
1702
1703
1704
def main(args: Namespace):
    model = args.model_type
    method = args.method
    seed = args.seed
1705
1706
1707
1708
1709
1710
1711
    tensor_parallel_size = args.tensor_parallel_size

    if tensor_parallel_size is not None and tensor_parallel_size < 1:
        raise ValueError(
            f"tensor_parallel_size must be a positive integer, "
            f"got {tensor_parallel_size}"
        )
1712

1713
    image_urls = IMAGE_URLS[: args.num_images]
1714
1715

    if method == "generate":
1716
        run_generate(model, QUESTION, image_urls, seed, tensor_parallel_size)
1717
    elif method == "chat":
1718
        run_chat(model, QUESTION, image_urls, seed, tensor_parallel_size)
1719
1720
1721
1722
1723
1724
    else:
        raise ValueError(f"Invalid method: {method}")


if __name__ == "__main__":
    args = parse_args()
1725
    main(args)