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

4
from contextlib import nullcontext
5
from typing import Optional, cast
6

7
import numpy as np
8
import pytest
9
10

from vllm.config import ModelConfig
11
from vllm.inputs import InputProcessingContext
12
from vllm.multimodal import MULTIMODAL_REGISTRY
13
14
15
# yapf conflicts with isort for this block
# yapf: disable
from vllm.multimodal.processing import (PlaceholderFeaturesInfo,
16
17
                                        PromptIndexTargets, PromptInsertion,
                                        PromptReplacement, apply_text_matches,
18
                                        apply_token_matches,
19
                                        find_mm_placeholders,
20
21
                                        iter_token_matches,
                                        replace_token_matches)
22
# yapf: enable
23
from vllm.multimodal.profiling import MultiModalProfiler
24
from vllm.transformers_utils.tokenizer import AnyTokenizer
25

26
27
from .utils import random_image

28
29
30
31
32

# yapf: disable
@pytest.mark.parametrize(
    ("token_ids", "match_ids", "expected"),
    [
33
        ([], [], []),
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
        ([], [32000], []),
        (
            [32000, 32000, 32000],
            [32000],
            [
                { "start_idx": 0, "end_idx": 1 },
                { "start_idx": 1, "end_idx": 2 },
                { "start_idx": 2, "end_idx": 3 },
            ],
        ),
        (
            [32000, 32000, 32000],
            [32000, 32000],
            [{ "start_idx": 0, "end_idx": 2 }],
        ),
        (
            [32000, 32000, 32000],
            [32000, 32000, 32000],
            [{ "start_idx": 0, "end_idx": 3 }],
        ),
        (
            [9833, 28747, 32000, 32000, 32000, 9833, 28747, 32000, 32000, 918],
            [28747, 32000],
            [
                { "start_idx": 1, "end_idx": 3 },
                { "start_idx": 6, "end_idx": 8 },
            ],
        ),
        (
            [9833, 28747, 32000, 32000, 32000, 9833, 28747, 32000, 32000, 918],
            [28747, 32000, 32000, 32000],
            [
                { "start_idx": 1, "end_idx": 5 },
            ],
        ),
        (
            [9833, 28747, 32000, 32000, 32000, 9833, 28747, 32000, 32000, 918],
            [28747, 0, 32000],
            [],
        ),
    ],
)
76
@pytest.mark.parametrize("start_idx", [0, 4, 8])
77
# yapf: enable
78
79
80
def test_iter_token_matches(token_ids, match_ids, expected, start_idx):
    result = list(iter_token_matches(token_ids, match_ids,
                                     start_idx=start_idx))
81
82

    # Manually constructed results
83
84
    assert [item._asdict() for item in result
            ] == [item for item in expected if item["start_idx"] >= start_idx]
85
86
87
88
89
90
91

    # Invariants
    match_lens = [end - start for start, end in result]
    print("match_lens:", match_lens)  # Only displayed on error
    assert all(match_len == len(match_ids) for match_len in match_lens)


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# yapf: disable
@pytest.mark.parametrize(
    ("token_ids", "match_ids", "new_ids", "expected"),
    [
        ([], [], [-1], []),
        ([], [32000], [-1], []),
        (
            [32000, 32000, 32000],
            [32000],
            [-1],
            [-1, -1, -1],
        ),
        (
            [32000, 32000, 32000],
            [32000, 32000],
            [-1],
            [-1, 32000],
        ),
        (
            [32000, 32000, 32000],
            [32000, 32000, 32000],
            [-1],
            [-1],
        ),
        (
            [9833, 28747, 32000, 32000, 32000, 9833, 28747, 32000, 32000, 918],
            [28747, 32000],
            [-1],
            [9833, -1, 32000, 32000, 9833, -1, 32000, 918],
        ),
        (
            [9833, 28747, 32000, 32000, 32000, 9833, 28747, 32000, 32000, 918],
            [28747, 32000, 32000, 32000],
            [-1],
            [9833, -1, 9833, 28747, 32000, 32000, 918],
        ),
        (
            [9833, 28747, 32000, 32000, 32000, 9833, 28747, 32000, 32000, 918],
            [28747, 0, 32000],
            [-1],
            [9833, 28747, 32000, 32000, 32000, 9833, 28747, 32000, 32000, 918],
        ),
    ],
)
# yapf: enable
def test_replace_token_matches(token_ids, match_ids, new_ids, expected):
    result = replace_token_matches(token_ids, match_ids, new_ids)

    # Manually constructed results
    assert result == expected


