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

For most models, the prompt format should follow corresponding examples
on HuggingFace model repository.
"""
9
import os
10
11
import random

12
from huggingface_hub import snapshot_download
13
14
15
16
from transformers import AutoTokenizer

from vllm import LLM, SamplingParams
from vllm.assets.image import ImageAsset
17
from vllm.assets.video import VideoAsset
18
from vllm.lora.request import LoRARequest
19
20
from vllm.utils import FlexibleArgumentParser

21
22
23
24
# 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.

25

26
# Aria
27
def run_aria(questions: list[str], modality: str):
28
29
30
    assert modality == "image"
    model_name = "rhymes-ai/Aria"

31
    # NOTE: Need L40 (or equivalent) to avoid OOM
32
    llm = LLM(model=model_name,
33
34
              max_model_len=4096,
              max_num_seqs=2,
35
              dtype="bfloat16",
36
              disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache)
37

38
39
40
    prompts = [(f"<|im_start|>user\n<fim_prefix><|img|><fim_suffix>{question}"
                "<|im_end|>\n<|im_start|>assistant\n")
               for question in questions]
41
42

    stop_token_ids = [93532, 93653, 944, 93421, 1019, 93653, 93519]
43
    return llm, prompts, stop_token_ids
44
45
46


# BLIP-2
47
def run_blip2(questions: list[str], modality: str):
48
49
50
51
    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
52
    prompts = [f"Question: {question} Answer:" for question in questions]
53
    llm = LLM(model="Salesforce/blip2-opt-2.7b",
54
              disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache)
55
    stop_token_ids = None
56
    return llm, prompts, stop_token_ids
57
58
59


# Chameleon
60
def run_chameleon(questions: list[str], modality: str):
61
62
    assert modality == "image"

63
    prompts = [f"{question}<image>" for question in questions]
64
65
    llm = LLM(model="facebook/chameleon-7b",
              max_model_len=4096,
66
              max_num_seqs=2,
67
              disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache)
68
    stop_token_ids = None
69
    return llm, prompts, stop_token_ids
70
71


72
# Deepseek-VL2
73
def run_deepseek_vl2(questions: list[str], modality: str):
74
75
    assert modality == "image"

76
    model_name = "deepseek-ai/deepseek-vl2-tiny"
77
78
79
80
81
82
83

    llm = LLM(model=model_name,
              max_model_len=4096,
              max_num_seqs=2,
              disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache,
              hf_overrides={"architectures": ["DeepseekVLV2ForCausalLM"]})

84
85
86
87
    prompts = [
        f"<|User|>: <image>\n{question}\n\n<|Assistant|>:"
        for question in questions
    ]
88
    stop_token_ids = None
89
    return llm, prompts, stop_token_ids
90
91


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# Florence2
def run_florence2(question: str, modality: str):
    assert modality == "image"

    llm = LLM(model="microsoft/Florence-2-large",
              tokenizer="facebook/bart-large",
              max_num_seqs=8,
              trust_remote_code=True,
              dtype="bfloat16",
              disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache)

    prompt = "<MORE_DETAILED_CAPTION>"
    stop_token_ids = None
    return llm, prompt, stop_token_ids


108
# Fuyu
109
def run_fuyu(questions: list[str], modality: str):
110
111
    assert modality == "image"

112
    prompts = [f"{question}\n" for question in questions]
113
114
115
    llm = LLM(model="adept/fuyu-8b",
              max_model_len=2048,
              max_num_seqs=2,
116
              disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache)
117
    stop_token_ids = None
118
    return llm, prompts, stop_token_ids
119
120
121


# GLM-4v
122
def run_glm4v(questions: list[str], modality: str):
123
124
125
126
127
128
129
130
    assert modality == "image"
    model_name = "THUDM/glm-4v-9b"

    llm = LLM(model=model_name,
              max_model_len=2048,
              max_num_seqs=2,
              trust_remote_code=True,
              enforce_eager=True,
131
              hf_overrides={"architectures": ["GLM4VForCausalLM"]},
132
              disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache)
133

134
135
136
137
    prompts = [
        f"<|user|>\n<|begin_of_image|><|endoftext|><|end_of_image|>\
        {question}<|assistant|>" for question in questions
    ]
138

139
    stop_token_ids = [151329, 151336, 151338]
140
    return llm, prompts, stop_token_ids
141
142
143


# H2OVL-Mississippi
144
def run_h2ovl(questions: list[str], modality: str):
145
146
    assert modality == "image"

147
    model_name = "h2oai/h2ovl-mississippi-800m"
148
149
150
151
152

    llm = LLM(
        model=model_name,
        trust_remote_code=True,
        max_model_len=8192,
153
        disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache,
154
155
156
157
    )

    tokenizer = AutoTokenizer.from_pretrained(model_name,
                                              trust_remote_code=True)
158
159
160
161
162
163
164
    messages = [[{
        'role': 'user',
        'content': f"<image>\n{question}"
    }] for question in questions]
    prompts = tokenizer.apply_chat_template(messages,
                                            tokenize=False,
                                            add_generation_prompt=True)
165
166

    # Stop tokens for H2OVL-Mississippi
167
    # https://huggingface.co/h2oai/h2ovl-mississippi-800m
168
    stop_token_ids = [tokenizer.eos_token_id]
169
    return llm, prompts, stop_token_ids
170
171
172


# Idefics3-8B-Llama3
173
def run_idefics3(questions: list[str], modality: str):
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
    assert modality == "image"
    model_name = "HuggingFaceM4/Idefics3-8B-Llama3"

    llm = LLM(
        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={
            "size": {
                "longest_edge": 3 * 364
            },
        },
189
        disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache,
190
    )
191
    prompts = [(
192
        f"<|begin_of_text|>User:<image>{question}<end_of_utterance>\nAssistant:"
193
    ) for question in questions]
194
    stop_token_ids = None
195
    return llm, prompts, stop_token_ids
196
197
198


# InternVL
199
def run_internvl(questions: list[str], modality: str):
200
201
202
203
204
205
206
207
    assert modality == "image"

    model_name = "OpenGVLab/InternVL2-2B"

    llm = LLM(
        model=model_name,
        trust_remote_code=True,
        max_model_len=4096,
208
        disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache,
209
210
211
212
    )

    tokenizer = AutoTokenizer.from_pretrained(model_name,
                                              trust_remote_code=True)
213
214
215
216
217
218
219
    messages = [[{
        'role': 'user',
        'content': f"<image>\n{question}"
    }] for question in questions]
    prompts = tokenizer.apply_chat_template(messages,
                                            tokenize=False,
                                            add_generation_prompt=True)
220
221
222
223
224
225
226

    # 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]
227
    return llm, prompts, stop_token_ids
228
229


230
# LLaVA-1.5
231
def run_llava(questions: list[str], modality: str):
232
    assert modality == "image"
233

234
235
236
    prompts = [
        f"USER: <image>\n{question}\nASSISTANT:" for question in questions
    ]
237

238
239
    llm = LLM(model="llava-hf/llava-1.5-7b-hf",
              max_model_len=4096,
240
              disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache)
241
    stop_token_ids = None
242
    return llm, prompts, stop_token_ids
243
244
245


# LLaVA-1.6/LLaVA-NeXT
246
def run_llava_next(questions: list[str], modality: str):
247
    assert modality == "image"
248

249
    prompts = [f"[INST] <image>\n{question} [/INST]" for question in questions]
250
251
    llm = LLM(model="llava-hf/llava-v1.6-mistral-7b-hf",
              max_model_len=8192,
252
              disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache)
253
    stop_token_ids = None
254
    return llm, prompts, stop_token_ids
255
256
257
258


# LlaVA-NeXT-Video
# Currently only support for video input
259
def run_llava_next_video(questions: list[str], modality: str):
260
261
    assert modality == "video"

262
263
264
    prompts = [
        f"USER: <video>\n{question} ASSISTANT:" for question in questions
    ]
265
266
    llm = LLM(model="llava-hf/LLaVA-NeXT-Video-7B-hf",
              max_model_len=8192,
267
              disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache)
268
    stop_token_ids = None
269
    return llm, prompts, stop_token_ids
270
271


272
# LLaVA-OneVision
273
def run_llava_onevision(questions: list[str], modality: str):
274
275

    if modality == "video":
276
277
278
279
        prompts = [
            f"<|im_start|>user <video>\n{question}<|im_end|> \
        <|im_start|>assistant\n" for question in questions
        ]
280
281

    elif modality == "image":
282
283
284
285
        prompts = [
            f"<|im_start|>user <image>\n{question}<|im_end|> \
        <|im_start|>assistant\n" for question in questions
        ]
286
287

    llm = LLM(model="llava-hf/llava-onevision-qwen2-7b-ov-hf",
288
              max_model_len=16384,
289
              disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache)
290
    stop_token_ids = None
291
    return llm, prompts, stop_token_ids
292
293


294
# Mantis
295
def run_mantis(questions: list[str], modality: str):
296
    assert modality == "image"
297

298
    llama3_template = '<|start_header_id|>user<|end_header_id|>\n\n{}<|eot_id|><|start_header_id|>assistant<|end_header_id|>\n\n'  # noqa: E501
299
300
301
302
    prompts = [
        llama3_template.format(f"{question}\n<image>")
        for question in questions
    ]
303
304

    llm = LLM(
305
        model="TIGER-Lab/Mantis-8B-siglip-llama3",
306
        max_model_len=4096,
307
        hf_overrides={"architectures": ["MantisForConditionalGeneration"]},
308
        disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache,
309
    )
310
    stop_token_ids = [128009]
311
    return llm, prompts, stop_token_ids
312
313
314


# MiniCPM-V
315
def run_minicpmv_base(questions: list[str], modality: str, model_name):
316
317
    assert modality in ["image", "video"]
    # If you want to use `MiniCPM-o-2_6` with audio inputs, check `audio_language.py` # noqa
318
319
320
321
322
323
324

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

327
    # 2.6
328
329
330
331
332
333
334
335
336
    # 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"
337
338
339
340
    tokenizer = AutoTokenizer.from_pretrained(model_name,
                                              trust_remote_code=True)
    llm = LLM(
        model=model_name,
341
342
        max_model_len=4096,
        max_num_seqs=2,
343
        trust_remote_code=True,
344
        disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache,
345
    )
346
347
348
349
350
351
352
    # 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]

353
    # 2.6 / o2.6
354
355
    stop_tokens = ['<|im_end|>', '<|endoftext|>']
    stop_token_ids = [tokenizer.convert_tokens_to_ids(i) for i in stop_tokens]
356

357
358
359
360
361
    modality_placeholder = {
        "image": "(<image>./</image>)",
        "video": "(<video>./</video>)",
    }

362
363
364
365
366
367
368
369
370
371
    prompts = [
        tokenizer.apply_chat_template(
            [{
                'role': 'user',
                'content': f"{modality_placeholder[modality]}\n{question}"
            }],
            tokenize=False,
            add_generation_prompt=True) for question in questions
    ]
    return llm, prompts, stop_token_ids
372
373


374
375
def run_minicpmo(questions: list[str], modality: str):
    return run_minicpmv_base(questions, modality, "openbmb/MiniCPM-o-2_6")
376
377


378
379
def run_minicpmv(questions: list[str], modality: str):
    return run_minicpmv_base(questions, modality, "openbmb/MiniCPM-V-2_6")
380
381


382
# LLama 3.2
383
def run_mllama(questions: list[str], modality: str):
384
385
    assert modality == "image"

386
    model_name = "meta-llama/Llama-3.2-11B-Vision-Instruct"
387

388
389
390
391
392
    # Note: The default setting of max_num_seqs (256) and
    # max_model_len (131072) for this model may cause OOM.
    # You may lower either to run this example on lower-end GPUs.

    # The configuration below has been confirmed to launch on a single L40 GPU.
393
394
    llm = LLM(
        model=model_name,
395
396
        max_model_len=4096,
        max_num_seqs=16,
397
        disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache,
398
399
    )

400
    tokenizer = AutoTokenizer.from_pretrained(model_name)
401
    messages = [[{
402
403
404
405
406
407
408
409
        "role":
        "user",
        "content": [{
            "type": "image"
        }, {
            "type": "text",
            "text": f"{question}"
        }]
410
    }] for question in questions]
411
412
413
    prompts = tokenizer.apply_chat_template(messages,
                                            add_generation_prompt=True,
                                            tokenize=False)
414
    stop_token_ids = None
415
    return llm, prompts, stop_token_ids
416
417


418
# Molmo
419
def run_molmo(questions: list[str], modality: str):
420
421
    assert modality == "image"

422
    model_name = "allenai/Molmo-7B-D-0924"
423

424
    llm = LLM(
425
        model=model_name,
426
        trust_remote_code=True,
427
        dtype="bfloat16",
428
        disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache,
429
    )
430

431
432
433
434
    prompts = [
        f"<|im_start|>user <image>\n{question}<|im_end|> \
        <|im_start|>assistant\n" for question in questions
    ]
435
    stop_token_ids = None
436
    return llm, prompts, stop_token_ids
437
438


439
# NVLM-D
440
def run_nvlm_d(questions: list[str], modality: str):
441
442
443
444
445
446
447
448
449
450
    assert modality == "image"

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

    # Adjust this as necessary to fit in GPU
    llm = LLM(
        model=model_name,
        trust_remote_code=True,
        max_model_len=4096,
        tensor_parallel_size=4,
451
        disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache,
452
453
454
455
    )

    tokenizer = AutoTokenizer.from_pretrained(model_name,
                                              trust_remote_code=True)
456
    messages = [[{
457
458
        'role': 'user',
        'content': f"<image>\n{question}"
459
    }] for question in questions]
460
461
462
    prompts = tokenizer.apply_chat_template(messages,
                                            tokenize=False,
                                            add_generation_prompt=True)
463
    stop_token_ids = None
464
    return llm, prompts, stop_token_ids
465
466


467
468
# PaliGemma
def run_paligemma(question: str, modality: str):
469
    assert modality == "image"
470

471
    # PaliGemma has special prompt format for VQA
472
    prompt = ["caption en"]
473
    llm = LLM(model="google/paligemma-3b-mix-224",
474
              disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache)
475
476
    stop_token_ids = None
    return llm, prompt, stop_token_ids
477
478


479
480
# PaliGemma 2
def run_paligemma2(question: str, modality: str):
481
    assert modality == "image"
482

483
    # PaliGemma 2 has special prompt format for VQA
484
    prompt = ["caption en"]
485
    llm = LLM(model="google/paligemma2-3b-ft-docci-448",
486
              disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache)
487
488
489
490
    stop_token_ids = None
    return llm, prompt, stop_token_ids


491
# Phi-3-Vision
492
def run_phi3v(questions: list[str], modality: str):
493
494
    assert modality == "image"

495
496
497
498
    prompts = [
        f"<|user|>\n<|image_1|>\n{question}<|end|>\n<|assistant|>\n"
        for question in questions
    ]
499

500
501
502
503
504
505
506
507
508
509
510
511
    # 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
512
    llm = LLM(
513
514
        model="microsoft/Phi-3.5-vision-instruct",
        trust_remote_code=True,
515
        max_model_len=4096,
516
        max_num_seqs=2,
517
        # Note - mm_processor_kwargs can also be passed to generate/chat calls
518
        mm_processor_kwargs={"num_crops": 16},
519
        disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache,
520
521
    )
    stop_token_ids = None
522
    return llm, prompts, stop_token_ids
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
# Phi-4-multimodal-instruct
def run_phi4mm(questions: list[str], modality: str):
    """
    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 = [
        f"<|user|><|image_1|>{question}<|end|><|assistant|>"
        for question in questions
    ]
    llm = LLM(
        model=model_path,
        trust_remote_code=True,
        max_model_len=4096,
        max_num_seqs=2,
        enable_lora=True,
        max_lora_rank=320,
        lora_extra_vocab_size=0,
    )
    lora_request = LoRARequest("vision", 1, vision_lora_path)
    # To maintain code compatibility in this script, we add LoRA here.
    llm.llm_engine.add_lora(lora_request=lora_request)
    # You can also add LoRA using:
    # llm.generate(prompts, lora_request=lora_request,...)

    stop_token_ids = None
    return llm, prompts, stop_token_ids


