test_chat_utils.py 67 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3

4
import warnings
5
6
from collections.abc import Mapping
from typing import Literal, Optional
7
8

import pytest
9
import os
10

Julien Denize's avatar
Julien Denize committed
11
12
13
14
from mistral_common.tokens.tokenizers.base import (SpecialTokenPolicy,
                                                   SpecialTokens)
from mistral_common.tokens.tokenizers.tekken import (SpecialTokenInfo,
                                                     Tekkenizer)
15

16
from vllm.assets.audio import AudioAsset
17
from vllm.assets.image import ImageAsset
18
from vllm.assets.video import VideoAsset
19
from vllm.config import ModelConfig
20
from vllm.entrypoints.chat_utils import (_try_extract_ast, load_chat_template,
21
22
                                         parse_chat_messages,
                                         parse_chat_messages_futures,
23
24
                                         resolve_chat_template_content_format,
                                         resolve_hf_chat_template)
25
from vllm.entrypoints.llm import apply_hf_chat_template
26
from vllm.multimodal import MultiModalDataDict, MultiModalUUIDDict
27
28
from vllm.multimodal.utils import (encode_audio_base64, encode_image_base64,
                                   encode_video_base64)
29
from vllm.transformers_utils.tokenizer_group import TokenizerGroup
30

31
from ..utils import models_path_prefix
Julien Denize's avatar
Julien Denize committed
32
from vllm.transformers_utils.tokenizers.mistral import MistralTokenizer
33

34
from ..models.registry import HF_EXAMPLE_MODELS
35
36
37
38
from ..utils import VLLM_PATH

EXAMPLES_DIR = VLLM_PATH / "examples"

39
PHI3V_MODEL_ID = os.path.join(models_path_prefix, "microsoft/Phi-3.5-vision-instruct")
zhuwenwen's avatar
zhuwenwen committed
40
ULTRAVOX_MODEL_ID = os.path.join(models_path_prefix, "fixie-ai/ultravox-v0_5-llama-3_2-1b")
zhuwenwen's avatar
zhuwenwen committed
41
QWEN2AUDIO_MODEL_ID = os.path.join(models_path_prefix, "Qwen/Qwen2-Audio-7B-Instruct")
zhuwenwen's avatar
zhuwenwen committed
42
QWEN2VL_MODEL_ID = os.path.join(models_path_prefix, "Qwen/Qwen2-VL-2B-Instruct")
zhuwenwen's avatar
zhuwenwen committed
43
QWEN25VL_MODEL_ID = os.path.join(models_path_prefix, "Qwen/Qwen2.5-VL-3B-Instruct")
44
QWEN25OMNI_MODEL_ID = os.path.join(models_path_prefix, "Qwen/Qwen2.5-Omni-7B")
zhuwenwen's avatar
zhuwenwen committed
45
46
MLLAMA_MODEL_ID = os.path.join(models_path_prefix, "meta-llama/Llama-3.2-11B-Vision-Instruct")
LLAMA_GUARD_MODEL_ID = os.path.join(models_path_prefix, "meta-llama/Llama-Guard-3-1B")
zhuwenwen's avatar
zhuwenwen committed
47
HERMES_MODEL_ID = os.path.join(models_path_prefix, "NousResearch/Hermes-3-Llama-3.1-8B")
zhuwenwen's avatar
zhuwenwen committed
48
MISTRAL_MODEL_ID = os.path.join(models_path_prefix, "mistralai/Mistral-Small-3.1-24B-Instruct-2503")
49
50


51
@pytest.fixture(scope="function")
52
def phi3v_model_config():
53
54
55
56
57
58
59
60
    return ModelConfig(
        PHI3V_MODEL_ID,
        runner="generate",
        trust_remote_code=True,
        limit_mm_per_prompt={
            "image": 2,
        },
    )
61
62


63
64
@pytest.fixture(scope="function")
def phi3v_model_config_mm_interleaved():
65
66
67
68
69
70
71
72
73
    return ModelConfig(
        PHI3V_MODEL_ID,
        runner="generate",
        trust_remote_code=True,
        interleave_mm_strings=True,
        limit_mm_per_prompt={
            "image": 2,
        },
    )
74
75


76
77
78
79
80
81
82
83
84
85
@pytest.fixture(scope="module")
def phi3v_tokenizer():
    return TokenizerGroup(
        tokenizer_id=PHI3V_MODEL_ID,
        enable_lora=False,
        max_num_seqs=5,
        max_input_length=None,
    )


86
87
@pytest.fixture(scope="function")
def qwen25omni_model_config_mm_interleaved():
88
89
90
91
92
93
94
95
96
97
    return ModelConfig(
        QWEN25OMNI_MODEL_ID,
        runner="generate",
        interleave_mm_strings=True,
        limit_mm_per_prompt={
            "image": 2,
            "audio": 1,
            "video": 1,
        },
    )
98
99
100
101
102
103
104
105
106
107
108
109


@pytest.fixture(scope="module")
def qwen25omni_tokenizer():
    return TokenizerGroup(
        tokenizer_id=QWEN25OMNI_MODEL_ID,
        enable_lora=False,
        max_num_seqs=5,
        max_input_length=None,
    )


110
111
@pytest.fixture(scope="module")
def mllama_model_config():
112
113
114
115
116
117
118
    return ModelConfig(
        MLLAMA_MODEL_ID,
        runner="generate",
        limit_mm_per_prompt={
            "image": 2,
        },
    )
119
120
121
122
123
124
125
126
127
128
129
130


@pytest.fixture(scope="module")
def mllama_tokenizer():
    return TokenizerGroup(
        MLLAMA_MODEL_ID,
        enable_lora=False,
        max_num_seqs=5,
        max_input_length=None,
    )


131
132
@pytest.fixture(scope="function")
def mistral_model_config():
133
134
135
136
137
138
139
    return ModelConfig(
        MISTRAL_MODEL_ID,
        runner="generate",
        limit_mm_per_prompt={
            "image": 2,
        },
    )
140
141
142
143
144
145
146
147
148
149
150
151


@pytest.fixture(scope="module")
def mistral_tokenizer():
    return TokenizerGroup(
        tokenizer_id=MISTRAL_MODEL_ID,
        enable_lora=False,
        max_num_seqs=5,
        max_input_length=None,
    )


152
153
@pytest.fixture(scope="module")
def image_url():
154
    image = ImageAsset("cherry_blossom")
155
156
157
158
    base64 = encode_image_base64(image.pil_image)
    return f"data:image/jpeg;base64,{base64}"


159
160
@pytest.fixture(scope="module")
def video_url():
161
    video = VideoAsset("baby_reading", 1)
162
163
164
165
166
167
    base64 = encode_video_base64(video.np_ndarrays)
    return f"data:video/jpeg;base64,{base64}"


@pytest.fixture(scope="module")
def audio_url():
168
    audio = AudioAsset("mary_had_lamb")
169
170
171
172
    base64 = encode_audio_base64(*audio.audio_and_sample_rate)
    return f"data:audio/ogg;base64,{base64}"


173
174
175
176
177
178
179
180
181
182
def _assert_mm_data_is_image_input(
    mm_data: Optional[MultiModalDataDict],
    image_count: int,
) -> None:
    assert mm_data is not None
    assert set(mm_data.keys()) == {"image"}

    image_data = mm_data.get("image")
    assert image_data is not None