144
145
146
147
148
149
150
151
152
# yapf: disable
@pytest.mark.parametrize(
    ("prompt", "target_by_key", "expected_by_key"),
    [
        (
            [],
            {
                "pattern_1": [],
                "pattern_2": [32000],
153
154
155
                "pattern_3": PromptIndexTargets.start(),
                "pattern_4": PromptIndexTargets.prefix([32000]),
                "pattern_5": PromptIndexTargets.end(),
156
157
            },
            {
158
                "pattern_1": [],
159
                "pattern_2": [],
160
161
162
163
164
165
166
                "pattern_3": [
                    { "start_idx": 0, "end_idx": 0 },
                ],
                "pattern_4": [],
                "pattern_5": [
                    { "start_idx": 0, "end_idx": 0 },
                ],
167
            },
168
169
170
171
172
173
174
        ),
        (
            [32000, 32000, 32000, 32000],
            {
                "pattern_1": [32000],
                "pattern_2": [32000, 32000],
                "pattern_3": [32000, 32000, 32000],
175
176
177
                "pattern_4": PromptIndexTargets.start(),
                "pattern_5": PromptIndexTargets.prefix([32000]),
                "pattern_6": PromptIndexTargets.end(),
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
            },
            {
                "pattern_1": [
                    { "start_idx": 0, "end_idx": 1 },
                    { "start_idx": 1, "end_idx": 2 },
                    { "start_idx": 2, "end_idx": 3 },
                    { "start_idx": 3, "end_idx": 4 },
                ],
                "pattern_2": [
                    { "start_idx": 0, "end_idx": 2 },
                    { "start_idx": 2, "end_idx": 4 },
                ],
                "pattern_3": [
                    { "start_idx": 0, "end_idx": 3 },
                ],
193
194
195
196
197
198
199
200
201
                "pattern_4": [
                    { "start_idx": 0, "end_idx": 0 },
                ],
                "pattern_5": [
                    { "start_idx": 1, "end_idx": 1 },
                ],
                "pattern_6": [
                    { "start_idx": 4, "end_idx": 4 },
                ],
202
203
204
205
206
207
208
209
            },
        ),
        (
            [9833, 28747, 32000, 32000, 32000, 9833, 28747, 32000, 32000, 918],
            {
                "pattern_1": [28747, 32000],
                "pattern_2": [28747, 32000, 32000, 32000],
                "pattern_3": [28747, 0, 32000],
210
211
212
                "pattern_4": PromptIndexTargets.start(),
                "pattern_5": PromptIndexTargets.prefix([28747, 32000]),
                "pattern_6": PromptIndexTargets.end(),
213
214
215
216
217
218
219
220
221
222
            },
            {
                "pattern_1": [
                    { "start_idx": 1, "end_idx": 3 },
                    { "start_idx": 6, "end_idx": 8 },
                ],
                "pattern_2": [
                    { "start_idx": 1, "end_idx": 5 },
                ],
                "pattern_3": [],
223
224
225
226
227
228
229
                "pattern_4": [
                    { "start_idx": 0, "end_idx": 0 },
                ],
                "pattern_5": [],
                "pattern_6": [
                    { "start_idx": 10, "end_idx": 10 },
                ],
230
231
232
233
            },
        ),
    ],
)
234
@pytest.mark.parametrize("update_type", [PromptInsertion, PromptReplacement])
235
# yapf: enable
236
237
238
239
240
241
def test_find_token_matches(
    prompt,
    target_by_key,
    expected_by_key,
    update_type,
):
242
243
244
    # Should not be used since there is nothing to convert to token IDs
    mock_tokenizer = cast(AnyTokenizer, object())

245
246
    prompt_updates = {
        key: update_type(key, target, []).resolve(mock_tokenizer, 0)
247
        for key, target in target_by_key.items()
248
249
250
251
252
    }
    result = {
        key: list(update.iter_token_matches(prompt, mock_tokenizer))
        for key, update in prompt_updates.items()
    }
253
254
255
256
257
258
259
260

    # Only displayed on error
    print("result:", result)

    # Manually constructed results
    assert {
        key: [
            dict(start_idx=item.start_idx, end_idx=item.end_idx)
261
            for item in result.get(key, [])
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
        ]
        for key in expected_by_key
    } == expected_by_key


