test_model_runner.py 14.6 KB
Newer Older
1
2
# SPDX-License-Identifier: Apache-2.0

youkaichao's avatar
youkaichao committed
3
import pytest
4
5
import torch

6
7
from vllm.distributed.parallel_state import (ensure_model_parallel_initialized,
                                             init_distributed_environment)
8
from vllm.engine.arg_utils import EngineArgs
9
from vllm.model_executor.sampling_metadata import SamplingMetadata
10
from vllm.sequence import SamplingParams, SequenceData, SequenceGroupMetadata
11
from vllm.utils import get_open_port
12
from vllm.worker.model_runner import ModelRunner
13
14


15
16
17
18
def _create_model_runner(model: str, *args, **kwargs) -> ModelRunner:
    engine_args = EngineArgs(model, *args, **kwargs)
    engine_config = engine_args.create_engine_config()
    model_runner = ModelRunner(
19
        vllm_config=engine_config,
20
21
22
23
24
        is_driver_worker=True,
    )
    return model_runner


25
26
27
28
29
30
31
32
33
def test_deepseek_mla_attn_backend_module():
    model_runner = _create_model_runner(
        "deepseek-ai/DeepSeek-Coder-V2-Lite-Instruct",
        trust_remote_code=True,
        enable_chunked_prefill=False,
    )
    assert model_runner.attn_backend.__name__ == "TritonMLABackend"


youkaichao's avatar
youkaichao committed
34
35
@pytest.mark.parametrize("batch_size", list(range(1, 257)))
def test_prepare_prompt(batch_size):
36
37
38
39
40
41
    model_runner = _create_model_runner(
        "facebook/opt-125m",
        max_num_batched_tokens=100000,
        max_num_seqs=100000,
        enable_chunked_prefill=False,
    )
Woosuk Kwon's avatar
Woosuk Kwon committed
42

43
44
    seq_lens: list[int] = []
    seq_group_metadata_list: list[SequenceGroupMetadata] = []
45
    block_tables = {0: [1]}
46
47
    for i in range(batch_size):
        # make sure all tokens fit into one block
48
49
        seq_len = i % (model_runner.block_size - 1) + 1
        seq_lens.append(seq_len)
50
        seq_data = SequenceData.from_seqs(range(seq_len))
51
52
53
54
55
56
57
58
59
        seq_group_metadata = SequenceGroupMetadata(
            request_id=f"test_{i}",
            is_prompt=True,
            seq_data={0: seq_data},
            sampling_params=SamplingParams(temperature=0),
            block_tables=block_tables,
        )
        assert seq_group_metadata.token_chunk_size == seq_data.get_len()
        seq_group_metadata_list.append(seq_group_metadata)
Woosuk Kwon's avatar
Woosuk Kwon committed
60

61
62
    expected_selected_token_indices = []
    selected_token_start_idx = 0
63
    for seq_len in seq_lens:
64
        expected_selected_token_indices.append(selected_token_start_idx +
65
66
                                               seq_len - 1)
        selected_token_start_idx += seq_len
67
68
    model_input = model_runner._prepare_model_input_tensors(
        seq_group_metadata_list)
69
70
71
72
    input_tokens = model_input.input_tokens
    input_positions = model_input.input_positions
    attn_metadata = model_input.attn_metadata
    return_seq_lens = model_input.seq_lens
73
    slot_mapping = attn_metadata.slot_mapping
74
    assert return_seq_lens == seq_lens
75
    assert len(slot_mapping) == len(input_tokens)
76
77
78

    # Verify input metadata is correct for prompts.
    device = model_runner.device
79
80
    assert attn_metadata.num_prefills > 0
    assert attn_metadata.num_decode_tokens == 0
81
    torch.testing.assert_close(
82
83
84
        attn_metadata.seq_lens_tensor,
        torch.tensor(seq_lens, device=device, dtype=torch.int))
    assert attn_metadata.seq_lens == seq_lens
85
86
    assert attn_metadata.max_prefill_seq_len == max(seq_lens)
    assert attn_metadata.max_decode_seq_len == 0
87
88
89
90

    # Test subquery start locs.
    start_idx = 0
    start_loc = [start_idx]
91
92
    for seq_len in seq_lens:
        start_idx += seq_len
93
        start_loc.append(start_idx)