183
    assert isinstance(image_data, list) and len(image_data) == image_count
184
185


186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
def _assert_mm_uuids(
    mm_uuids: Optional[MultiModalUUIDDict],
    media_count: int,
    expected_uuids: list[Optional[str]],
    modality: str = "image",
) -> None:
    if len(expected_uuids) > 0:
        assert mm_uuids is not None
        assert modality in mm_uuids

        image_uuids = mm_uuids.get(modality)
        assert image_uuids is not None

        assert isinstance(image_uuids,
                          list) and len(image_uuids) == media_count

        assert image_uuids == expected_uuids
    else:
        assert mm_uuids is None


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
ModalityType = Literal["image", "video", "audio"]
MultiModalDataCounts = Mapping[ModalityType, int]


def _assert_mm_data_inputs(
    mm_data: Optional[MultiModalDataDict],
    data_count: MultiModalDataCounts,
) -> None:
    assert mm_data is not None
    assert set(data_count.keys()) == (set(mm_data.keys()))

    for modality, n in data_count.items():
        modality_data = mm_data.get(modality)
        assert modality_data is not None
        assert isinstance(modality_data, list) and len(modality_data) == n


224
225
226
227
228
def test_parse_chat_messages_single_image(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
229
    conversation, mm_data, mm_uuids = parse_chat_messages(
230
231
232
        [{
            "role":
            "user",
233
234
235
236
237
238
239
240
241
242
243
244
            "content": [
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    }
                },
                {
                    "type": "text",
                    "text": "What's in the image?"
                },
            ],
245
246
247
248
249
        }],
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
250
251
252
253
254

    assert conversation == [{
        "role": "user",
        "content": "<|image_1|>\nWhat's in the image?"
    }]
255
    _assert_mm_data_is_image_input(mm_data, 1)
256
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[None])
257
258


259
260
261
262
def test_parse_chat_messages_single_image_with_uuid(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
263
):
264
265
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages(
266
        [{
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
            "role":
            "user",
            "content": [
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url,
                    },
                    "uuid": image_uuid,
                },
                {
                    "type": "text",
                    "text": "What's in the image?"
                },
            ],
282
        }],
283
284
        phi3v_model_config,
        phi3v_tokenizer,
285
286
287
288
        content_format="string",
    )

    assert conversation == [{
289
290
        "role": "user",
        "content": "<|image_1|>\nWhat's in the image?"
291
    }]
292
293
    _assert_mm_data_is_image_input(mm_data, 1)
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[image_uuid])
294
295


296
def test_parse_chat_messages_single_image_with_bad_uuid_format(
297
298
299
300
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
301
302
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages(
303
304
305
        [{
            "role":
            "user",
306
307
308
309
310
311
312
313
314
315
316
317
318
319
            "content": [
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url,
                        "uuid": image_uuid,
                    },
                    "bad_uuid_key": image_uuid,
                },
                {
                    "type": "text",
                    "text": "What's in the image?"
                },
            ],
320
321
322
323
324
        }],
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
325
326
327
328
329

    assert conversation == [{
        "role": "user",
        "content": "<|image_1|>\nWhat's in the image?"
    }]
330
331
    _assert_mm_data_is_image_input(mm_data, 1)
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[None])
332
333


334
def test_parse_chat_messages_multiple_images_with_uuids(
335
336
337
338
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
339
340
341
342
    image_uuid1 = "my_uuid_1"
    image_uuid2 = "my_uuid_2"

    conversation, mm_data, mm_uuids = parse_chat_messages(
343
344
345
        [{
            "role":
            "user",
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
            "content": [
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url,
                    },
                    "uuid": image_uuid1,
                },
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url,
                    },
                    "uuid": image_uuid2,
                },
                {
                    "type": "text",
                    "text": "What's in the image?"
                },
            ],
366
367
368
369
370
        }],
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
371
372
373
374
375

    assert conversation == [{
        "role":
        "user",
        "content":
376
        "<|image_1|>\n<|image_2|>\nWhat's in the image?",
377
    }]
378
    _assert_mm_data_is_image_input(mm_data, 2)
379
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid1, image_uuid2])
380
381
382


@pytest.mark.asyncio
383
async def test_parse_chat_messages_single_image_with_uuid_async(
384
385
386
387
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
388
389
    image_uuid = str(hash(image_url))
    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
390
391
392
        [{
            "role":
            "user",
393
394
395
396
397
398
399
400
401
402
403
404
405
            "content": [
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    },
                    "uuid": image_uuid,
                },
                {
                    "type": "text",
                    "text": "What's in the image?"
                },
            ],
406
407
408
409
410
        }],
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
411
412

    assert conversation == [{
413
414
        "role": "user",
        "content": "<|image_1|>\nWhat's in the image?"
415
    }]
416
417
    _assert_mm_data_is_image_input(await mm_future, 1)
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[image_uuid])
418
419


420
421
@pytest.mark.asyncio
async def test_parse_chat_messages_multiple_images_with_uuids_async(
422
423
424
425
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
426
427
428
429
    image_uuid1 = "my_uuid_1"
    image_uuid2 = "my_uuid_2"

    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
430
431
432
        [{
            "role":
            "user",
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
            "content": [
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    },
                    "uuid": image_uuid1,
                },
                {
                    "type": "image_pil",
                    "image_pil": ImageAsset("cherry_blossom").pil_image,
                    "uuid": image_uuid2,
                },
                {
                    "type": "text",
                    "text": "What's in these images?"
                },
            ],
451
452
453
454
455
        }],
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
456

457
458
459
460
    assert conversation == [{
        "role":
        "user",
        "content":
461
        "<|image_1|>\n<|image_2|>\nWhat's in these images?",
462
    }]
463
464
    _assert_mm_data_is_image_input(await mm_future, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid1, image_uuid2])
465
466


467
468
@pytest.mark.asyncio
async def test_parse_chat_messages_multiple_images_with_partial_uuids_async(
469
470
471
472
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
473
474
475
    image_uuid2 = "my_uuid_2"

    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
476
477
478
479
480
481
482
483
        [{
            "role":
            "user",
            "content": [
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
484
                    },
485
486
                },
                {
487
488
489
                    "type": "image_pil",
                    "image_pil": ImageAsset("cherry_blossom").pil_image,
                    "uuid": image_uuid2,
490
491
                },
                {
492
493
494
495
                    "type": "text",
                    "text": "What's in these images?"
                },
            ],
496
497
498
499
500
        }],
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
501
502
503
504
505

    assert conversation == [{
        "role":
        "user",
        "content":
506
        "<|image_1|>\n<|image_2|>\nWhat's in these images?",
507
    }]
508
509
    _assert_mm_data_is_image_input(await mm_future, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, image_uuid2])
510
511


512
513
514
def test_parse_chat_messages_empty_system(
    mistral_model_config,
    mistral_tokenizer,
515
):
516
    # Test string format
517
    conversation, _, _ = parse_chat_messages(
518
519
520
521
522
523
524
525
526
527
528
529
530
        [
            {
                "role": "system",
                "content": ""
            },
            {
                "role": "user",
                "content": [{
                    "type": "text",
                    "text": "Who are you?"
                }],
            },
        ],
531
532
        mistral_model_config,
        mistral_tokenizer,
533
534
        content_format="string",
    )