# yapf: disable
@pytest.mark.parametrize(
    ("prompt", "target_by_key", "expected_by_key"),
    [
        # Detokenized test cases of `test_find_token_matches`
        # using the vocab of llava-hf/llava-v1.6-mistral-7b-hf
        (
            "",
            {
                "pattern_1": "",
                "pattern_2": "<image>",
278
279
280
                "pattern_3": PromptIndexTargets.start(),
                "pattern_4": PromptIndexTargets.prefix("<image>"),
                "pattern_5": PromptIndexTargets.end(),
281
282
283
284
            },
            {
                "pattern_1": [{ "start_idx": 0, "end_idx": 0 }],
                "pattern_2": [],
285
286
287
288
289
290
291
                "pattern_3": [
                    { "start_idx": 0, "end_idx": 0 },
                ],
                "pattern_4": [],
                "pattern_5": [
                    { "start_idx": 0, "end_idx": 0 },
                ],
292
293
294
295
296
297
298
299
            }
        ),
        (
            "<image><image><image><image>",
            {
                "pattern_1": "<image>",
                "pattern_2": "<image><image>",
                "pattern_3": "<image><image><image>",
300
301
302
                "pattern_4": PromptIndexTargets.start(),
                "pattern_5": PromptIndexTargets.prefix("<image>"),
                "pattern_6": PromptIndexTargets.end(),
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
            },
            {
                "pattern_1": [
                    { "start_idx": 0, "end_idx": 7 },
                    { "start_idx": 7, "end_idx": 14 },
                    { "start_idx": 14, "end_idx": 21 },
                    { "start_idx": 21, "end_idx": 28 },
                ],
                "pattern_2": [
                    { "start_idx": 0, "end_idx": 14 },
                    { "start_idx": 14, "end_idx": 28 },
                ],
                "pattern_3": [
                    { "start_idx": 0, "end_idx": 21 },
                ],
318
319
320
321
322
323
324
325
326
                "pattern_4": [
                    { "start_idx": 0, "end_idx": 0 },
                ],
                "pattern_5": [
                    { "start_idx": 7, "end_idx": 7 },
                ],
                "pattern_6": [
                    { "start_idx": 28, "end_idx": 28 },
                ],
327
328
329
330
331
332
333
334
            },
        ),
        (
            "Image:<image><image><image>Image:<image><image>!",
            {
                "pattern_1": "Image:<image>",
                "pattern_2": "Image:<image><image><image>",
                "pattern_3": "Image:<unk><image>",
335
336
337
                "pattern_4": PromptIndexTargets.start(),
                "pattern_5": PromptIndexTargets.prefix("Image:<image>"),
                "pattern_6": PromptIndexTargets.end(),
338
339
340
341
342
343
344
345
346
347
            },
            {
                "pattern_1": [
                    { "start_idx": 0, "end_idx": 13 },
                    { "start_idx": 27, "end_idx": 40 },
                ],
                "pattern_2": [
                    { "start_idx": 0, "end_idx": 27 },
                ],
                "pattern_3": [],
348
349
350
351
352
353
354
355
356
                "pattern_4": [
                    { "start_idx": 0, "end_idx": 0 },
                ],
                "pattern_5": [
                    { "start_idx": 13, "end_idx": 13 },
                ],
                "pattern_6": [
                    { "start_idx": 48, "end_idx": 48 },
                ],
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
            },
        ),
        # Test regex escape
        (
            "<|image|><image><|image|><image>",
            {
                "pattern_1": "<|image|>",
                "pattern_2": "<|image|><image>",
                "pattern_3": "<|image|><image><|image|>",
            },
            {
                "pattern_1": [
                    { "start_idx": 0, "end_idx": 9 },
                    { "start_idx": 16, "end_idx": 25 },
                ],
                "pattern_2": [
                    { "start_idx": 0, "end_idx": 16 },
                    { "start_idx": 16, "end_idx": 32 },
                ],
                "pattern_3": [
                    { "start_idx": 0, "end_idx": 25 },
                ],
            },
        ),
    ],
)
383
@pytest.mark.parametrize("update_type", [PromptInsertion, PromptReplacement])
384
# yapf: enable
385
386
387
388
389
390
def test_find_text_matches(
    prompt,
    target_by_key,
    expected_by_key,
    update_type,
):
391
392
393
    # Should not be used since there is nothing to convert to text
    mock_tokenizer = cast(AnyTokenizer, object())