94
    torch.testing.assert_close(
95
        attn_metadata.query_start_loc,
96
97
98
        torch.tensor(start_loc, dtype=torch.int32, device=device))

    # Test seq start locs. Note that for normal prefill it is
99
    # equivalent to query_start_loc.
100
101
    start_idx = 0
    seq_start_loc = [start_idx]
102
103
    for seq_len in seq_lens:
        start_idx += seq_len
104
105
        seq_start_loc.append(start_idx)

106
    torch.testing.assert_close(
107
        attn_metadata.seq_start_loc,
108
        torch.tensor(start_loc, dtype=torch.int32, device=device))
109
    torch.testing.assert_close(
110
111
        attn_metadata.context_lens_tensor,
        torch.zeros(attn_metadata.context_lens_tensor.shape[0],
112
113
114
115
116
117
                    dtype=torch.int,
                    device=device))

    expected = torch.tensor([[] for _ in range(len(seq_group_metadata_list))],
                            dtype=torch.int32,
                            device=model_runner.device)
118
    torch.testing.assert_close(attn_metadata.block_tables, expected)
119
    # Cuda graph should not be used for prerill.
120
    assert attn_metadata.use_cuda_graph is False
121

122
123
    assert len(input_tokens) == sum(seq_lens)
    assert len(input_positions) == sum(seq_lens)
124
125
    torch.testing.assert_close(input_tokens, input_positions)

126
127
    sampling_metadata = SamplingMetadata.prepare(
        seq_group_metadata_list,
128
129
        seq_lens,
        query_lens=seq_lens,
130
131
        device=model_runner.device,
        pin_memory=model_runner.pin_memory)
132
133
    assert len(input_tokens) == sum(seq_lens)
    assert len(input_positions) == sum(seq_lens)
134
135
136
137
138
    actual = sampling_metadata.selected_token_indices
    expected = torch.tensor(expected_selected_token_indices,
                            device=actual.device,
                            dtype=actual.dtype)
    torch.testing.assert_close(actual, expected)
139
    torch.allclose(input_tokens, input_positions)
140
141
142
143
144
145
146
147

    actual = sampling_metadata.selected_token_indices
    expected = torch.tensor(expected_selected_token_indices,
                            device=actual.device,
                            dtype=actual.dtype)
    torch.testing.assert_close(actual, expected)


youkaichao's avatar
youkaichao committed
148
149
@pytest.mark.parametrize("batch_size", list(range(1, 257)))
def test_prepare_decode_cuda_graph(batch_size):
150
    model_runner = _create_model_runner(
151
152
153
154
        "facebook/opt-125m",
        seed=0,
        dtype="float16",
        enforce_eager=False,
155
156
157
        max_num_batched_tokens=100000,
        max_num_seqs=100000,
        enable_chunked_prefill=False,
158
159
    )

160
161
    context_lens: list[int] = []
    seq_group_metadata_list: list[SequenceGroupMetadata] = []
162
    # Assume each seq group finishes prefill.
163
164
    for i in range(batch_size):
        # make sure all tokens fit into one block
165
166
        context_len = i % (model_runner.block_size - 1) + 1
        context_lens.append(context_len)
167
        seq_data = SequenceData.from_seqs(range(context_len))
168
169
170
        seq_data.update_num_computed_tokens(context_len)
        # Append one token ID since prefill is finished.
        seq_data.append_token_id(1, 0)
171
172
173
174
175
176
177
178
179
        seq_group_metadata = SequenceGroupMetadata(
            request_id=f"test_{i}",
            is_prompt=False,
            seq_data={0: seq_data},
            sampling_params=SamplingParams(temperature=0),
            block_tables={0: [1]},
        )
        assert seq_group_metadata.token_chunk_size == 1
        seq_group_metadata_list.append(seq_group_metadata)
180

181
182
    model_input = model_runner._prepare_model_input_tensors(
        seq_group_metadata_list)
183
184
    input_tokens, input_positions, attn_metadata, slot_mapping = (
        model_input.input_tokens, model_input.input_positions,
185
        model_input.attn_metadata, model_input.attn_metadata.slot_mapping)
186
    assert len(slot_mapping) == len(input_tokens)
187

188
189
    expected_bs = model_runner.vllm_config.pad_for_cudagraph(
        len(seq_group_metadata_list))
190
191
    # Verify input metadata is correct for prompts.
    device = model_runner.device