535
    assert conversation == [
536
537
538
539
        {
            "role": "system",
            "content": ""
        },
540
541
        {
            "role": "user",
542
            "content": "Who are you?"
543
        },
544
    ]
545
546

    # Test openai format
547
    conversation, _, _ = parse_chat_messages(
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
        [
            {
                "role": "system",
                "content": ""
            },
            {
                "role": "user",
                "content": [{
                    "type": "text",
                    "text": "Who are you?"
                }],
            },
        ],
        mistral_model_config,
        mistral_tokenizer,
        content_format="openai",
    )
    assert conversation == [
566
        {
567
            "role": "system",
568
569
570
571
            "content": [{
                "type": "text",
                "text": ""
            }]
572
573
574
        },
        {
            "role": "user",
575
576
577
578
            "content": [{
                "type": "text",
                "text": "Who are you?"
            }]
579
580
581
582
583
        },
    ]


@pytest.mark.asyncio
584
async def test_parse_chat_messages_single_image_async(
585
586
    phi3v_model_config,
    phi3v_tokenizer,
587
    image_url,
588
):
589
    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
590
        [{
591
592
            "role":
            "user",
593
594
595
596
597
598
599
600
601
602
603
604
            "content": [
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    }
                },
                {
                    "type": "text",
                    "text": "What's in the image?"
                },
            ],
605
606
607
608
609
        }],
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
610

611
612
613
614
615
    assert conversation == [{
        "role": "user",
        "content": "<|image_1|>\nWhat's in the image?"
    }]
    _assert_mm_data_is_image_input(await mm_future, 1)
616
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[None])
617
618


619
620
621
622
623
def test_parse_chat_messages_multiple_images(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
624
    conversation, mm_data, mm_uuids = parse_chat_messages(
625
626
627
        [{
            "role":
            "user",
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
            "content": [
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    }
                },
                {
                    "type": "image_pil",
                    "image_pil": ImageAsset("cherry_blossom").pil_image,
                },
                {
                    "type": "text",
                    "text": "What's in these images?"
                },
            ],
644
645
646
647
648
        }],
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
649
650
651
652
653

    assert conversation == [{
        "role":
        "user",
        "content":
654
        "<|image_1|>\n<|image_2|>\nWhat's in these images?",
655
    }]
656
    _assert_mm_data_is_image_input(mm_data, 2)
657
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
658
659
660


@pytest.mark.asyncio
661
662
663
664
665
async def test_parse_chat_messages_multiple_images_async(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
666
    conversation, mm_future, mm_uuids = parse_chat_messages_futures(
667
668
669
        [{
            "role":
            "user",
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
            "content": [
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    }
                },
                {
                    "type": "image_pil",
                    "image_pil": ImageAsset("cherry_blossom").pil_image,
                },
                {
                    "type": "text",
                    "text": "What's in these images?"
                },
            ],
686
687
688
689
690
        }],
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
691

692
693
694
695
    assert conversation == [{
        "role":
        "user",
        "content":
696
        "<|image_1|>\n<|image_2|>\nWhat's in these images?",
697
698
    }]
    _assert_mm_data_is_image_input(await mm_future, 2)
699
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
700

701
702

def test_parse_chat_messages_placeholder_already_in_prompt(
703
704
705
706
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
707
    conversation, mm_data, mm_uuids = parse_chat_messages(
708
709
710
711
        [{
            "role":
            "user",
            "content": [
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    }
                },
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    }
                },
                {
                    "type":
                    "text",
                    "text":
                    "What's in <|image_1|> and how does it compare to <|image_2|>?",  # noqa: E501
                },
            ],
731
732
733
734
735
        }],
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
736
737
738
739
    assert conversation == [{
        "role":
        "user",
        "content":
740
        "What's in <|image_1|> and how does it compare to <|image_2|>?",
741
742
    }]
    _assert_mm_data_is_image_input(mm_data, 2)
743
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
744
745


746
747
def test_parse_chat_messages_placeholder_one_already_in_prompt(
    phi3v_model_config,
748
749
750
    phi3v_tokenizer,
    image_url,
):
751
    conversation, mm_data, mm_uuids = parse_chat_messages(
752
753
754
        [{
            "role":
            "user",
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
            "content": [
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    }
                },
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    }
                },
                {
                    "type":
                    "text",
                    "text":
772
773
774
                    "What's in <|image_1|> and how does it compare to the other one?",  # noqa: E501
                },
            ],
775
        }],
776
        phi3v_model_config,
777
778
779
780
781
782
783
784
        phi3v_tokenizer,
        content_format="string",
    )

    assert conversation == [{
        "role":
        "user",
        "content":
785
        "<|image_2|>\nWhat's in <|image_1|> and how does it compare to the "
786
        "other one?",
787
788
    }]
    _assert_mm_data_is_image_input(mm_data, 2)
789
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
790
791


792
793
def test_parse_chat_messages_multiple_images_across_messages(
    phi3v_model_config,
794
795
796
    phi3v_tokenizer,
    image_url,
):
797
    conversation, mm_data, mm_uuids = parse_chat_messages(
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
        [
            {
                "role":
                "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        }
                    },
                    {
                        "type": "text",
                        "text": "What's in this image?"
                    },
                ],
            },
            {
                "role": "assistant",
                "content": "Some stuff."
            },
            {
                "role":
                "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        }
                    },
                    {
                        "type": "text",
                        "text": "What about this one?"
                    },
                ],
            },
        ],
836
837
838
839
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854

    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\nWhat's in this image?"
        },
        {
            "role": "assistant",
            "content": "Some stuff."
        },
        {
            "role": "user",
            "content": "<|image_2|>\nWhat about this one?"
        },
    ]
855
    _assert_mm_data_is_image_input(mm_data, 2)
856
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
857
858


859
def test_parse_chat_messages_multiple_images_with_uuids_across_messages(
860
861
    phi3v_model_config,
    phi3v_tokenizer,
862
    image_url,
863
):
864
865
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages(
866
867
        [
            {
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
                "role":
                "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        },
                        "uuid": image_uuid,
                    },
                    {
                        "type": "text",
                        "text": "What's in this image?"
                    },
                ],
883
884
885
886
887
888
            },
            {
                "role": "assistant",
                "content": "Some stuff."
            },
            {
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
                "role":
                "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        },
                        "uuid": image_uuid,
                    },
                    {
                        "type": "text",
                        "text": "What about this one?"
                    },
                ],
            },
        ],
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )

    assert conversation == [
        {
            "role": "user",
            "content": "<|image_1|>\nWhat's in this image?"
        },
        {
            "role": "assistant",
            "content": "Some stuff."
        },
        {
            "role": "user",
            "content": "<|image_2|>\nWhat about this one?"
        },
    ]
    _assert_mm_data_is_image_input(mm_data, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid, image_uuid])


def test_parse_chat_messages_context_text_format(
    phi3v_model_config,
    phi3v_tokenizer,
):
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
                "role": "user",
                "content": [{
                    "type": "text",
                    "text": "What's in this text?"
                }],
            },
            {
                "role": "assistant",
                "content": "Some stuff."
            },
            {
                "role": "user",
                "content": "What about this one?"
949
950
            },
        ],
951
952
953
954
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="openai",
    )