394
395
    prompt_updates = {
        key: update_type(key, target, []).resolve(mock_tokenizer, 0)
396
        for key, target in target_by_key.items()
397
398
399
400
401
    }
    result = {
        key: list(update.iter_text_matches(prompt, mock_tokenizer))
        for key, update in prompt_updates.items()
    }
402
403
404
405
406
407
408
409

    # Only displayed on error
    print("result:", result)

    # Manually constructed results
    assert {
        key: [
            dict(start_idx=item.start_idx, end_idx=item.end_idx)
410
            for item in result.get(key, [])
411
412
413
414
415
416
417
        ]
        for key in expected_by_key
    } == expected_by_key


# yapf: disable
@pytest.mark.parametrize(
418
    ("prompt", "target_by_key", "repl_by_key", "expected_by_update_type_mm_count"),  # noqa: E501
419
420
421
422
423
424
425
426
427
428
429
    [
        (
            "Image:<image>Image:<image><image>!",
            {
                # We use `<image>` before `Image:` to test matches that
                # occur out of order
                "pattern_1": "<image>",
                "pattern_2": "Image:",
                "pattern_3": "!",
            },
            {
430
431
432
433
434
435
                # Test whether target is confused with replacement
                "pattern_1": "<image><image>",
                # Test empty replacement
                "pattern_2": "",
                # Test dynamic replacement (beyond the form of `unit * count`)
                "pattern_3": "?!?",
436
            },
437
438
439
440
441
442
443
444
445
446
447
448
            {
                PromptInsertion: {
                    0: "Image:<image>Image:<image><image>!",
                    1: "Image:<image><image><image>Image:<image><image>!?!?",
                    2: "Image:<image><image><image><image><image>Image:<image><image>!?!??!?",  # noqa: E501
                },
                PromptReplacement: {
                    0: "Image:<image>Image:<image><image>!",
                    1: "<image><image>Image:<image><image>?!?",
                    2: "<image><image><image><image><image>?!?",
                },
            },
449
        ),
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
        # Test index targets
        (
            "",
            {
                "pattern_1": PromptIndexTargets.start(),
                "pattern_2": PromptIndexTargets.prefix("<image>"),
                "pattern_3": PromptIndexTargets.end(),
            },
            {
                "pattern_1": "1",
                "pattern_2": "2",
                "pattern_3": "3",
            },
            {
                PromptInsertion: {
                    0: "",
                    1: "13",
                    2: "1133",
                },
                PromptReplacement: {
                    0: "",
                    1: "13",
                    2: "1133",
                },
            },
        ),
        (
            "<image>",
            {
                "pattern_1": PromptIndexTargets.start(),
                "pattern_2": PromptIndexTargets.prefix("<image>"),
                "pattern_3": PromptIndexTargets.end(),
            },
            {
                "pattern_1": "1",
                "pattern_2": "2",
                "pattern_3": "3",
            },
            {
                PromptInsertion: {
                    0: "<image>",
                    1: "1<image>23",
                    2: "11<image>2233",
                },
                PromptReplacement: {
                    0: "<image>",
                    1: "1<image>23",
                    2: "11<image>2233",
                },
            },
        ),
        # Test different replacement per item
        (
            "<image><image><image>",
            {
                "pattern_1": "<image>",
            },
            {
                "pattern_1": lambda idx: str(idx + 1),
            },
            {
                PromptInsertion: {
                    0: "<image><image><image>",
                    1: "<image>1<image><image>",
                    2: "<image>12<image><image>",
                },
                PromptReplacement: {
                    0: "<image><image><image>",
                    1: "1<image><image>",
                    2: "12<image>",
                },
            },
        ),
        (
            "<image><image><image>",
            {
                "pattern_1": PromptIndexTargets.prefix("<image>"),
            },
            {
                "pattern_1": lambda idx: str(idx + 1),
            },
            {
                PromptInsertion: {
                    0: "<image><image><image>",
                    1: "<image>1<image><image>",
                    2: "<image>12<image><image>",
                },
                PromptReplacement: {
                    0: "<image><image><image>",
                    1: "<image>1<image><image>",
                    2: "<image>12<image><image>",
                },
            },
        ),
544
545
546
    ]
)
# yapf: enable
547
def test_find_update_text(
548
549
550
    prompt,
    target_by_key,
    repl_by_key,
551
    expected_by_update_type_mm_count,
552
553
554
555
):
    # Should not be used since there is nothing to convert to text
    mock_tokenizer = cast(AnyTokenizer, object())