559
# Pixtral HF-format
560
def run_pixtral_hf(questions: list[str], modality: str):
561
562
563
564
    assert modality == "image"

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

565
    # NOTE: Need L40 (or equivalent) to avoid OOM
566
567
568
    llm = LLM(
        model=model_name,
        max_model_len=8192,
569
        max_num_seqs=2,
570
        disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache,
571
572
    )

573
    prompts = [f"<s>[INST]{question}\n[IMG][/INST]" for question in questions]
574
    stop_token_ids = None
575
    return llm, prompts, stop_token_ids
576
577


578
# Qwen
579
def run_qwen_vl(questions: list[str], modality: str):
580
581
582
    assert modality == "image"

    llm = LLM(
583
        model="Qwen/Qwen-VL",
584
        trust_remote_code=True,
585
586
        max_model_len=1024,
        max_num_seqs=2,
587
        hf_overrides={"architectures": ["QwenVLForConditionalGeneration"]},
588
        disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache,
589
590
    )

591
    prompts = [f"{question}Picture 1: <img></img>\n" for question in questions]
592
    stop_token_ids = None
593
    return llm, prompts, stop_token_ids
594
595


596
# Qwen2-VL
597
def run_qwen2_vl(questions: list[str], modality: str):
598

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

601
602
    llm = LLM(
        model=model_name,
603
604
605
        max_model_len=4096,
        max_num_seqs=5,
        # Note - mm_processor_kwargs can also be passed to generate/chat calls
606
        mm_processor_kwargs={
607
608
            "min_pixels": 28 * 28,
            "max_pixels": 1280 * 28 * 28,
609
        },
610
        disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache,
611
    )