955
956
957
958
959
960
961

    assert conversation == [
        {
            "role": "user",
            "content": [{
                "type": "text",
                "text": "What's in this text?"
962
            }],
963
964
965
966
967
968
        },
        {
            "role": "assistant",
            "content": [{
                "type": "text",
                "text": "Some stuff."
969
            }],
970
971
972
973
974
975
        },
        {
            "role": "user",
            "content": [{
                "type": "text",
                "text": "What about this one?"
976
            }],
977
978
        },
    ]
979
980
    assert mm_data is None
    assert mm_uuids is None
981
982


983
984
985
986
987
def test_parse_chat_messages_rejects_too_many_images_in_one_message(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
988
989
990
    with warnings.catch_warnings():
        warnings.filterwarnings(
            "ignore",
991
992
            message="coroutine 'async_get_and_parse_image' was never awaited",
        )
993
        with pytest.raises(ValueError, match="At most"):
994
995
996
997
            parse_chat_messages(
                [{
                    "role":
                    "user",
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
                    "content": [
                        {
                            "type": "image_url",
                            "image_url": {
                                "url": image_url
                            },
                        },
                        {
                            "type": "image_url",
                            "image_url": {
                                "url": image_url
                            },
                        },
                        {
                            "type": "image_url",
                            "image_url": {
                                "url": image_url
                            },
                        },
                        {
                            "type": "text",
                            "text": "What's in these images?"
                        },
                    ],
1022
1023
1024
1025
1026
                }],
                phi3v_model_config,
                phi3v_tokenizer,
                content_format="string",
            )
1027
1028


1029
1030
1031
1032
1033
def test_parse_chat_messages_rejects_too_many_images_across_messages(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
1034
1035
1036
    with warnings.catch_warnings():
        warnings.filterwarnings(
            "ignore",
1037
1038
            message="coroutine 'async_get_and_parse_image' was never awaited",
        )
1039
        with pytest.raises(ValueError, match="At most"):
1040
            parse_chat_messages(
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
                [
                    {
                        "role":
                        "user",
                        "content": [
                            {
                                "type": "image_url",
                                "image_url": {
                                    "url": image_url
                                },
                            },
                            {
                                "type": "text",
                                "text": "What's in this image?"
                            },
                        ],
                    },
                    {
                        "role": "assistant",
                        "content": "Some stuff."
                    },
                    {
                        "role":
                        "user",
                        "content": [
                            {
                                "type": "image_url",
                                "image_url": {
                                    "url": image_url
                                },
                            },
                            {
                                "type": "image_url",
                                "image_url": {
                                    "url": image_url
                                },
                            },
                            {
                                "type": "text",
                                "text": "What about these two?"
                            },
                        ],
                    },
                ],
1085
1086
1087
1088
                phi3v_model_config,
                phi3v_tokenizer,
                content_format="string",
            )
1089
1090
1091
1092
1093
1094
1095


def test_parse_chat_messages_multiple_images_uncommon_input(
    phi3v_model_config,
    phi3v_tokenizer,
    image_url,
):
1096
    conversation, mm_data, mm_uuids = parse_chat_messages(
1097
1098
1099
1100
        [{
            "role":
            "user",
            "content": [
1101
1102
                "What's in these images?",
                {
1103
                    "image_url": image_url
1104
1105
                },
                {
1106
                    "image_url": image_url
1107
1108
                },
            ],
1109
1110
1111
1112
1113
        }],
        phi3v_model_config,
        phi3v_tokenizer,
        content_format="string",
    )
1114
1115
1116
1117
1118

    assert conversation == [{
        "role":
        "user",
        "content":
1119
        "<|image_1|>\n<|image_2|>\nWhat's in these images?",
1120
1121
    }]
    _assert_mm_data_is_image_input(mm_data, 2)
1122
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1123
1124


1125
1126
1127
1128
1129
def test_parse_chat_messages_multiple_images_interleave(
    phi3v_model_config_mm_interleaved,
    phi3v_tokenizer,
    image_url,
):
1130
    conversation, mm_data, mm_uuids = parse_chat_messages(
1131
1132
1133
        [{
            "role":
            "user",
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
            "content": [
                {
                    "type": "text",
                    "text": "I need you to compare this image",
                },
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    }
                },
                {
                    "type": "text",
                    "text": "and this one"
                },
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    }
                },
                {
                    "type": "text",
                    "text": "Do they have differences?"
                },
            ],
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
        }],
        phi3v_model_config_mm_interleaved,
        phi3v_tokenizer,
        content_format="string",
    )

    assert conversation == [{
        "role":
        "user",
        "content":
        "I need you to compare this image\n<|image_1|>\nand this one\n<|image_2|>\n"  # noqa: E501
1171
        "Do they have differences?",
1172
1173
    }]
    _assert_mm_data_is_image_input(mm_data, 2)
1174
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1175
1176
1177
1178
1179
1180
1181
1182


@pytest.mark.asyncio
async def test_parse_chat_messages_multiple_images_interleave_async(
    phi3v_model_config_mm_interleaved,
    phi3v_tokenizer,
    image_url,
):
1183
    conversation, mm_data, mm_uuids = parse_chat_messages_futures(
1184
1185
1186
        [{
            "role":
            "user",
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
            "content": [
                {
                    "type": "text",
                    "text": "I need you to compare this image",
                },
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    }
                },
                {
                    "type": "text",
                    "text": "and this one"
                },
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    }
                },
                {
                    "type": "text",
                    "text": "Do they have differences?"
                },
            ],
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
        }],
        phi3v_model_config_mm_interleaved,
        phi3v_tokenizer,
        content_format="string",
    )

    assert conversation == [{
        "role":
        "user",
        "content":
        "I need you to compare this image\n<|image_1|>\nand this one\n<|image_2|>\n"  # noqa: E501
1224
        "Do they have differences?",
1225
1226
    }]
    _assert_mm_data_is_image_input(await mm_data, 2)
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
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
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])


@pytest.mark.asyncio
async def test_parse_chat_messages_multiple_images_with_uuids_interleave_async(
    phi3v_model_config_mm_interleaved,
    phi3v_tokenizer,
    image_url,
):
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages_futures(
        [{
            "role":
            "user",
            "content": [
                {
                    "type": "text",
                    "text": "I need you to compare this image",
                },
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    },
                    "uuid": image_uuid,
                },
                {
                    "type": "text",
                    "text": "and this one"
                },
                {
                    "type": "image_url",
                    "image_url": {
                        "url": image_url
                    },
                    "uuid": image_uuid,
                },
                {
                    "type": "text",
                    "text": "Do they have differences?"
                },
            ],
        }],
        phi3v_model_config_mm_interleaved,
        phi3v_tokenizer,
        content_format="string",
    )

    assert conversation == [{
        "role":
        "user",
        "content":
        "I need you to compare this image\n<|image_1|>\nand this one\n<|image_2|>\n"  # noqa: E501
        "Do they have differences?",
    }]
    _assert_mm_data_is_image_input(await mm_data, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid, image_uuid])
1284
1285
1286
1287
1288
1289
1290