556
557
558
559
560
    for (
            update_type,
            expected_by_mm_count,
    ) in expected_by_update_type_mm_count.items():
        for mm_count, expected in expected_by_mm_count.items():
561
562
563
564
565
566
567
568
569
            mm_prompt_updates = {
                key: [[
                    update_type(key, target,
                                repl_by_key[key]).resolve(mock_tokenizer, i)
                ] for i in range(mm_count)]
                for key, target in target_by_key.items()
            }

            new_prompt, result = apply_text_matches(
570
                prompt,
571
572
                mm_prompt_updates,
                mock_tokenizer,
573
574
575
576
577
            )

            # Only displayed on error
            print("update_type:", update_type)
            print("mm_count:", mm_count)
578
579
            print("mm_prompt_updates:", mm_prompt_updates)
            print("new_prompt:", new_prompt)
580
581
582
            print("result:", result)

            # Manually constructed results
583
            assert new_prompt == expected
584
585
586
587


# yapf: disable
@pytest.mark.parametrize(
588
    ("prompt", "target_by_key", "repl_by_key", "expected_by_update_type_mm_count"),  # noqa: E501
589
    [
590
        # Tokenized test cases of `test_find_update_text`
591
592
593
594
595
596
597
598
599
600
601
        # using the vocab of llava-hf/llava-v1.6-mistral-7b-hf
        (
            [1, 9833, 28747, 32000, 9833, 28747, 32000, 32000, 918],
            {
                # We use `<image>` before `Image:` to test matches that
                # occur out of order
                "pattern_1": [32000],
                "pattern_2": [9833, 28747],
                "pattern_3": [918],
            },
            {
602
603
604
605
606
607
                # Test whether target is confused with replacement
                "pattern_1": [32000, 32000],
                # Test empty replacement
                "pattern_2": [],
                # Test dynamic replacement (beyond the form of `unit * count`)
                "pattern_3": [1550, 918, 1550],
608
            },
609
610
611
612
613
614
615
616
617
618
619
620
            {
                PromptInsertion: {
                    0: [1, 9833, 28747, 32000, 9833, 28747, 32000, 32000, 918],
                    1: [1, 9833, 28747, 32000, 32000, 32000, 9833, 28747, 32000, 32000, 918, 1550, 918, 1550],  # noqa: E501
                    2: [1, 9833, 28747, 32000, 32000, 32000, 32000, 32000, 9833, 28747, 32000, 32000, 918, 1550, 918, 1550, 1550, 918, 1550],  # noqa: E501
                },
                PromptReplacement: {
                    0: [1, 9833, 28747, 32000, 9833, 28747, 32000, 32000, 918],
                    1: [1, 32000, 32000, 9833, 28747, 32000, 32000, 1550, 918, 1550],  # noqa: E501
                    2: [1, 32000, 32000, 32000, 32000, 32000, 1550, 918, 1550],
                },
            },
621
        ),
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
        # Test index targets
        (
            [],
            {
                "pattern_1": PromptIndexTargets.start(),
                "pattern_2": PromptIndexTargets.prefix([32000]),
                "pattern_3": PromptIndexTargets.end(),
            },
            {
                "pattern_1": [-1],
                "pattern_2": [-2],
                "pattern_3": [-3],
            },
            {
                PromptInsertion: {
                    0: [],
                    1: [-1, -3],
                    2: [-1, -1, -3, -3],
                },
                PromptReplacement: {
                    0: [],
                    1: [-1, -3],
                    2: [-1, -1, -3, -3],
                },
            },
        ),
        (
            [32000],
            {
                "pattern_1": PromptIndexTargets.start(),
                "pattern_2": PromptIndexTargets.prefix([32000]),
                "pattern_3": PromptIndexTargets.end(),
            },
            {
                "pattern_1": [-1],
                "pattern_2": [-2],
                "pattern_3": [-3],
            },
            {
                PromptInsertion: {
                    0: [32000],
                    1: [-1, 32000, -2, -3],
                    2: [-1, -1, 32000, -2, -2, -3, -3],
                },
                PromptReplacement: {
                    0: [32000],
                    1: [-1, 32000, -2, -3],
                    2: [-1, -1, 32000, -2, -2, -3, -3],
                },
            },
        ),
        # Test different replacement per item
        (
            [32000, 32000, 32000],
            {
                "pattern_1": [32000],
            },
            {
                "pattern_1": lambda idx: [-(idx + 1)],
            },
            {
                PromptInsertion: {
                    0: [32000, 32000, 32000],
                    1: [32000, -1, 32000, 32000],
                    2: [32000, -1, -2, 32000, 32000],
                },
                PromptReplacement: {
                    0: [32000, 32000, 32000],
                    1: [-1, 32000, 32000],
                    2: [-1, -2, 32000],
                },
            },
        ),
        (
            [32000, 32000, 32000],
            {
                "pattern_1": PromptIndexTargets.prefix([32000]),
            },
            {
                "pattern_1": lambda idx: [-(idx + 1)],
            },
            {
                PromptInsertion: {
                    0: [32000, 32000, 32000],
                    1: [32000, -1, 32000, 32000],
                    2: [32000, -1, -2, 32000, 32000],
                },
                PromptReplacement: {
                    0: [32000, 32000, 32000],
                    1: [32000, -1, 32000, 32000],
                    2: [32000, -1, -2, 32000, 32000],
                },
            },
        ),
716
717
718
    ]
)
# yapf: enable
719
def test_find_update_tokens(
720
721
722
    prompt,
    target_by_key,
    repl_by_key,
723
    expected_by_update_type_mm_count,
724
725
726
727
):
    # Should not be used since there is nothing to convert to tokens
    mock_tokenizer = cast(AnyTokenizer, object())