612

613
614
615
616
617
    if modality == "image":
        placeholder = "<|image_pad|>"
    elif modality == "video":
        placeholder = "<|video_pad|>"

618
619
620
621
622
623
    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
    ]
624
    stop_token_ids = None
625
    return llm, prompts, stop_token_ids
626
627


Roger Wang's avatar
Roger Wang committed
628
# Qwen2.5-VL
629
def run_qwen2_5_vl(questions: list[str], modality: str):
Roger Wang's avatar
Roger Wang committed
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649

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

    llm = LLM(
        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,
        },
        disable_mm_preprocessor_cache=args.disable_mm_preprocessor_cache,
    )

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

650
651
652
653
654
655
    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
    ]
Roger Wang's avatar
Roger Wang committed
656
    stop_token_ids = None
657
    return llm, prompts, stop_token_ids
Roger Wang's avatar
Roger Wang committed
658
659


660
model_example_map = {
661
662
663
    "aria": run_aria,
    "blip-2": run_blip2,
    "chameleon": run_chameleon,
664
    "deepseek_vl_v2": run_deepseek_vl2,
665
    "florence2": run_florence2,
666
667
668
669
670
    "fuyu": run_fuyu,
    "glm4v": run_glm4v,
    "h2ovl_chat": run_h2ovl,
    "idefics3": run_idefics3,
    "internvl_chat": run_internvl,
671
672
    "llava": run_llava,
    "llava-next": run_llava_next,
673
    "llava-next-video": run_llava_next_video,
674
    "llava-onevision": run_llava_onevision,
675
    "mantis": run_mantis,
676
    "minicpmo": run_minicpmo,
677
    "minicpmv": run_minicpmv,
678
679
    "mllama": run_mllama,
    "molmo": run_molmo,
680
    "NVLM_D": run_nvlm_d,
681
682
683
    "paligemma": run_paligemma,
    "paligemma2": run_paligemma2,
    "phi3_v": run_phi3v,
684
    "phi4_mm": run_phi4mm,
685
    "pixtral_hf": run_pixtral_hf,
686
    "qwen_vl": run_qwen_vl,
687
    "qwen2_vl": run_qwen2_vl,
Roger Wang's avatar
Roger Wang committed
688
    "qwen2_5_vl": run_qwen2_5_vl,
689
690
691
}