def test_parse_chat_messages_multiple_images_multiple_messages_interleave(
    phi3v_model_config_mm_interleaved,
    phi3v_tokenizer,
    image_url,
):
1291
    conversation, mm_data, mm_uuids = parse_chat_messages(
1292
1293
1294
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
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
        [
            {
                "role":
                "user",
                "content": [
                    {
                        "type": "text",
                        "text": "What's on this image?"
                    },
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        }
                    },
                    {
                        "type": "text",
                        "text": "Be accurate."
                    },
                ],
            },
            {
                "role": "assistant",
                "content": "Some stuff."
            },
            {
                "role":
                "user",
                "content": [
                    {
                        "type": "text",
                        "text": "What's on this image?"
                    },
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        }
                    },
                ],
            },
        ],
1334
1335
1336
1337
1338
        phi3v_model_config_mm_interleaved,
        phi3v_tokenizer,
        content_format="string",
    )

1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
    assert conversation == [
        {
            "role": "user",
            "content": "What's on this image?\n<|image_1|>\nBe accurate.",
        },
        {
            "role": "assistant",
            "content": "Some stuff."
        },
        {
            "role": "user",
            "content": "What's on this image?\n<|image_2|>"
        },
    ]
1353
    _assert_mm_data_is_image_input(mm_data, 2)
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
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
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])


def test_parse_chat_messages_multiple_images_with_uuids_multiple_messages_interleave(  # noqa: E501
    phi3v_model_config_mm_interleaved,
    phi3v_tokenizer,
    image_url,
):
    image_uuid = str(hash(image_url))
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
                "role":
                "user",
                "content": [
                    {
                        "type": "text",
                        "text": "What's on this image?"
                    },
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        },
                        "uuid": image_uuid,
                    },
                    {
                        "type": "text",
                        "text": "Be accurate."
                    },
                ],
            },
            {
                "role": "assistant",
                "content": "Some stuff."
            },
            {
                "role":
                "user",
                "content": [
                    {
                        "type": "text",
                        "text": "What's on this image?"
                    },
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        },
                        "uuid": image_uuid,
                    },
                ],
            },
        ],
        phi3v_model_config_mm_interleaved,
        phi3v_tokenizer,
        content_format="string",
    )

    assert conversation == [
        {
            "role": "user",
            "content": "What's on this image?\n<|image_1|>\nBe accurate.",
        },
        {
            "role": "assistant",
            "content": "Some stuff."
        },
        {
            "role": "user",
            "content": "What's on this image?\n<|image_2|>"
        },
    ]
    _assert_mm_data_is_image_input(mm_data, 2)
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[image_uuid, image_uuid])
1429
1430
1431


def test_parse_chat_messages_multiple_modals_multiple_messages_interleave(
1432
1433
1434
1435
1436
1437
    qwen25omni_model_config_mm_interleaved,
    qwen25omni_tokenizer,
    image_url,
    video_url,
    audio_url,
):
1438
    conversation, mm_data, mm_uuids = parse_chat_messages(
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
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
        [
            {
                "role":
                "user",
                "content": [
                    {
                        "type": "text",
                        "text": "What's on this image?"
                    },
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        }
                    },
                    {
                        "type": "text",
                        "text": "Now listen to this audio"
                    },
                    {
                        "type": "audio_url",
                        "audio_url": {
                            "url": audio_url
                        }
                    },
                ],
            },
            {
                "role": "assistant",
                "content": "Some stuff."
            },
            {
                "role":
                "user",
                "content": [
                    {
                        "type": "text",
                        "text": "What's on this image?"
                    },
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        }
                    },
                    {
                        "type": "text",
                        "text": "And what's in the video?"
                    },
                    {
                        "type": "video_url",
                        "video_url": {
                            "url": video_url
                        }
                    },
                ],
            },
        ],
        qwen25omni_model_config_mm_interleaved,
        qwen25omni_tokenizer,
1499
1500
1501
        content_format="string",
    )

1502
1503
    assert conversation == [
        {
1504
1505
            "role":
            "user",
1506
1507
1508
1509
1510
            "content":
            "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>\n"
            "Now listen to this audio\nAudio 1: <|audio_bos|><|AUDIO|><|audio_eos|>",  # noqa: E501
        },
        {
1511
1512
            "role": "assistant",
            "content": "Some stuff."
1513
1514
        },
        {
1515
1516
            "role":
            "user",
1517
1518
1519
1520
1521
            "content":
            "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>\n"
            "And what's in the video?\n<|vision_start|><|VIDEO|><|vision_end|>",
        },
    ]
1522
1523

    _assert_mm_data_inputs(mm_data, {"image": 2, "video": 1, "audio": 1})
1524
1525
1526
1527
1528
1529
    _assert_mm_uuids(mm_uuids,
                     2,
                     modality="image",
                     expected_uuids=[None, None])
    _assert_mm_uuids(mm_uuids, 1, modality="video", expected_uuids=[None])
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=[None])
1530
1531


1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
def test_parse_chat_messages_multiple_modals_with_uuids_multiple_messages_interleave(  # noqa: E501
    qwen25omni_model_config_mm_interleaved,
    qwen25omni_tokenizer,
    image_url,
    video_url,
    audio_url,
):
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
                "role":
                "user",
                "content": [
                    {
                        "type": "text",
                        "text": "What's on this image?"
                    },
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        },
                        "uuid": "image_123",
                    },
                    {
                        "type": "text",
                        "text": "Now listen to this audio"
                    },
                    {
                        "type": "audio_url",
                        "audio_url": {
                            "url": audio_url
                        },
                        "uuid": "audio_123",
                    },
                ],
            },
            {
                "role": "assistant",
                "content": "Some stuff."
            },
            {
                "role":
                "user",
                "content": [
                    {
                        "type": "text",
                        "text": "What's on this image?"
                    },
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        },
                        "uuid": "image_123",
                    },
                    {
                        "type": "text",
                        "text": "And what's in the video?"
                    },
                    {
                        "type": "video_url",
                        "video_url": {
                            "url": video_url
                        },
                        "uuid": "video_123",
                    },
                ],
            },
        ],
        qwen25omni_model_config_mm_interleaved,
        qwen25omni_tokenizer,
        content_format="string",
    )

    assert conversation == [
        {
1609
1610
            "role":
            "user",
1611
1612
1613
1614
1615
            "content":
            "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>\n"
            "Now listen to this audio\nAudio 1: <|audio_bos|><|AUDIO|><|audio_eos|>",  # noqa: E501
        },
        {
1616
1617
            "role": "assistant",
            "content": "Some stuff."
1618
1619
        },
        {
1620
1621
            "role":
            "user",
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
            "content":
            "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>\n"
            "And what's in the video?\n<|vision_start|><|VIDEO|><|vision_end|>",
        },
    ]

    _assert_mm_data_inputs(mm_data, {"image": 2, "video": 1, "audio": 1})
    _assert_mm_uuids(mm_uuids,
                     2,
                     modality="image",
                     expected_uuids=["image_123", "image_123"])
    _assert_mm_uuids(mm_uuids,
                     1,
                     modality="video",
                     expected_uuids=["video_123"])
    _assert_mm_uuids(mm_uuids,
                     1,
                     modality="audio",
                     expected_uuids=["audio_123"])