728
729
730
731
732
    for (
            update_type,
            expected_by_mm_count,
    ) in expected_by_update_type_mm_count.items():
        for mm_count, expected in expected_by_mm_count.items():
733
734
735
736
737
738
739
740
741
            mm_prompt_updates = {
                key: [[
                    update_type(key, target,
                                repl_by_key[key]).resolve(mock_tokenizer, i)
                ] for i in range(mm_count)]
                for key, target in target_by_key.items()
            }

            new_prompt, result = apply_token_matches(
742
                prompt,
743
744
                mm_prompt_updates,
                mock_tokenizer,
745
746
747
748
749
            )

            # Only displayed on error
            print("update_type:", update_type)
            print("mm_count:", mm_count)
750
751
            print("mm_prompt_updates:", mm_prompt_updates)
            print("new_prompt:", new_prompt)
752
753
754
            print("result:", result)

            # Manually constructed results
755
            assert new_prompt == expected
756
757
758
759
760
761
762


# yapf: disable
@pytest.mark.parametrize(
    "repl_by_key",
    [
        {
763
764
765
            "pattern_1": [32000, 32000],
            "pattern_2": [],
            "pattern_3": [1550, 918, 1550],
766
767
            # Test different modalities having the same tokens (32000)
            "pattern_4": [32000],
768
769
770
771
772
773
774
775
        },
    ],
)
@pytest.mark.parametrize(
    ("prompt", "expected"),
    [
        (
            [1, 9833, 28747, 32000, 9833, 28747, 32000, 32000, 918],
776
777
            {
                "pattern_1": [
778
                    PlaceholderFeaturesInfo(
779
780
781
                        modality="pattern_1",
                        item_idx=0,
                        start_idx=6,
782
                        tokens=[32000, 32000],
783
                        is_embed=None,
784
785
                    ),
                ],
786
                "pattern_4": [
787
                    PlaceholderFeaturesInfo(
788
789
790
                        modality="pattern_4",
                        item_idx=0,
                        start_idx=3,
791
                        tokens=[32000],
792
                        is_embed=None,
793
794
                    ),
                ],
795
796
            }

797
798
        ),
        (
799
            [1, 32000, 32000, 9833, 28747, 32000, 32000, 1550, 918, 1550],
800
801
            {
                "pattern_1": [
802
                    PlaceholderFeaturesInfo(
803
804
805
                        modality="pattern_1",
                        item_idx=0,
                        start_idx=1,
806
                        tokens=[32000, 32000],
807
                        is_embed=None,
808
                    ),
809
                    PlaceholderFeaturesInfo(
810
811
812
                        modality="pattern_1",
                        item_idx=1,
                        start_idx=5,
813
                        tokens=[32000, 32000],
814
                        is_embed=None,
815
816
817
                    ),
                ],
                "pattern_3": [
818
                    PlaceholderFeaturesInfo(
819
820
821
                        modality="pattern_3",
                        item_idx=0,
                        start_idx=7,
822
                        tokens=[1550, 918, 1550],
823
                        is_embed=None,
824
825
                    ),
                ],
826
                # No match for pattern_4 as it has lower priority than pattern_1
827
            }
828
829
        ),
        (
830
            [1, 32000, 32000, 32000, 32000, 32000, 1550, 918, 1550],
831
832
            {
                "pattern_1": [
833
                    PlaceholderFeaturesInfo(
834
835
836
                        modality="pattern_1",
                        item_idx=0,
                        start_idx=1,
837
                        tokens=[32000, 32000],
838
                        is_embed=None,
839
                    ),
840
                    PlaceholderFeaturesInfo(
841
842
843
                        modality="pattern_1",
                        item_idx=1,
                        start_idx=3,
844
                        tokens=[32000, 32000],
845
                        is_embed=None,
846
847
                    ),
                ],
848
                "pattern_4": [
849
                    PlaceholderFeaturesInfo(
850
851
852
                        modality="pattern_4",
                        item_idx=0,
                        start_idx=5,
853
                        tokens=[32000],
854
                        is_embed=None,
855
856
                    ),
                ],
857
                "pattern_3": [
858
                    PlaceholderFeaturesInfo(
859
860
861
                        modality="pattern_3",
                        item_idx=0,
                        start_idx=6,
862
                        tokens=[1550, 918, 1550],
863
                        is_embed=None,
864
865
866
                    ),
                ],
            }
867
868
869
        ),
    ]
)
870
@pytest.mark.parametrize("update_type", [PromptInsertion, PromptReplacement])
871
# yapf: enable
872
def test_find_mm_placeholders(
873
874
875
    repl_by_key,
    prompt,
    expected,
876
    update_type,
877
878
879
880
):
    # Should not be used since there is nothing to convert to tokens
    mock_tokenizer = cast(AnyTokenizer, object())