192
193
194
195
196
197
198
    assert attn_metadata.num_prefills == 0
    assert attn_metadata.num_prefill_tokens == 0
    seq_lens = [context_len + 1 for context_len in context_lens]
    # seq_lens are padded to expected_bs
    for _ in range(expected_bs - len(seq_lens)):
        seq_lens.append(1)
    assert attn_metadata.seq_lens == seq_lens
199
    assert attn_metadata.num_decode_tokens == len(seq_lens)
200
201
202
203
204
205
    start_idx = 0
    start_loc = [start_idx]
    for _ in context_lens:
        # decode has only 1 token for query.
        start_idx += 1
        start_loc.append(start_idx)
206
    torch.testing.assert_close(
207
208
209
210
211
212
213
214
        attn_metadata.query_start_loc,
        torch.tensor(start_loc, dtype=torch.int32, device=device))

    start_idx = 0
    seq_start_loc = [start_idx]
    for seq_len in seq_lens:
        start_idx += seq_len
        seq_start_loc.append(start_idx)
215
    torch.testing.assert_close(
216
217
218
        attn_metadata.seq_start_loc,
        torch.tensor(seq_start_loc, dtype=torch.int32, device=device))

219
    torch.testing.assert_close(
220
221
222
        attn_metadata.context_lens_tensor,
        torch.tensor(context_lens, dtype=torch.int, device=device))
    assert attn_metadata.max_decode_seq_len == max(seq_lens)
223
    torch.testing.assert_close(
224
225
        attn_metadata.seq_lens_tensor[:len(seq_lens)],
        torch.tensor(seq_lens, dtype=torch.int, device=device))
226
227
228

    # block table's first index corresponds to each batch, meaning in
    # decoding it is each token.
229
    assert attn_metadata.block_tables.shape[0] == len(input_tokens)
230
231
    # Block table's second dim correspondsd to each token's block number.
    # It is padded up to
232
    assert attn_metadata.block_tables.shape[1] == (
233
        model_runner.get_max_block_per_batch())
234
    assert attn_metadata.use_cuda_graph is True
235

236
237
    assert len(input_tokens) == expected_bs
    assert len(input_positions) == expected_bs
238
    torch.allclose(input_tokens, input_positions)
Woosuk Kwon's avatar
Woosuk Kwon committed
239

240
241
    # Verify Sampling
    expected_selected_token_indices = []
242
    for selected_token_start_idx, _ in enumerate(context_lens):
243
        expected_selected_token_indices.append(selected_token_start_idx)
244
245
    sampling_metadata = SamplingMetadata.prepare(
        seq_group_metadata_list,
246
        seq_lens,
247
248
        # query lens is all 1 for decode.
        query_lens=[1 for _ in range(len(context_lens))],
249
250
        device=model_runner.device,
        pin_memory=model_runner.pin_memory)
Woosuk Kwon's avatar
Woosuk Kwon committed
251
    actual = sampling_metadata.selected_token_indices
252
253
254
255
    expected = torch.tensor(expected_selected_token_indices,
                            device=actual.device,
                            dtype=actual.dtype)
    torch.testing.assert_close(actual, expected)
256
257
258
259


def test_empty_seq_group():
    """Verify prepare prompt and decode returns empty output."""
260
    model_runner = _create_model_runner(
261
262
263
264
265
        "facebook/opt-125m",
        seed=0,
        dtype="float16",
        enforce_eager=False,
    )
266
    seq_group_metadata_list: list[SequenceGroupMetadata] = []
267
268
269
    model_input = model_runner._prepare_model_input_tensors(
        seq_group_metadata_list)
    input_tokens, input_positions, attn_metadata = (
270
271
272
273
        model_input.input_tokens,
        model_input.input_positions,
        model_input.attn_metadata,
    )
274
275
    assert input_tokens is None
    assert input_positions is None
276
    assert attn_metadata is None
277
278
279
280
281
282
283
284
285
286
287

    model_input = model_runner._prepare_model_input_tensors(
        seq_group_metadata_list)
    (input_tokens, input_positions, attn_metadata, return_seq_lens) = (
        model_input.input_tokens,
        model_input.input_positions,
        model_input.attn_metadata,
        model_input.seq_lens,
    )
    assert input_tokens is None
    assert input_positions is None
288
    assert attn_metadata is None
289
    assert return_seq_lens is None
