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

4
from collections.abc import Callable
5

Mor Zusman's avatar
Mor Zusman committed
6
7
import pytest

8
from tests.models.registry import HF_EXAMPLE_MODELS
9
from tests.utils import multi_gpu_test
10
from vllm import LLM
11
from vllm.engine.arg_utils import EngineArgs
12
from vllm.platforms import current_platform
13
from vllm.sampling_params import SamplingParams
14
from vllm.v1.cudagraph_dispatcher import CudagraphDispatcher
15

16
from ...utils import check_logprobs_close, check_outputs_equal
17

18
19
20
# Mark all tests as hybrid
pytestmark = pytest.mark.hybrid_model

21
22
23
24
# NOTE: The first model in each list is taken as the primary model,
# meaning that it will be used in all tests in this file
# The rest of the models will only be tested by test_models

25
26
APC_MULTIPLY_BY = 300

27
28
29
SSM_MODELS = [
    "state-spaces/mamba-130m-hf",
    "tiiuae/falcon-mamba-tiny-dev",
30
31
    # mamba2-codestral in transformers is broken pending:
    # https://github.com/huggingface/transformers/pull/40861
32
    # "yujiepan/mamba2-codestral-v0.1-tiny-random",
33
]
34

35
36
HYBRID_MODELS = [
    "ai21labs/Jamba-tiny-dev",
37
    "pfnet/plamo-2-1b",
38
    "Zyphra/Zamba2-1.2B-instruct",
39
    "hmellor/tiny-random-BambaForCausalLM",
40
41
    "ibm-granite/granite-4.0-tiny-preview",
    "tiiuae/Falcon-H1-0.5B-Base",
42
    "LiquidAI/LFM2-1.2B",
43
    "tiny-random/qwen3-next-moe",
Chen Zhang's avatar
Chen Zhang committed
44
45
]

46
FULL_CUDA_GRAPH_MODELS = [
47
    "ai21labs/Jamba-tiny-dev",
48
    "pfnet/plamo-2-1b",
49
    "Zyphra/Zamba2-1.2B-instruct",
50
51
]

52
53
54
55
56
FP32_STATE_MODELS = [
    "state-spaces/mamba-130m-hf",
    "Zyphra/Zamba2-1.2B-instruct",
]

57
58
59
# Avoid OOM
MAX_NUM_SEQS = 4

60
61
ATTN_BACKEND = "TRITON_ATTN" if current_platform.is_rocm() else "auto"

Mor Zusman's avatar
Mor Zusman committed
62

63
64
65
66
67
68
69
70
def _set_conv_state_layout(monkeypatch, layout: str) -> None:
    """Set conv state layout env var and clear cache to pick up new value."""
    from vllm.model_executor.layers.mamba import mamba_utils

    monkeypatch.setenv("VLLM_SSM_CONV_STATE_LAYOUT", layout)
    mamba_utils.get_conv_state_layout.cache_clear()


71
72
73
@pytest.mark.parametrize("model", SSM_MODELS + HYBRID_MODELS)
@pytest.mark.parametrize("max_tokens", [64])
@pytest.mark.parametrize("num_logprobs", [5])
Mor Zusman's avatar
Mor Zusman committed
74
75
76
77
def test_models(
    hf_runner,
    vllm_runner,
    example_prompts,
Chen Zhang's avatar
Chen Zhang committed
78
    monkeypatch,
Mor Zusman's avatar
Mor Zusman committed
79
80
    model: str,
    max_tokens: int,
81
    num_logprobs: int,
Mor Zusman's avatar
Mor Zusman committed
82
) -> None:
83
84
85
    try:
        model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
        model_info.check_available_online(on_fail="skip")
86
        model_info.check_transformers_version(on_fail="skip")
87
    except ValueError:
88
        pass
89

90
    with hf_runner(model) as hf_model:
91
        hf_outputs = hf_model.generate_greedy_logprobs_limit(
92
93
            example_prompts, max_tokens, num_logprobs
        )
Yu Chin Fabian Lim's avatar
Yu Chin Fabian Lim committed
94

95
96
97
    with vllm_runner(
        model, max_num_seqs=MAX_NUM_SEQS, attention_backend=ATTN_BACKEND
    ) as vllm_model:
98
        vllm_outputs = vllm_model.generate_greedy_logprobs(
99
100
            example_prompts, max_tokens, num_logprobs
        )
Chen Zhang's avatar
Chen Zhang committed
101