def test_parse_chat_messages_multiple_modals_with_partial_uuids_multiple_messages_interleave(  # noqa: E501
    qwen25omni_model_config_mm_interleaved,
    qwen25omni_tokenizer,
    image_url,
    video_url,
    audio_url,
):
    conversation, mm_data, mm_uuids = parse_chat_messages(
        [
            {
                "role":
                "user",
                "content": [
                    {
                        "type": "text",
                        "text": "What's on this image?"
                    },
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        },
                        "uuid": "image_123",
                    },
                    {
                        "type": "text",
                        "text": "Now listen to this audio"
                    },
                    {
                        "type": "audio_url",
                        "audio_url": {
                            "url": audio_url
                        }
                    },
                ],
            },
            {
                "role": "assistant",
                "content": "Some stuff."
            },
            {
                "role":
                "user",
                "content": [
                    {
                        "type": "text",
                        "text": "What's on this image?"
                    },
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        }
                    },
                    {
                        "type": "text",
                        "text": "And what's in the video?"
                    },
                    {
                        "type": "video_url",
                        "video_url": {
                            "url": video_url
                        },
                        "uuid": "video_123",
                    },
                ],
            },
        ],
1711
1712
1713
1714
1715
        qwen25omni_model_config_mm_interleaved,
        qwen25omni_tokenizer,
        content_format="string",
    )

1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
    assert conversation == [
        {
            "role":
            "user",
            "content":
            "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>\n"
            "Now listen to this audio\nAudio 1: <|audio_bos|><|AUDIO|><|audio_eos|>",  # noqa: E501
        },
        {
            "role": "assistant",
            "content": "Some stuff."
        },
        {
            "role":
            "user",
            "content":
            "What's on this image?\n<|vision_start|><|IMAGE|><|vision_end|>\n"
            "And what's in the video?\n<|vision_start|><|VIDEO|><|vision_end|>",
        },
    ]
1736
1737

    _assert_mm_data_inputs(mm_data, {"image": 2, "video": 1, "audio": 1})
1738
1739
1740
1741
1742
1743
1744
1745
1746
    _assert_mm_uuids(mm_uuids,
                     2,
                     modality="image",
                     expected_uuids=["image_123", None])
    _assert_mm_uuids(mm_uuids,
                     1,
                     modality="video",
                     expected_uuids=["video_123"])
    _assert_mm_uuids(mm_uuids, 1, modality="audio", expected_uuids=[None])
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756


def test_parse_chat_messages_multiple_images_interleave_with_placeholders(
    phi3v_model_config_mm_interleaved,
    phi3v_tokenizer,
    image_url,
):
    with pytest.raises(
            ValueError,
            match=r"Found more '<|image_1|>' placeholders in input prompt "
1757
1758
            "than actual multimodal data items.",
    ):
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
        parse_chat_messages(
            [{
                "role":
                "user",
                "content": [
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        }
                    },
                    {
                        "type": "image_url",
                        "image_url": {
                            "url": image_url
                        }
                    },
                    {
                        "type":
                        "text",
                        "text":
                        "I need you to compare this image\n<|image_1|>\nand this one\n<|image_2|>\n"  # noqa: E501
1781
                        "Do they have differences?",
1782
                    },
1783
                ],
1784
1785
1786
1787
1788
1789
1790
            }],
            phi3v_model_config_mm_interleaved,
            phi3v_tokenizer,
            content_format="string",
        )


1791
1792
1793
1794
1795
1796
1797
### Mllama currently wraps images / texts as interleaved dictionaries
def test_mllama_single_image(
    mllama_model_config,
    mllama_tokenizer,
    image_url,
):
    """Ensures that a single image is parsed correctly mllama."""
1798
    conversation, mm_data, mm_uuids = parse_chat_messages(
1799
1800
1801
        [{
            "role":
            "user",
1802
1803
1804
1805
1806
1807
1808
1809
1810
            "content": [
                {
                    "type": "text",
                    "text": "The content of this image is:"
                },
                {
                    "image_url": image_url
                },
            ],
1811
1812
1813
1814
1815
        }],
        mllama_model_config,
        mllama_tokenizer,
        content_format="openai",
    )
1816
    _assert_mm_data_is_image_input(mm_data, 1)
1817
    _assert_mm_uuids(mm_uuids, 1, expected_uuids=[None])
1818
    assert conversation == [{
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
        "role":
        "user",
        "content": [
            {
                "type": "text",
                "text": "The content of this image is:"
            },
            {
                "type": "image"
            },
        ],
1830
1831
1832
1833
1834
1835
1836
1837
1838
    }]


def test_mllama_interleaved_images(
    mllama_model_config,
    mllama_tokenizer,
    image_url,
):
    """Ensures that multiple image are parsed as interleaved dicts."""
1839
    conversation, mm_data, mm_uuids = parse_chat_messages(
1840
1841
1842
1843
1844
        [{
            "role":
            "user",
            "content": [
                {
1845
1846
                    "type": "text",
                    "text": "The content of the first image is:",
1847
1848
1849
1850
1851
                },
                {
                    "image_url": image_url
                },
                {
1852
1853
                    "type": "text",
                    "text": "The content of the second image is:",
1854
1855
1856
1857
                },
                {
                    "image_url": image_url
                },
1858
            ],
1859
1860
1861
1862
1863
        }],
        mllama_model_config,
        mllama_tokenizer,
        content_format="openai",
    )
1864
    _assert_mm_data_is_image_input(mm_data, 2)
1865
    _assert_mm_uuids(mm_uuids, 2, expected_uuids=[None, None])
1866
    assert conversation == [{
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
        "role":
        "user",
        "content": [
            {
                "type": "text",
                "text": "The content of the first image is:"
            },
            {
                "type": "image"
            },
            {
                "type": "text",
                "text": "The content of the second image is:"
            },
            {
                "type": "image"
            },
        ],
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
    }]


@pytest.mark.parametrize("model", [MLLAMA_MODEL_ID])
def test_multimodal_image_parsing_matches_hf(model, image_url):
    """Checks end to end hf alignment for multimodal [image] parsing."""

    def get_conversation(is_hf: bool):
        img_part = {"type": "image_url", "image_url": {"url": image_url}}
        if is_hf:
1895
            img_part = {"type": "image"}
1896
        return [{
1897
1898
1899
            "role":
            "user",
            "content": [
1900
                {
1901
1902
                    "type": "text",
                    "text": "The content of the first image is:",
1903
1904
1905
                },
                img_part,
                {
1906
1907
                    "type": "text",
                    "text": "The content of the second image is:",
1908
1909
1910
                },
                img_part,
                {
1911
1912
                    "type": "text",
                    "text": "What animal is in the first image?",
1913
                },
1914
            ],
1915
1916
1917
        }]

    # Build a config for the model
1918
1919
1920
1921
1922
1923
1924
    model_config = ModelConfig(
        model,
        runner="generate",
        limit_mm_per_prompt={
            "image": 2,
        },
    )
1925
1926
1927

    # Build the tokenizer group and grab the underlying tokenizer
    tokenizer_group = TokenizerGroup(
1928
        model,
1929
1930
1931
        enable_lora=False,
        max_num_seqs=5,
        max_input_length=None,
1932
        trust_remote_code=model_config.trust_remote_code,
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
    )
    tokenizer = tokenizer_group.tokenizer

    # Build and parse a conversation with {"type": "image"} using the tokenizer
    hf_conversation = get_conversation(is_hf=True)
    hf_result = tokenizer.apply_chat_template(
        hf_conversation,
        tokenize=False,
        add_generation_prompt=True,
    )

    # Now parse with vLLMs chat utils & apply the template
    vllm_conversation = get_conversation(is_hf=False)