881
    mm_prompt_updates = {
882
883
        key: [[update_type(key, [], repl).resolve(mock_tokenizer, i)]
              for i in range(3)]
884
        for key, repl in repl_by_key.items()
885
    }
886

887
    result = find_mm_placeholders(prompt, mm_prompt_updates)
888
889
890

    # Only displayed on error
    print("result:", result)
891
892

    # Manually constructed results
893
    assert result == expected
894
895


896
@pytest.mark.parametrize("model_id", ["llava-hf/llava-v1.6-mistral-7b-hf"])
897
898
899
900
901
902
903
904
905
906
907
908
909
@pytest.mark.parametrize(
    ("limit", "num_supported", "is_valid"),
    [(0, 0, True), (0, 1, True), (1, 0, False), (1, 1, True), (1, 2, True),
     (2, 1, False), (2, 2, True)],
)
def test_limit_mm_per_prompt_dummy(model_id, limit, num_supported, is_valid):
    limit_mm_per_prompt = {"image": limit}

    model_config = ModelConfig(
        model=model_id,
        limit_mm_per_prompt=limit_mm_per_prompt,
    )

910
    processor = MULTIMODAL_REGISTRY.create_processor(model_config)
911
    processor._supported_mm_limits = {"image": num_supported}
912

913
    profiler = MultiModalProfiler(processor)
914
915
916
917

    if is_valid:
        exc_ctx = nullcontext()
    else:
918
        exc_ctx = pytest.raises(ValueError, match="At most")
919
920

    with exc_ctx:
921
922
923
924
        profiler.get_decoder_dummy_data(
            model_config.max_model_len,
            mm_counts=limit_mm_per_prompt,
        )
925
926


927
@pytest.mark.parametrize("model_id", ["llava-hf/llava-v1.6-mistral-7b-hf"])
928
929
930
931
932
933
934
935
936
937
938
939
940
@pytest.mark.parametrize(
    ("num_images", "limit", "is_valid"),
    [(0, 0, True), (0, 1, True), (1, 0, False), (1, 1, True), (1, 2, True),
     (2, 1, False), (2, 2, True)],
)
def test_limit_mm_per_prompt_apply(model_id, num_images, limit, is_valid):
    limit_mm_per_prompt = {"image": limit}

    model_config = ModelConfig(
        model=model_id,
        limit_mm_per_prompt=limit_mm_per_prompt,
    )