102
103
104
105
106
107
    check_logprobs_close(
        outputs_0_lst=hf_outputs,
        outputs_1_lst=vllm_outputs,
        name_0="hf",
        name_1="vllm",
    )
Mor Zusman's avatar
Mor Zusman committed
108
109


110
@pytest.mark.parametrize("model", [SSM_MODELS[0], HYBRID_MODELS[0]])
111
112
@pytest.mark.parametrize("max_tokens", [64])
@pytest.mark.parametrize("num_logprobs", [5])
113
@pytest.mark.parametrize("conv_state_layout", ["SD", "DS"])
114
115
116
def test_batching(
    vllm_runner,
    example_prompts,
117
    monkeypatch,
118
119
    model: str,
    max_tokens: int,
120
    num_logprobs: int,
121
    conv_state_layout: str,
122
) -> None:
123
124
125
126
127
128
129
    try:
        model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
        model_info.check_available_online(on_fail="skip")
        model_info.check_transformers_version(on_fail="skip")
    except ValueError:
        pass

130
131
    _set_conv_state_layout(monkeypatch, conv_state_layout)

132
    for_loop_outputs = []
133
    with vllm_runner(model, max_num_seqs=MAX_NUM_SEQS) as vllm_model:
134
        for prompt in example_prompts:
135
136
137
            (single_output,) = vllm_model.generate_greedy_logprobs(
                [prompt], max_tokens, num_logprobs
            )
138
            for_loop_outputs.append(single_output)
139

140
        batched_outputs = vllm_model.generate_greedy_logprobs(
141
142
            example_prompts, max_tokens, num_logprobs
        )
143

144
    check_logprobs_close(
145
146
147
148
149
150
151
        outputs_0_lst=for_loop_outputs,
        outputs_1_lst=batched_outputs,
        name_0="for_loop_vllm",
        name_1="batched_vllm",
    )


152
153
@pytest.mark.parametrize("model", [SSM_MODELS[0], HYBRID_MODELS[0]])
@pytest.mark.parametrize("max_tokens", [10])
154
@pytest.mark.parametrize("conv_state_layout", ["SD", "DS"])
155
def test_chunked_prefill_with_parallel_sampling(
156
157
    vllm_runner,
    example_prompts,
158
    monkeypatch,
159
160
    model: str,
    max_tokens: int,
161
    conv_state_layout: str,
162
) -> None:
163
    """
164
165
    Tests chunked prefill in conjunction with n > 1.

166
167
168
169
170
171
172
    In this case, prefill is populated with decoding tokens and
    we test that it doesn't fail.

    This test might fail if cache is not allocated correctly for n > 1
    decoding steps inside a chunked prefill forward pass
    (where we have both prefill and decode together)
    """
173
174
    _set_conv_state_layout(monkeypatch, conv_state_layout)

175
    sampling_params = SamplingParams(n=3, temperature=1, seed=0, max_tokens=max_tokens)
176
    with vllm_runner(
177
178
179
180
181
        model,
        enable_chunked_prefill=True,
        # forces prefill chunks with decoding
        max_num_batched_tokens=MAX_NUM_SEQS * 3,
        max_num_seqs=MAX_NUM_SEQS,
182
        attention_backend=ATTN_BACKEND,
183
184
    ) as vllm_model:
        vllm_model.generate(example_prompts, sampling_params)
185
186


187
@pytest.mark.parametrize("model", [SSM_MODELS[0], HYBRID_MODELS[0]])
188
@pytest.mark.parametrize("max_tokens", [20])
189
@pytest.mark.parametrize("conv_state_layout", ["SD", "DS"])
190
191
192
def test_mamba_cache_cg_padding(
    vllm_runner,
    example_prompts,
193
    monkeypatch,
194
195
    model: str,
    max_tokens: int,
196
    conv_state_layout: str,
197
) -> None:
198
199
200
201
202
    """
    This test is for verifying that mamba cache is padded to CG captured
    batch size. If it's not, a torch RuntimeError will be raised because
    tensor dimensions aren't compatible.
    """
203
204
    _set_conv_state_layout(monkeypatch, conv_state_layout)

205
    vllm_config = EngineArgs(model=model, trust_remote_code=True).create_engine_config()
206
207
208
209
210
211
212
213
    cudagraph_dispatcher = CudagraphDispatcher(vllm_config)
    cudagraph_dispatcher.initialize_cudagraph_keys(
        vllm_config.compilation_config.cudagraph_mode
    )
    while (
        len(example_prompts)
        == cudagraph_dispatcher.dispatch(len(example_prompts))[1].num_tokens
    ):