290
291


292
293
294
295
296
297
298
@pytest.fixture
def distributed_init():
    init_distributed_environment(
        world_size=1,
        rank=0,
        distributed_init_method=f"tcp://127.0.0.1:{get_open_port()}",
        local_rank=0)
299
    ensure_model_parallel_initialized(1, 1)
300
301


302
303
304
@pytest.mark.parametrize("batch_size", list(range(2, 128)))
@pytest.mark.parametrize("enforce_eager", [True, False])
def test_hybrid_batches(batch_size, enforce_eager, distributed_init):
305
    model_runner = _create_model_runner(
306
307
308
309
        "facebook/opt-125m",
        seed=0,
        dtype="float16",
        enforce_eager=enforce_eager,
310
311
312
        max_num_batched_tokens=100000,
        max_num_seqs=100000,
        enable_chunked_prefill=True,
313
314
315
    )

    # Add prefill requests.
316
317
318
319
    seq_lens: list[int] = []
    seq_group_metadata_list: list[SequenceGroupMetadata] = []
    prefill_metadata_list: list[SequenceGroupMetadata] = []
    decode_metadata_list: list[SequenceGroupMetadata] = []
320
321
322
323
324
    block_tables = {0: [1]}
    prefill_batch_size = batch_size // 2
    decode_batch_size = batch_size - prefill_batch_size
    for i in range(prefill_batch_size):
        # make sure all tokens fit into one block
325
326
        seq_len = i % (model_runner.block_size - 1) + 1
        seq_lens.append(seq_len)
327
        seq_data = SequenceData.from_seqs(range(seq_len))
328
329
330
331
332
333
334
335
336
337
338
339
340
341
        seq_group_metadata = SequenceGroupMetadata(
            request_id=f"test_{i}",
            is_prompt=True,
            seq_data={0: seq_data},
            sampling_params=SamplingParams(temperature=0),
            block_tables=block_tables,
        )
        assert seq_group_metadata.token_chunk_size == seq_data.get_len()
        seq_group_metadata_list.append(seq_group_metadata)
        prefill_metadata_list.append(seq_group_metadata)

    # Add decode requests
    for i in range(prefill_batch_size, batch_size):
        # make sure all tokens fit into one block
342
        context_len = i % (model_runner.block_size - 1) + 1
343
        seq_data = SequenceData.from_seqs(range(context_len))
344
345
        seq_data.append_token_id(1, 0)
        seq_data.update_num_computed_tokens(context_len)
346
347
348
349
350
351
352
353
354
355
356
        seq_group_metadata = SequenceGroupMetadata(
            request_id=f"test_{i}",
            is_prompt=False,
            seq_data={0: seq_data},
            sampling_params=SamplingParams(temperature=0),
            block_tables={0: [1]},
        )
        assert seq_group_metadata.token_chunk_size == 1
        seq_group_metadata_list.append(seq_group_metadata)
        decode_metadata_list.append(seq_group_metadata)

357
358
359
360
361
362
    model_input = model_runner.prepare_model_input(seq_group_metadata_list)
    (input_tokens, input_positions, attn_metadata) = (
        model_input.input_tokens,
        model_input.input_positions,
        model_input.attn_metadata,
    )
363
364
365
366
367
368
369

    prefill_meta_actual = attn_metadata.prefill_metadata
    decode_meta_actual = attn_metadata.decode_metadata

    assert len(attn_metadata.slot_mapping) == len(input_tokens)
    assert len(input_positions) == len(input_tokens)
    assert attn_metadata.num_prefills == prefill_batch_size
370
    assert attn_metadata.num_decode_tokens == decode_batch_size
371
    assert attn_metadata.num_prefill_tokens == sum(seq_lens)
372
373
374

    # Verify attn metadata is consistent. We don't need to test individual
    # values here because they are tested above.
375
    attn_metadata = model_runner._prepare_model_input_tensors(
376
        seq_group_metadata_list).attn_metadata
377

378
    for attr_expected, attr_actual in zip(vars(attn_metadata.prefill_metadata),
379
380
                                          vars(prefill_meta_actual)):
        assert attr_expected[1] == attr_actual[1]
381
    for attr_expected, attr_actual in zip(vars(attn_metadata.decode_metadata),
382
383
                                          vars(decode_meta_actual)):
        assert attr_expected[1] == attr_actual[1]