941
    processor = MULTIMODAL_REGISTRY.create_processor(model_config)
942
943

    rng = np.random.RandomState(0)
944
    image = random_image(rng, min_wh=128, max_wh=256)
945
946
947
948
949
950
951
952
953
954
    if num_images == 0:
        mm_data = {}
    elif num_images == 1:
        mm_data = {"image": image}
    else:
        mm_data = {"image": [image] * num_images}

    if is_valid:
        exc_ctx = nullcontext()
    else:
955
        exc_ctx = pytest.raises(ValueError, match="At most")
956
957
958
959
960
961
962

    with exc_ctx:
        processor.apply(
            "<image>" * num_images,
            mm_data=mm_data,
            hf_processor_mm_kwargs={},
        )
963
964


965
class DummyProcessor:
966

967
    def __init__(self, a: int = 0, b: int = 0) -> None:
968
969
        super().__init__()

970
971
        self.a = a
        self.b = b
972
973
974

    def __call__(
        self,
975
976
977
978
979
        a: int = 0,
        c: int = 0,
        return_tensors: Optional[str] = None,
    ) -> dict[str, int]:
        return dict(a=a, c=c)
980
981
982


# yapf: disable
983
@pytest.mark.parametrize("model_id", ["Qwen/Qwen2-VL-2B-Instruct"])  # Dummy
984
@pytest.mark.parametrize(
985
    ("config_kwargs", "inference_kwargs", "expected_kwargs"),
986
    [
987
988
989
990
991
992
993
        ({"a": 1}, {}, {"a": 1, "b": 0}),
        ({}, {"a": 1}, {"a": 1, "b": 0}),
        # inference_kwargs should take precedence
        ({"a": 1}, {"a": 2}, {"a": 2, "b": 0}),
        # Should ignore extra kwargs
        ({"a": 1, "c": 1}, {}, {"a": 1, "b": 0}),
        ({"b": 1, "c": 1}, {}, {"a": 0, "b": 1}),
994
995
996
    ],
)
# yapf: enable
997
998
999
1000
1001
1002
1003
1004
def test_hf_processor_init_kwargs(
    model_id,
    config_kwargs,
    inference_kwargs,
    expected_kwargs,
):
    # Should not be used since there is nothing to convert to tokens
    mock_tokenizer = cast(AnyTokenizer, object())
1005

1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
    ctx = InputProcessingContext(
        model_config=ModelConfig(model_id, mm_processor_kwargs=config_kwargs),
        tokenizer=mock_tokenizer,
    )

    processor = ctx.get_hf_processor(
        DummyProcessor,  # type: ignore[arg-type]
        **inference_kwargs,
    )

    for k, v in expected_kwargs.items():
        assert getattr(processor, k) == v
1018
1019


1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
# yapf: disable
@pytest.mark.parametrize("model_id", ["Qwen/Qwen2-VL-2B-Instruct"])  # Dummy
@pytest.mark.parametrize(
    ("config_kwargs", "inference_kwargs", "expected_kwargs"),
    [
        ({"a": 1}, {}, {"a": 1, "c": 0}),
        ({}, {"a": 1}, {"a": 1, "c": 0}),
        # inference_kwargs should take precedence
        ({"a": 1}, {"a": 2}, {"a": 2, "c": 0}),
        # Should ignore extra kwargs
        ({"a": 1, "c": 1}, {}, {"a": 1, "c": 1}),
        ({"b": 1, "c": 1}, {}, {"a": 0, "c": 1}),
    ],
)
# yapf: enable
def test_hf_processor_call_kwargs(
    model_id,
    config_kwargs,
    inference_kwargs,
    expected_kwargs,
):
    # Should not be used since there is nothing to convert to tokens
    mock_tokenizer = cast(AnyTokenizer, object())
1043

1044
1045
1046
    ctx = InputProcessingContext(
        model_config=ModelConfig(model_id, mm_processor_kwargs=config_kwargs),
        tokenizer=mock_tokenizer,
1047
1048
    )

1049
1050
1051
1052
    processor = ctx.get_hf_processor(DummyProcessor)  # type: ignore[arg-type]

    result = ctx.call_hf_processor(processor, {}, inference_kwargs)
    assert result == expected_kwargs