214
215
216
        example_prompts.append(example_prompts[0])

    try:
217
        with vllm_runner(model) as vllm_model:
218
219
220
221
222
            vllm_model.generate_greedy(example_prompts, max_tokens)
    except RuntimeError:
        pytest.fail(
            "Couldn't run batch size which is not equal to a Cuda Graph "
            "captured batch size. "
223
224
            "Could be related to mamba cache not padded correctly"
        )
225
226


227
@pytest.mark.parametrize("model", [SSM_MODELS[0], HYBRID_MODELS[0]])
228
229
230
def test_fail_upon_inc_requests_and_finished_requests_lt_available_blocks(
    vllm_runner,
    example_prompts,
231
    model: str,
232
) -> None:
233
234
235
236
237
238
    """
    This test is for verifying that the hybrid inner state management doesn't
    collapse in case where the number of incoming requests and
    finished_requests_ids is larger than the maximum mamba block capacity.

    This could generally happen due to the fact that hybrid does support
239
    statelessness mechanism where it can clean up new incoming requests in
240
241
    a single step.
    """
242
    try:
243
        with vllm_runner(model, max_num_seqs=MAX_NUM_SEQS) as vllm_model:
244
245
            vllm_model.generate_greedy([example_prompts[0]] * 100, 10)
    except ValueError:
246
247
248
249
        pytest.fail(
            "Hybrid inner state wasn't cleaned up properly between"
            "steps finished requests registered unnecessarily "
        )
250
251


252
@pytest.mark.parametrize("model", [SSM_MODELS[0], HYBRID_MODELS[0]])
Mor Zusman's avatar
Mor Zusman committed
253
254
255
def test_state_cleanup(
    vllm_runner,
    example_prompts,
256
    model: str,
Mor Zusman's avatar
Mor Zusman committed
257
) -> None:
258
    """
259
260
    This test is for verifying that the Hybrid state is cleaned up between
    steps.
261

262
    If it's not cleaned, an error would be expected.
263
    """
Mor Zusman's avatar
Mor Zusman committed
264
    try:
265
        with vllm_runner(model, max_num_seqs=MAX_NUM_SEQS) as vllm_model:
Mor Zusman's avatar
Mor Zusman committed
266
267
268
            for _ in range(10):
                vllm_model.generate_greedy([example_prompts[0]] * 100, 1)
    except ValueError:
269
270
271
272
        pytest.fail(
            "Hybrid inner state wasn't cleaned up between states, "
            "could be related to finished_requests_ids"
        )
Mor Zusman's avatar
Mor Zusman committed
273
274


275
@multi_gpu_test(num_gpus=2)
276
@pytest.mark.parametrize("model", [SSM_MODELS[0], HYBRID_MODELS[0]])
277
@pytest.mark.parametrize("max_tokens", [64])
278
279
@pytest.mark.parametrize("num_logprobs", [5])
def test_distributed_correctness(
280
281
282
283
    vllm_runner,
    example_prompts,
    model: str,
    max_tokens: int,
284
    num_logprobs: int,
285
) -> None:
286
287
288
    with vllm_runner(
        model, tensor_parallel_size=1, max_num_seqs=MAX_NUM_SEQS
    ) as vllm_model:
289
        vllm_outputs_tp_1 = vllm_model.generate_greedy_logprobs(
290
291
            example_prompts, max_tokens, num_logprobs
        )
292

293
294
295
    with vllm_runner(
        model, tensor_parallel_size=2, max_num_seqs=MAX_NUM_SEQS
    ) as vllm_model:
296
        vllm_outputs_tp_2 = vllm_model.generate_greedy_logprobs(
297
298
            example_prompts, max_tokens, num_logprobs
        )
299

300
    check_logprobs_close(
301
302
303
304
305
        outputs_0_lst=vllm_outputs_tp_1,
        outputs_1_lst=vllm_outputs_tp_2,
        name_0="vllm_tp_1",
        name_1="vllm_tp_2",
    )
306
307


308
@pytest.mark.parametrize("model", FULL_CUDA_GRAPH_MODELS)
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
@pytest.mark.parametrize("max_tokens", [64])
@pytest.mark.parametrize("num_logprobs", [5])
def test_full_cuda_graph(
    hf_runner,
    vllm_runner,
    example_prompts,
    monkeypatch,
    model: str,
    max_tokens: int,
    num_logprobs: int,
) -> None:
    try:
        model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
        model_info.check_available_online(on_fail="skip")
        model_info.check_transformers_version(on_fail="skip")
    except ValueError:
        pass

    with hf_runner(model) as hf_model:
328
        hf_outputs = hf_model.generate_greedy_logprobs_limit(
329
330
            example_prompts, max_tokens, num_logprobs
        )
331

332
333
334
    with vllm_runner(
        model, max_num_seqs=MAX_NUM_SEQS, attention_backend=ATTN_BACKEND
    ) as vllm_model:
335
        vllm_outputs = vllm_model.generate_greedy_logprobs(
336
337
            example_prompts, max_tokens, num_logprobs
        )
338
339

    check_logprobs_close(
340
        outputs_0_lst=hf_outputs,
341
        outputs_1_lst=vllm_outputs,
342
        name_0="hf",
343
        name_1="vllm",
344
    )
345
346


347
@pytest.mark.parametrize("model", FP32_STATE_MODELS)
348
349
@pytest.mark.parametrize("max_tokens", [64])
@pytest.mark.parametrize("num_logprobs", [5])
350
351
352
@pytest.mark.parametrize(
    "cache_dtype_param", ["mamba_ssm_cache_dtype", "mamba_cache_dtype"]
)
353
def test_fp32_cache_state(
354
355
356
357
358
359
360
    hf_runner,
    vllm_runner,
    example_prompts,
    monkeypatch,
    model: str,
    max_tokens: int,
    num_logprobs: int,
361
    cache_dtype_param: str,
362
363
364
365
366
367
368
369
370
) -> None:
    try:
        model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
        model_info.check_available_online(on_fail="skip")
        model_info.check_transformers_version(on_fail="skip")
    except ValueError:
        pass

    with hf_runner(model) as hf_model:
371
        hf_outputs = hf_model.generate_greedy_logprobs_limit(
372
373
            example_prompts, max_tokens, num_logprobs
        )
374

375
376
377
    with vllm_runner(
        model, max_num_seqs=MAX_NUM_SEQS, **{cache_dtype_param: "float32"}
    ) as vllm_model:
378
        vllm_outputs = vllm_model.generate_greedy_logprobs(
379
380
            example_prompts, max_tokens, num_logprobs
        )
381

382
    check_logprobs_close(
383
        outputs_0_lst=hf_outputs,
384
        outputs_1_lst=vllm_outputs,
385
        name_0="hf",
386
        name_1="vllm",
387
    )
388
389
390


# Helper functions for the APC tests
391
392
393
394
395
def _get_vllm_runner_params(
    model: str,
    max_model_len: int,
    tensor_parallel_size: int = 1,
):
396
    return {
397
        "model_name": model,
398
        "enable_chunked_prefill": True,
399
400
401
402
        "enable_prefix_caching": False,
        "max_model_len": max_model_len,
        "tensor_parallel_size": tensor_parallel_size,
        "gpu_memory_utilization": 0.4,
403
        "attention_backend": ATTN_BACKEND,
404
405
406
    }


407
408
409
410
411
412
413
414
415
def _get_vLLM_output(
    vllm_runner,
    kwargs,
    prompts,
    max_tokens,
    num_logprobs,
    num_repetitions=1,
    vllm_model=None,
):
416
417
418
419
420
421
422
423
    outs = []
    if vllm_model is None:
        vllm_model = vllm_runner(**kwargs)
    for _ in range(num_repetitions):
        if num_logprobs < 0:
            vllm_output = vllm_model.generate_greedy(prompts, max_tokens)
        else:
            vllm_output = vllm_model.generate_greedy_logprobs(
424
425
                prompts, max_tokens, num_logprobs
            )
426
427
428
429
430
        outs.append(vllm_output)

    return outs, vllm_model


431
@pytest.mark.parametrize("model", [HYBRID_MODELS[0], HYBRID_MODELS[3]])
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
@pytest.mark.parametrize("max_tokens", [64])
@pytest.mark.parametrize("n_repetitions", [2])
# If num_logprobs is set to -1, then the stringent version
# of the test is executed using `check_outputs_equal`
# instead of `check_logprobs_close`
@pytest.mark.parametrize("num_logprobs", [5])
@pytest.mark.parametrize("tensor_parallel_size", [1])
def test_apc_single_prompt(
    hf_runner,
    vllm_runner,
    example_prompts,
    monkeypatch,
    model: str,
    max_tokens: int,
    n_repetitions: int,
    num_logprobs: int,
    tensor_parallel_size: int,
) -> None:
    try:
        model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
        model_info.check_available_online(on_fail="skip")
        model_info.check_transformers_version(on_fail="skip")
    except ValueError:
        pass