692
693
694
695
696
697
698
699
700
701
702
def get_multi_modal_input(args):
    """
    return {
        "data": image or video,
        "question": question,
    }
    """
    if args.modality == "image":
        # Input image and question
        image = ImageAsset("cherry_blossom") \
            .pil_image.convert("RGB")
703
704
705
706
707
708
        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?",
        ]
709
710
711

        return {
            "data": image,
712
            "questions": img_questions,
713
714
715
716
717
718
        }

    if args.modality == "video":
        # Input video and question
        video = VideoAsset(name="sample_demo_1.mp4",
                           num_frames=args.num_frames).np_ndarrays
719
        vid_questions = ["Why is this video funny?"]
720
721
722

        return {
            "data": video,
723
            "questions": vid_questions,
724
725
726
727
728
729
        }

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


730
731
def apply_image_repeat(image_repeat_prob, num_prompts, data,
                       prompts: list[str], modality):
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
    """Repeats images with provided probability of "image_repeat_prob". 
    Used to simulate hit/miss for the MM preprocessor cache.
    """
    assert (image_repeat_prob <= 1.0 and image_repeat_prob >= 0)
    no_yes = [0, 1]
    probs = [1.0 - image_repeat_prob, image_repeat_prob]

    inputs = []
    cur_image = data
    for i in range(num_prompts):
        if image_repeat_prob is not None:
            res = random.choices(no_yes, probs)[0]
            if res == 0:
                # No repeat => Modify one pixel
                cur_image = cur_image.copy()
                new_val = (i // 256 // 256, i // 256, i % 256)
                cur_image.putpixel((0, 0), new_val)

        inputs.append({
751
            "prompt": prompts[i % len(prompts)],
752
753
754
755
756
757
758
759
            "multi_modal_data": {
                modality: cur_image
            }
        })

    return inputs


760
761
762
763
764
def main(args):
    model = args.model_type
    if model not in model_example_map:
        raise ValueError(f"Model type {model} is not supported.")

765
766
767
    modality = args.modality
    mm_input = get_multi_modal_input(args)
    data = mm_input["data"]
768
    questions = mm_input["questions"]
769

770
771
772
773
774
775
    llm, prompts, stop_token_ids = model_example_map[model](questions,
                                                            modality)
    # Don't want to check the flag multiple times, so just hijack `prompts`.
    prompts = prompts if args.use_different_prompt_per_request else [
        prompts[0]
    ]
776
777
778

    # We set temperature to 0.2 so that outputs can be different
    # even when all prompts are identical when running batch inference.
779
780
781
    sampling_params = SamplingParams(temperature=0.2,
                                     max_tokens=64,
                                     stop_token_ids=stop_token_ids)
782
783
784
785
786

    assert args.num_prompts > 0
    if args.num_prompts == 1:
        # Single inference
        inputs = {
787
            "prompt": prompts[0],
788
            "multi_modal_data": {
789
                modality: data
790
791
792
793
            },
        }
    else:
        # Batch inference
794
795
796
        if args.image_repeat_prob is not None:
            # Repeat images with specified probability of "image_repeat_prob"
            inputs = apply_image_repeat(args.image_repeat_prob,
797
                                        args.num_prompts, data, prompts,
798
799
800
801
                                        modality)
        else:
            # Use the same image for all prompts
            inputs = [{
802
                "prompt": prompts[i % len(prompts)],
803
804
805
                "multi_modal_data": {
                    modality: data
                },
806
            } for i in range(args.num_prompts)]
807
808
809
810
811
812
813

    if args.time_generate:
        import time
        start_time = time.time()
        outputs = llm.generate(inputs, sampling_params=sampling_params)
        elapsed_time = time.time() - start_time
        print("-- generate time = {}".format(elapsed_time))
814

815
816
    else:
        outputs = llm.generate(inputs, sampling_params=sampling_params)
817
818
819
820
821
822
823
824
825

    for o in outputs:
        generated_text = o.outputs[0].text
        print(generated_text)


if __name__ == "__main__":
    parser = FlexibleArgumentParser(
        description='Demo on using vLLM for offline inference with '
Cyrus Leung's avatar
Cyrus Leung committed
826
        'vision language models for text generation')
827
828
829
830
831
832
833
834
    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,
835
                        default=4,
836
                        help='Number of prompts to run.')
837
838
839
    parser.add_argument('--modality',
                        type=str,
                        default="image",
840
                        choices=['image', 'video'],
841
842
843
844
845
                        help='Modality of the input.')
    parser.add_argument('--num-frames',
                        type=int,
                        default=16,
                        help='Number of frames to extract from the video.')
846
847
848
849
850
851
852
853
854

    parser.add_argument(
        '--image-repeat-prob',
        type=float,
        default=None,
        help='Simulates the hit-ratio for multi-modal preprocessor cache'
        ' (if enabled)')

    parser.add_argument(
855
        '--disable-mm-preprocessor-cache',
856
        action='store_true',
857
        help='If True, disables caching of multi-modal preprocessor/mapper.')
858
859
860
861
862
863

    parser.add_argument(
        '--time-generate',
        action='store_true',
        help='If True, then print the total generate() call time')

864
865
866
867
868
869
    parser.add_argument(
        '--use-different-prompt-per-request',
        action='store_true',
        help='If True, then use different prompt (with the same multi-modal '
        'data) for each request.')

870
    args = parser.parse_args()
871
    main(args)