1946
    conversation, _, _ = parse_chat_messages(
1947
1948
1949
        vllm_conversation,
        model_config,
        tokenizer_group,
1950
        content_format="openai",
1951
1952
1953
    )

    vllm_result = apply_hf_chat_template(
1954
        tokenizer=tokenizer,
1955
1956
        conversation=conversation,
        chat_template=None,
1957
        model_config=model_config,
1958
        tools=None,
1959
1960
1961
1962
        add_generation_prompt=True,
    )

    assert hf_result == vllm_result
1963
1964


1965
1966
1967
1968
1969
@pytest.mark.parametrize(
    "model",
    [
        QWEN2VL_MODEL_ID,  # tokenizer.chat_template is of type str
        HERMES_MODEL_ID,  # tokenizer.chat_template is of type dict
1970
1971
    ],
)
1972
1973
1974
@pytest.mark.parametrize("use_tools", [True, False])
def test_resolve_hf_chat_template(sample_json_schema, model, use_tools):
    """checks that chat_template is a dict type for HF models."""
1975
1976
1977
1978
1979
1980
1981
    model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
    model_info.check_available_online(on_fail="skip")

    model_config = ModelConfig(
        model,
        tokenizer=model_info.tokenizer or model,
        tokenizer_mode=model_info.tokenizer_mode,
1982
        revision=model_info.revision,
1983
1984
        trust_remote_code=model_info.trust_remote_code,
        hf_overrides=model_info.hf_overrides,
1985
1986
1987
        skip_tokenizer_init=model_info.skip_tokenizer_init,
        enforce_eager=model_info.enforce_eager,
        dtype=model_info.dtype)
1988
1989
1990
1991
1992
1993
1994

    # Build the tokenizer group and grab the underlying tokenizer
    tokenizer_group = TokenizerGroup(
        model,
        enable_lora=False,
        max_num_seqs=5,
        max_input_length=None,
1995
        trust_remote_code=model_config.trust_remote_code,
1996
1997
1998
    )
    tokenizer = tokenizer_group.tokenizer

1999
    tools = ([{
2000
2001
2002
2003
        "type": "function",
        "function": {
            "name": "dummy_function_name",
            "description": "This is a dummy function",
2004
2005
2006
            "parameters": sample_json_schema,
        },
    }] if use_tools else None)
2007
2008

    # Test detecting the tokenizer's chat_template
2009
    chat_template = resolve_hf_chat_template(
2010
2011
2012
        tokenizer,
        chat_template=None,
        tools=tools,
2013
        model_config=model_config,
2014
2015
2016
2017
    )
    assert isinstance(chat_template, str)


2018
2019
# NOTE: Qwen2-Audio default chat template is specially defined inside
# processor class instead of using `tokenizer_config.json`
2020
2021
2022
2023
2024
# yapf: disable
@pytest.mark.parametrize(
    ("model", "expected_format"),
    [(PHI3V_MODEL_ID, "string"),
     (QWEN2VL_MODEL_ID, "openai"),
2025
     (QWEN25VL_MODEL_ID, "openai"),
2026
     (ULTRAVOX_MODEL_ID, "string"),
2027
     (QWEN2AUDIO_MODEL_ID, "openai"),
2028
2029
2030
2031
2032
     (MLLAMA_MODEL_ID, "openai"),
     (LLAMA_GUARD_MODEL_ID, "openai")],
)
# yapf: enable
def test_resolve_content_format_hf_defined(model, expected_format):
2033
2034
2035
2036
2037
2038
2039
    model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
    model_info.check_available_online(on_fail="skip")

    model_config = ModelConfig(
        model,
        tokenizer=model_info.tokenizer or model,
        tokenizer_mode=model_info.tokenizer_mode,
2040
        revision=model_info.revision,
2041
2042
        trust_remote_code=model_info.trust_remote_code,
        hf_overrides=model_info.hf_overrides,
2043
2044
2045
        skip_tokenizer_init=model_info.skip_tokenizer_init,
        enforce_eager=model_info.enforce_eager,
        dtype=model_info.dtype)
2046

2047
2048
2049
2050
2051
    tokenizer_group = TokenizerGroup(
        model,
        enable_lora=False,
        max_num_seqs=5,
        max_input_length=None,
2052
        trust_remote_code=model_config.trust_remote_code,
2053
2054
2055
    )
    tokenizer = tokenizer_group.tokenizer

2056
    # Test detecting the tokenizer's chat_template
2057
    chat_template = resolve_hf_chat_template(
2058
2059
2060
        tokenizer,
        chat_template=None,
        tools=None,
2061
        model_config=model_config,
2062
    )
2063
2064
2065
2066
2067
2068
2069
2070
2071
    assert isinstance(chat_template, str)

    print("[TEXT]")
    print(chat_template)
    print("[AST]")
    print(_try_extract_ast(chat_template))

    resolved_format = resolve_chat_template_content_format(
        None,  # Test detecting the tokenizer's chat_template
2072
        None,
2073
2074
        "auto",
        tokenizer,
2075
        model_config=model_config,
2076
2077
2078
2079
2080
2081
2082
2083
    )

    assert resolved_format == expected_format


# yapf: disable
@pytest.mark.parametrize(
    ("model", "expected_format"),
2084
2085
2086
2087
2088
2089
2090
2091
    [(os.path.join(models_path_prefix, "Salesforce/blip2-opt-2.7b"), "string"),
     (os.path.join(models_path_prefix, "facebook/chameleon-7b"), "string"),
     (os.path.join(models_path_prefix, "deepseek-ai/deepseek-vl2-tiny"), "string"),
     (os.path.join(models_path_prefix, "microsoft/Florence-2-base"), "string"),
     (os.path.join(models_path_prefix, "adept/fuyu-8b"), "string"),
     (os.path.join(models_path_prefix, "google/paligemma-3b-mix-224"), "string"),
     (os.path.join(models_path_prefix, "Qwen/Qwen-VL"), "string"),
     (os.path.join(models_path_prefix, "Qwen/Qwen-VL-Chat"), "string")],
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
)
# yapf: enable
def test_resolve_content_format_fallbacks(model, expected_format):
    model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
    model_info.check_available_online(on_fail="skip")

    model_config = ModelConfig(
        model,
        tokenizer=model_info.tokenizer or model,
        tokenizer_mode=model_info.tokenizer_mode,
2102
        revision=model_info.revision,
2103
2104
        trust_remote_code=model_info.trust_remote_code,
        hf_overrides=model_info.hf_overrides,
2105
2106
2107
        skip_tokenizer_init=model_info.skip_tokenizer_init,
        enforce_eager=model_info.enforce_eager,
        dtype=model_info.dtype)
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122

    tokenizer_group = TokenizerGroup(
        model_config.tokenizer,
        enable_lora=False,
        max_num_seqs=5,
        max_input_length=None,
        trust_remote_code=model_config.trust_remote_code,
    )
    tokenizer = tokenizer_group.tokenizer

    # Test detecting the tokenizer's chat_template
    chat_template = resolve_hf_chat_template(
        tokenizer,
        chat_template=None,
        tools=None,
2123
        model_config=model_config,
2124
2125
2126
2127
2128
2129
2130
2131
2132
    )
    assert isinstance(chat_template, str)

    print("[TEXT]")
    print(chat_template)
    print("[AST]")
    print(_try_extract_ast(chat_template))

    resolved_format = resolve_chat_template_content_format(
2133
        None,  # Test detecting the tokenizer's chat_template
2134
        None,
2135
2136
        "auto",
        tokenizer,
2137
        model_config=model_config,
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
    )

    assert resolved_format == expected_format