457
458
459
    compare_operator: Callable = (
        check_logprobs_close if num_logprobs > 0 else check_outputs_equal  # type: ignore
    )
460
461

    # Sample prompts.
462
    generated_prompts = [APC_MULTIPLY_BY * example_prompts[0]]
463

464
    max_model_len = max(len(prompt) + max_tokens for prompt in generated_prompts)
465
    vllm_runner_kwargs = _get_vllm_runner_params(
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
        model, max_model_len, tensor_parallel_size=tensor_parallel_size
    )
    vllm_runner_kwargs["mamba_ssm_cache_dtype"] = "float32"
    vllm_outputs_no_cache, _ = _get_vLLM_output(
        vllm_runner, vllm_runner_kwargs, generated_prompts, max_tokens, num_logprobs
    )

    vllm_runner_kwargs["enable_prefix_caching"] = True
    vllm_outputs_cache_rep, _ = _get_vLLM_output(
        vllm_runner,
        vllm_runner_kwargs,
        generated_prompts,
        max_tokens,
        num_logprobs,
        n_repetitions,
    )
482
483
484
485
486
487
488
489
490
491
492
493
494

    for r_idx, vllm_outputs_cache_itn in enumerate(vllm_outputs_cache_rep):
        # In the first repetition, the caches are filled
        # In the second repetition, these caches are reused

        compare_operator(
            outputs_0_lst=vllm_outputs_no_cache[0],
            outputs_1_lst=vllm_outputs_cache_itn,
            name_0="vllm_no_cache",
            name_1=f"vllm_cache_it_{r_idx + 1}",
        )


495
@pytest.mark.parametrize("model", [HYBRID_MODELS[0], HYBRID_MODELS[3]])
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
@pytest.mark.parametrize("max_tokens", [64])
@pytest.mark.parametrize("n_repetitions", [2])
# If num_logprobs is set to -1, then the stringent version
# of the test is executed using `check_outputs_equal`
# instead of `check_logprobs_close`
@pytest.mark.parametrize("num_logprobs", [5])
@pytest.mark.parametrize("tensor_parallel_size", [1])
def test_apc_single_prompt_block_align_alignment(
    hf_runner,
    vllm_runner,
    example_prompts,
    monkeypatch,
    model: str,
    max_tokens: int,
    n_repetitions: int,
    num_logprobs: int,
    tensor_parallel_size: int,
) -> None:
    try:
        model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
        model_info.check_available_online(on_fail="skip")
        model_info.check_transformers_version(on_fail="skip")
    except ValueError:
        pass

521
522
523
    compare_operator: Callable = (
        check_logprobs_close if num_logprobs > 0 else check_outputs_equal  # type: ignore
    )
524
525

    # Sample prompts. This custom prompt is used, as it causes the most issues
526
    generated_prompts = ["The president of the United States is " * APC_MULTIPLY_BY]
527

528
    max_model_len = max(len(prompt) + max_tokens for prompt in generated_prompts)
529
    vllm_runner_kwargs = _get_vllm_runner_params(
530
531
532
        model, max_model_len, tensor_parallel_size=tensor_parallel_size
    )
    vllm_runner_kwargs["mamba_ssm_cache_dtype"] = "float32"
533

534
535
536
    vllm_outputs_no_cache, _ = _get_vLLM_output(
        vllm_runner, vllm_runner_kwargs, generated_prompts, max_tokens, num_logprobs
    )
537

538
    vllm_runner_kwargs["enable_prefix_caching"] = True
539
540
    with vllm_runner(**vllm_runner_kwargs) as vllm_model:
        # Retrieve the default mamba state block size
541
542
        vllm_config = vllm_model.llm.llm_engine.vllm_config
        mamba_block_size = vllm_config.cache_config.mamba_block_size
543
544
545
546
547
548
549

    # In case the hybrid model does not have the
    # "mamba_block_size" assume a fixed constant
    if mamba_block_size is None:
        mamba_block_size = 512

    mamba_block_size_multiplier = 10
550
551
552
553
554
555
556
557
558
559
560
561
    for offsets in [-3, 3, mamba_block_size // 4 + 3, mamba_block_size // 2 - 3]:
        vllm_runner_kwargs["max_num_batched_tokens"] = (
            mamba_block_size_multiplier * mamba_block_size - offsets
        )
        vllm_outputs_cache_rep, _ = _get_vLLM_output(
            vllm_runner,
            vllm_runner_kwargs,
            generated_prompts,
            max_tokens,
            num_logprobs,
            n_repetitions,
        )
562
563
564
565
566
567
568
569
570
571
572
573
574
575

        # Check alignment of the output logits when using APC
        for r_idx, vllm_outputs_cache_itn in enumerate(vllm_outputs_cache_rep):
            # In the first repetition, the caches are filled
            # In the second repetition, these caches are reused

            compare_operator(
                outputs_0_lst=vllm_outputs_no_cache[0],
                outputs_1_lst=vllm_outputs_cache_itn,
                name_0="vllm_no_cache",
                name_1=f"vllm_cache_it_{r_idx + 1}",
            )


576
@pytest.mark.parametrize("model", [HYBRID_MODELS[0], HYBRID_MODELS[3]])
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
@pytest.mark.parametrize("max_tokens", [64])
@pytest.mark.parametrize("n_repetitions", [2])
# If num_logprobs is set to -1, then the stringent version
# of the test is executed using `check_outputs_equal`
# instead of `check_logprobs_close`
@pytest.mark.parametrize("num_logprobs", [5])
@pytest.mark.parametrize("tensor_parallel_size", [1])
def test_apc_multiple_prompts_all_cached_outputs(
    hf_runner,
    vllm_runner,
    example_prompts,
    monkeypatch,
    model: str,
    max_tokens: int,
    n_repetitions: int,
    num_logprobs: int,
    tensor_parallel_size: int,
) -> None:
    try:
        model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
        model_info.check_available_online(on_fail="skip")
        model_info.check_transformers_version(on_fail="skip")
    except ValueError:
        pass

602
603
604
    compare_operator: Callable = (
        check_logprobs_close if num_logprobs > 0 else check_outputs_equal  # type: ignore
    )
605
606

    # Sample prompts.
607
    generated_prompts = [APC_MULTIPLY_BY * prompt for prompt in example_prompts]
608

609
    max_model_len = max(len(prompt) + max_tokens for prompt in generated_prompts)
610
    vllm_runner_kwargs = _get_vllm_runner_params(
611
612
613
        model, max_model_len, tensor_parallel_size=tensor_parallel_size
    )
    vllm_runner_kwargs["mamba_ssm_cache_dtype"] = "float32"
614
615
616
617
    # Reduce the effects of batch variance on ROCm since batch invariance is not
    # yet supported. See: https://github.com/vllm-project/vllm/issues/27433
    if current_platform.is_rocm():
        vllm_runner_kwargs["max_num_seqs"] = 4
618

619
620
621
    vllm_outputs_no_cache, _ = _get_vLLM_output(
        vllm_runner, vllm_runner_kwargs, generated_prompts, max_tokens, num_logprobs
    )
622

623
624
625
626
627
628
629
630
631
    vllm_runner_kwargs["enable_prefix_caching"] = True
    vllm_outputs_cache_rep, _ = _get_vLLM_output(
        vllm_runner,
        vllm_runner_kwargs,
        generated_prompts,
        max_tokens,
        num_logprobs,
        n_repetitions,
    )
632
633
634
635
636
637
638
639
640
641
642
643
644

    for r_idx, vllm_outputs_cache_itn in enumerate(vllm_outputs_cache_rep):
        # In the first repetition, the caches are filled
        # In the second repetition, these caches are reused

        compare_operator(
            outputs_0_lst=vllm_outputs_no_cache[0],
            outputs_1_lst=vllm_outputs_cache_itn,
            name_0="vllm_no_cache",
            name_1=f"vllm_cache_it_{r_idx + 1}",
        )


645
@pytest.mark.parametrize("model", [HYBRID_MODELS[0], HYBRID_MODELS[3]])
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
@pytest.mark.parametrize("max_tokens", [64])
@pytest.mark.parametrize("n_repetitions", [2])
# If num_logprobs is set to -1, then the stringent version
# of the test is executed using `check_outputs_equal`
# instead of `check_logprobs_close`
@pytest.mark.parametrize("num_logprobs", [5])
@pytest.mark.parametrize("tensor_parallel_size", [1])
def test_apc_multiple_prompts_block_align_alignment(
    hf_runner,
    vllm_runner,
    example_prompts,
    monkeypatch,
    model: str,
    max_tokens: int,
    n_repetitions: int,
    num_logprobs: int,
    tensor_parallel_size: int,
) -> None:
    try:
        model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
        model_info.check_available_online(on_fail="skip")
        model_info.check_transformers_version(on_fail="skip")
    except ValueError:
        pass

671
672
673
    compare_operator: Callable = (
        check_logprobs_close if num_logprobs > 0 else check_outputs_equal  # type: ignore
    )
674
675
676
677

    # Sample prompts. This custom prompt is used, as it causes the most issues
    prompt_text = "The president of the United States is "
    prompt_offsets = [0, 3, 7, 13, 17, 22, 25, 31]
678
679
680
    generated_prompts = [
        prompt_text[offset:] * APC_MULTIPLY_BY for offset in prompt_offsets
    ]
681
682
683
684
685
686
687
688
689
690
691
692

    max_model_len = max(len(prompt) + max_tokens for prompt in generated_prompts)
    vllm_runner_kwargs = _get_vllm_runner_params(
        model, max_model_len, tensor_parallel_size
    )
    vllm_runner_kwargs["mamba_ssm_cache_dtype"] = "float32"

    vllm_outputs_no_cache, _ = _get_vLLM_output(
        vllm_runner, vllm_runner_kwargs, generated_prompts, max_tokens, num_logprobs
    )

    vllm_runner_kwargs["enable_prefix_caching"] = True
693
694
    with vllm_runner(**vllm_runner_kwargs) as vllm_model:
        # Retrieve the default mamba state block size
695
696
        vllm_config = vllm_model.llm.llm_engine.vllm_config
        mamba_block_size = vllm_config.cache_config.mamba_block_size
697
698
699
700
701
702
703

    # In case the hybrid model does not have the
    # "mamba_block_size" assume a fixed constant
    if mamba_block_size is None:
        mamba_block_size = 512

    mamba_block_size_multiplier = 10
704
705
706
707
708
709
710
711
712
713
714
715
    for offsets in [-3, 3, mamba_block_size // 4 + 3, mamba_block_size // 2 - 3]:
        vllm_runner_kwargs["max_num_batched_tokens"] = (
            mamba_block_size_multiplier * mamba_block_size - offsets
        )
        vllm_outputs_cache_rep, _ = _get_vLLM_output(
            vllm_runner,
            vllm_runner_kwargs,
            generated_prompts,
            max_tokens,
            num_logprobs,
            n_repetitions,
        )
716
717
718
719
720
721
722
723
724
725
726
727
728
729

        # Check alignment of the output logits when using APC
        for r_idx, vllm_outputs_cache_itn in enumerate(vllm_outputs_cache_rep):
            # In the first repetition, the caches are filled
            # In the second repetition, these caches are reused

            compare_operator(
                outputs_0_lst=vllm_outputs_no_cache[0],
                outputs_1_lst=vllm_outputs_cache_itn,
                name_0="vllm_no_cache",
                name_1=f"vllm_cache_it_{r_idx + 1}",
            )


730
@pytest.mark.parametrize("model", [HYBRID_MODELS[0], HYBRID_MODELS[3]])
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
@pytest.mark.parametrize("max_tokens", [64])
@pytest.mark.parametrize("n_repetitions", [2])
# If num_logprobs is set to -1, then the stringent version
# of the test is executed using `check_outputs_equal`
# instead of `check_logprobs_close`
@pytest.mark.parametrize("num_logprobs", [5])
@pytest.mark.parametrize("tensor_parallel_size", [1])
def test_apc_multiple_prompts_partial_cached_outputs(
    hf_runner,
    vllm_runner,
    example_prompts,
    monkeypatch,
    model: str,
    max_tokens: int,
    n_repetitions: int,
    num_logprobs: int,
    tensor_parallel_size: int,
) -> None:
    try:
        model_info = HF_EXAMPLE_MODELS.find_hf_info(model)
        model_info.check_available_online(on_fail="skip")
        model_info.check_transformers_version(on_fail="skip")
    except ValueError:
        pass

756
757
758
    compare_operator: Callable = (
        check_logprobs_close if num_logprobs > 0 else check_outputs_equal  # type: ignore
    )
759
760

    # Sample prompts.
761
    generated_prompts = [APC_MULTIPLY_BY * prompt for prompt in example_prompts]
762

763
    max_model_len = max(len(prompt) + max_tokens for prompt in generated_prompts)
764
    vllm_runner_kwargs = _get_vllm_runner_params(
765
766
767
        model, max_model_len, tensor_parallel_size=tensor_parallel_size
    )
    vllm_runner_kwargs["mamba_ssm_cache_dtype"] = "float32"
768

769
770
771
    vllm_outputs_no_cache, _ = _get_vLLM_output(
        vllm_runner, vllm_runner_kwargs, generated_prompts, max_tokens, num_logprobs
    )
772
773

    # Cache only part of all the prompts
774
    vllm_runner_kwargs["enable_prefix_caching"] = True
775
    vllm_outputs_partial_cache, vllm_model = _get_vLLM_output(
776
777
        vllm_runner, vllm_runner_kwargs, generated_prompts[:3], max_tokens, num_logprobs
    )
778
779
780
781
782
783
784
785

    compare_operator(
        outputs_0_lst=vllm_outputs_no_cache[0][:3],
        outputs_1_lst=vllm_outputs_partial_cache[0],
        name_0="vllm_no_cache",
        name_1="vllm_partial_cache",
    )

786
787
788
789
790
791
792
793
794
    vllm_outputs_cache_rep, _ = _get_vLLM_output(
        vllm_runner,
        vllm_runner_kwargs,
        generated_prompts,
        max_tokens,
        num_logprobs,
        n_repetitions,
        vllm_model=vllm_model,
    )
795
796
797
798
799
800
801
802
803
804
805

    for r_idx, vllm_outputs_cache_itn in enumerate(vllm_outputs_cache_rep):
        # In the first repetition, the caches are filled
        # In the second repetition, these caches are reused

        compare_operator(
            outputs_0_lst=vllm_outputs_no_cache[0],
            outputs_1_lst=vllm_outputs_cache_itn,
            name_0="vllm_no_cache",
            name_1=f"vllm_cache_it_{r_idx + 1}",
        )
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
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
# Test that outputs match whether prefix caching is enabled or not for mamba.
@pytest.mark.parametrize("model", ["tiiuae/falcon-mamba-7b"])
def test_same_mamba_output_apc_on_vs_off(
    vllm_runner,
    model: str,
) -> None:
    num_logprobs = 5
    prompts = [
        "hello what is one plus one what is one plus one what is one plus one the answer is",  # noqa: E501
        "hello what is one plus one what is one plus one what is one plus one the answer is",  # noqa: E501
    ]
    max_tokens = 20
    max_model_len = max(len(p) for p in prompts) + max_tokens + 64

    base_kwargs = _get_vllm_runner_params(model, max_model_len)
    base_kwargs.update(
        enforce_eager=True, block_size=16, seed=42, gpu_memory_utilization=0.8
    )

    # No prefix caching
    kwargs_no_apc = {**base_kwargs, "enable_prefix_caching": False}
    with vllm_runner(**kwargs_no_apc) as vllm_model:
        outputs_no_apc, _ = _get_vLLM_output(
            vllm_runner,
            kwargs_no_apc,
            prompts,
            max_tokens,
            num_logprobs=num_logprobs,
            vllm_model=vllm_model,
        )
    # With prefix caching
    kwargs_with_apc = {
        **base_kwargs,
        "enable_prefix_caching": True,
        "mamba_block_size": 16,
    }
    with vllm_runner(**kwargs_with_apc) as vllm_model:
        outputs_with_apc, _ = _get_vLLM_output(
            vllm_runner,
            kwargs_with_apc,
            prompts,
            max_tokens,
            num_logprobs=num_logprobs,
            vllm_model=vllm_model,
        )

    check_logprobs_close(
        outputs_0_lst=outputs_no_apc[0],
        outputs_1_lst=outputs_with_apc[0],
        name_0="vllm_no_apc",
        name_1="vllm_with_apc",
    )


862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
# we have to use a real large model to get reasonable results
# the model can't be a hybrid model as we need block_size 16
@pytest.mark.parametrize("model", ["tiiuae/falcon-mamba-7b"])
def test_apc_common_prefix_same_batch(
    model: str,
    monkeypatch,
) -> None:
    # Required to put the two requests in the same batch
    monkeypatch.setenv("VLLM_ENABLE_V1_MULTIPROCESSING", "0")
    llm = LLM(
        model=model,
        enforce_eager=True,
        block_size=16,
        mamba_block_size=16,
        enable_prefix_caching=True,
        seed=42,
878
        attention_backend=ATTN_BACKEND,
879
880
881
882
883
884
885
886
887
    )
    prompts = [
        "hello what is one plus one what is one plus one what is one plus one the answer is",  # noqa: E501
        "hello what is one plus one what is one plus one what is one plus one the answer is",  # noqa: E501
    ]
    sampling_params = SamplingParams(temperature=0.8, top_p=0.95, max_tokens=20)
    outputs = llm.generate(prompts, sampling_params)
    for output in outputs:
        assert "two" in output.outputs[0].text