# yapf: disable
@pytest.mark.parametrize(
    ("template_path", "expected_format"),
    [("template_alpaca.jinja", "string"),
     ("template_baichuan.jinja", "string"),
     ("template_chatglm.jinja", "string"),
     ("template_chatglm2.jinja", "string"),
     ("template_chatml.jinja", "string"),
2151
     ("template_dse_qwen2_vl.jinja", "openai"),
2152
2153
2154
     ("template_falcon_180b.jinja", "string"),
     ("template_falcon.jinja", "string"),
     ("template_inkbot.jinja", "string"),
2155
     ("template_teleflm.jinja", "string"),
2156
2157
2158
2159
     ("template_vlm2vec.jinja", "openai"),
     ("tool_chat_template_granite_20b_fc.jinja", "string"),
     ("tool_chat_template_hermes.jinja", "string"),
     ("tool_chat_template_internlm2_tool.jinja", "string"),
2160
2161
     ("tool_chat_template_llama3.1_json.jinja", "openai"),
     ("tool_chat_template_llama3.2_json.jinja", "openai"),
2162
2163
2164
2165
2166
     ("tool_chat_template_mistral_parallel.jinja", "string"),
     ("tool_chat_template_mistral.jinja", "string")],
)
# yapf: enable
def test_resolve_content_format_examples(template_path, expected_format):
2167
2168
2169
2170
2171
2172
    model_config = ModelConfig(
        PHI3V_MODEL_ID,  # Dummy
        tokenizer=PHI3V_MODEL_ID,  # Dummy
        trust_remote_code=True,
    )

2173
    tokenizer_group = TokenizerGroup(
2174
        PHI3V_MODEL_ID,  # Dummy
2175
2176
2177
        enable_lora=False,
        max_num_seqs=5,
        max_input_length=None,
2178
        trust_remote_code=model_config.trust_remote_code,
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
    )
    dummy_tokenizer = tokenizer_group.tokenizer
    dummy_tokenizer.chat_template = None

    chat_template = load_chat_template(EXAMPLES_DIR / template_path)
    assert isinstance(chat_template, str)

    print("[TEXT]")
    print(chat_template)
    print("[AST]")
    print(_try_extract_ast(chat_template))

    resolved_format = resolve_chat_template_content_format(
        chat_template,
2193
        None,
2194
2195
        "auto",
        dummy_tokenizer,
2196
        model_config=model_config,
2197
2198
2199
    )

    assert resolved_format == expected_format
Julien Denize's avatar
Julien Denize committed
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236


def test_parse_chat_messages_include_thinking_chunk(mistral_model_config,
                                                    mistral_tokenizer):
    messages = [{
        "role":
        "system",
        "content": [{
            "type": "text",
            "text": "You are a helpful assistant."
        }, {
            "type":
            "thinking",
            "closed":
            True,
            "thinking":
            "Only return the answer when you are confident."
        }]
    }, {
        "role": "user",
        "content": "What is 2+2?"
    }, {
        "role":
        "assistant",
        "content": [{
            "type": "text",
            "text": "Let me think about it."
        }, {
            "type": "thinking",
            "closed": True,
            "thinking": "2+2 = 4"
        }, {
            "type": "text",
            "text": "The answer is 4.",
        }],
    }]

2237
    conversation_with_thinking, _, _ = parse_chat_messages(
Julien Denize's avatar
Julien Denize committed
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
        messages,
        mistral_model_config,
        mistral_tokenizer,
        content_format="openai",
    )

    expected_conversation = [{
        "role":
        "system",
        "content": [{
            "type": "text",
            "text": "You are a helpful assistant."
        }, {
            "type": "text",
            "text": "Only return the answer when you are confident."
        }],
    }, {
        "role":
        "user",
        "content": [{
            "type": "text",
            "text": "What is 2+2?"
        }],
    }, {
        "role":
        "assistant",
        "content": [
            {
                "type": "text",
                "text": "Let me think about it."
            },
            {
                "type": "text",
                "text": "2+2 = 4"
            },
            {
                "type": "text",
                "text": "The answer is 4."
            },
        ]
    }]

    assert conversation_with_thinking == expected_conversation


def test_apply_mistral_chat_template_thinking_chunk():
    # Moved import here to avoid yapf and isort conflicts
    from vllm.entrypoints.chat_utils import apply_mistral_chat_template
    messages = [{
        "role":
        "system",
        "content": [{
            "type": "text",
            "text": "You are a helpful assistant."
        }, {
            "type":
            "thinking",
            "closed":
            True,
            "thinking":
            "Only return the answer when you are confident."
        }]
    }, {
        "role": "user",
        "content": "What is 2+2?"
    }, {
        "role":
        "assistant",
        "content": [{
            "type": "text",
            "text": "Let me think about it."
        }, {
            "type": "thinking",
            "closed": True,
            "thinking": "2+2 = 4"
        }, {
            "type": "text",
            "text": "The answer is 4.",
        }],
    }, {
        "role": "user",
        "content": "Thanks, what is 3+3?"
    }]

    # TODO(Julien): upon model release change to a tokenizer already configured.
    # =================================================================
    mistral_tokenizer = MistralTokenizer.from_pretrained(
        "mistralai/Devstral-Small-2507")
    assert isinstance(mistral_tokenizer.tokenizer, Tekkenizer)
    # Add think special tokens to the tokenizer
    mistral_tokenizer.tokenizer._all_special_tokens[35] = SpecialTokenInfo(
        rank=35, is_control=True, token_str=SpecialTokens.begin_think.value)
    mistral_tokenizer.tokenizer._all_special_tokens[36] = SpecialTokenInfo(
        rank=36, is_control=True, token_str=SpecialTokens.end_think.value)
    mistral_tokenizer.tokenizer._special_tokens_reverse_vocab = {
        k: v
        for k, v in
        mistral_tokenizer.tokenizer._special_tokens_reverse_vocab.items()
        if v not in {35, 36}
    }
    mistral_tokenizer.tokenizer._special_tokens_reverse_vocab[
        SpecialTokens.begin_think.value] = 35
    mistral_tokenizer.tokenizer._special_tokens_reverse_vocab[
        SpecialTokens.end_think.value] = 36
    mistral_tokenizer.instruct.BEGIN_THINK = 35
    mistral_tokenizer.instruct.END_THINK = 36
    # =================================================================

    tokens_ids = apply_mistral_chat_template(mistral_tokenizer,
                                             messages,
                                             chat_template=None,
                                             tools=None)

    string_tokens = mistral_tokenizer.mistral.decode(
        tokens_ids, special_token_policy=SpecialTokenPolicy.KEEP)

    expected_tokens = (
        r"<s>[SYSTEM_PROMPT]You are a helpful assistant.[THINK]Only return the"
        r" answer when you are confident.[/THINK][/SYSTEM_PROMPT]"
        r"[INST]What is 2+2?[/INST]"
        r"Let me think about it.[THINK]2+2 = 4[/THINK]The answer is 4.</s>"
        r"[INST]Thanks, what is 3+3?[/INST]")

    assert string_tokens == expected_tokens