conftest.py 17.8 KB
Newer Older
1
2
import contextlib
import gc
3
import os
4
from typing import Any, Dict, List, Optional, Tuple
Woosuk Kwon's avatar
Woosuk Kwon committed
5
6
7

import pytest
import torch
8
import torch.nn.functional as F
9
from PIL import Image
10
11
from transformers import (AutoModelForCausalLM, AutoProcessor, AutoTokenizer,
                          LlavaConfig, LlavaForConditionalGeneration)
Woosuk Kwon's avatar
Woosuk Kwon committed
12
13

from vllm import LLM, SamplingParams
14
from vllm.config import TokenizerPoolConfig, VisionLanguageConfig
15
from vllm.distributed import destroy_model_parallel
16
from vllm.inputs import TextPrompt
17
from vllm.logger import init_logger
18
19
20
from vllm.multimodal import MultiModalData
from vllm.multimodal.image import ImageFeatureData, ImagePixelData
from vllm.sequence import SampleLogprobs
21
from vllm.utils import is_cpu
22
23

logger = init_logger(__name__)
Woosuk Kwon's avatar
Woosuk Kwon committed
24

25
26
27
_TEST_DIR = os.path.dirname(__file__)
_TEST_PROMPTS = [os.path.join(_TEST_DIR, "prompts", "example.txt")]
_LONG_PROMPTS = [os.path.join(_TEST_DIR, "prompts", "summary.txt")]
28

29
# Multi modal related
30
# You can use `.buildkite/download-images.sh` to download the assets
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
_PIXEL_VALUES_FILES = [
    os.path.join(_TEST_DIR, "images", filename) for filename in
    ["stop_sign_pixel_values.pt", "cherry_blossom_pixel_values.pt"]
]
_IMAGE_FEATURES_FILES = [
    os.path.join(_TEST_DIR, "images", filename) for filename in
    ["stop_sign_image_features.pt", "cherry_blossom_image_features.pt"]
]
_IMAGE_FILES = [
    os.path.join(_TEST_DIR, "images", filename)
    for filename in ["stop_sign.jpg", "cherry_blossom.jpg"]
]
_IMAGE_PROMPTS = [
    "<image>\nUSER: What's the content of the image?\nASSISTANT:",
    "<image>\nUSER: What is the season?\nASSISTANT:"
]
assert len(_PIXEL_VALUES_FILES) == len(_IMAGE_FEATURES_FILES) == len(
    _IMAGE_FILES) == len(_IMAGE_PROMPTS)

50

51
def _read_prompts(filename: str) -> List[str]:
52
    with open(filename, "r") as f:
53
54
        prompts = f.readlines()
        return prompts
Woosuk Kwon's avatar
Woosuk Kwon committed
55
56


57
58
59
60
61
def cleanup():
    destroy_model_parallel()
    with contextlib.suppress(AssertionError):
        torch.distributed.destroy_process_group()
    gc.collect()
62
63
    if not is_cpu():
        torch.cuda.empty_cache()
64
65


66
@pytest.fixture()
67
def should_do_global_cleanup_after_test(request) -> bool:
68
69
70
71
    """Allow subdirectories to skip global cleanup by overriding this fixture.
    This can provide a ~10x speedup for non-GPU unit tests since they don't need
    to initialize torch.
    """
72
73
74
75

    if request.node.get_closest_marker("skip_global_cleanup"):
        return False

76
77
78
    return True


79
@pytest.fixture(autouse=True)
80
def cleanup_fixture(should_do_global_cleanup_after_test: bool):
81
    yield
82
83
    if should_do_global_cleanup_after_test:
        cleanup()
84
85


86
87
88
89
90
91
92
93
94
95
96
@pytest.fixture(scope="session")
def hf_image_prompts() -> List[str]:
    return _IMAGE_PROMPTS


@pytest.fixture(scope="session")
def hf_images() -> List[Image.Image]:
    return [Image.open(filename) for filename in _IMAGE_FILES]


@pytest.fixture()
97
def vllm_images(request) -> List[MultiModalData]:
98
99
100
    vision_language_config = request.getfixturevalue("model_and_config")[1]
    if vision_language_config.image_input_type == (
            VisionLanguageConfig.ImageInputType.IMAGE_FEATURES):
101
102
103
104
        return [
            ImageFeatureData(torch.load(filename))
            for filename in _IMAGE_FEATURES_FILES
        ]
105
    else:
106
107
108
109
110
111
112
113
        return [
            ImagePixelData(Image.open(filename)) for filename in _IMAGE_FILES
        ]


@pytest.fixture()
def vllm_image_tensors(request) -> List[torch.Tensor]:
    return [torch.load(filename) for filename in _PIXEL_VALUES_FILES]
114
115
116
117
118
119
120
121
122
123
124


@pytest.fixture()
def vllm_image_prompts(request) -> List[str]:
    vision_language_config = request.getfixturevalue("model_and_config")[1]
    return [
        "<image>" * (vision_language_config.image_feature_size - 1) + p
        for p in _IMAGE_PROMPTS
    ]


Woosuk Kwon's avatar
Woosuk Kwon committed
125
126
@pytest.fixture
def example_prompts() -> List[str]:
127
128
    prompts = []
    for filename in _TEST_PROMPTS:
129
        prompts += _read_prompts(filename)
130
131
132
133
134
135
136
    return prompts


@pytest.fixture
def example_long_prompts() -> List[str]:
    prompts = []
    for filename in _LONG_PROMPTS:
137
        prompts += _read_prompts(filename)
138
    return prompts
Woosuk Kwon's avatar
Woosuk Kwon committed
139
140
141
142
143
144
145
146


_STR_DTYPE_TO_TORCH_DTYPE = {
    "half": torch.half,
    "bfloat16": torch.bfloat16,
    "float": torch.float,
}

147
AutoModelForCausalLM.register(LlavaConfig, LlavaForConditionalGeneration)
148

149
150
151
152
_EMBEDDING_MODELS = [
    "intfloat/e5-mistral-7b-instruct",
]

Woosuk Kwon's avatar
Woosuk Kwon committed
153
154
155

class HfRunner:

156
157
158
159
160
161
    def wrap_device(self, input: any):
        if not is_cpu():
            return input.to("cuda")
        else:
            return input.to("cpu")

Woosuk Kwon's avatar
Woosuk Kwon committed
162
163
164
165
166
167
168
    def __init__(
        self,
        model_name: str,
        dtype: str = "half",
    ) -> None:
        assert dtype in _STR_DTYPE_TO_TORCH_DTYPE
        torch_dtype = _STR_DTYPE_TO_TORCH_DTYPE[dtype]
169

170
        self.model_name = model_name
171
172

        if model_name in _EMBEDDING_MODELS:
173
174
            # Lazy init required for AMD CI
            from sentence_transformers import SentenceTransformer
175
176
177
178
179
            self.model = self.wrap_device(
                SentenceTransformer(
                    model_name,
                    device="cpu",
                ).to(dtype=torch_dtype))
180
        else:
181
182
183
184
185
186
            self.model = self.wrap_device(
                AutoModelForCausalLM.from_pretrained(
                    model_name,
                    torch_dtype=torch_dtype,
                    trust_remote_code=True,
                ))
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204

        self.tokenizer = AutoTokenizer.from_pretrained(
            model_name,
            torch_dtype=torch_dtype,
            trust_remote_code=True,
        )

        try:
            self.processor = AutoProcessor.from_pretrained(
                model_name,
                torch_dtype=torch_dtype,
                trust_remote_code=True,
            )
        except Exception:
            logger.warning(
                "Unable to auto-load processor from HuggingFace for "
                "model %s. Using tokenizer instead.", model_name)
            self.processor = self.tokenizer
Woosuk Kwon's avatar
Woosuk Kwon committed
205
206
207
208

    def generate(
        self,
        prompts: List[str],
209
        images: Optional[List[Image.Image]] = None,
Woosuk Kwon's avatar
Woosuk Kwon committed
210
        **kwargs,
211
    ) -> List[Tuple[List[List[int]], List[str]]]:
212
213
        if images:
            assert len(prompts) == len(images)
214
215

        outputs: List[Tuple[List[List[int]], List[str]]] = []
216
        for i, prompt in enumerate(prompts):
217
218
219
220
221
222
223
224
225
            processor_kwargs: Dict[str, Any] = {
                "text": prompt,
                "return_tensors": "pt",
            }
            if images is not None and images[i] is not None:
                processor_kwargs["images"] = images[i]

            inputs = self.processor(**processor_kwargs)

Woosuk Kwon's avatar
Woosuk Kwon committed
226
            output_ids = self.model.generate(
227
                **self.wrap_device(inputs),
Woosuk Kwon's avatar
Woosuk Kwon committed
228
229
230
                use_cache=True,
                **kwargs,
            )
231
            output_str = self.processor.batch_decode(
Woosuk Kwon's avatar
Woosuk Kwon committed
232
233
234
                output_ids,
                skip_special_tokens=True,
                clean_up_tokenization_spaces=False,
235
236
            )
            output_ids = output_ids.cpu().tolist()
Woosuk Kwon's avatar
Woosuk Kwon committed
237
238
239
240
241
242
243
            outputs.append((output_ids, output_str))
        return outputs

    def generate_greedy(
        self,
        prompts: List[str],
        max_tokens: int,
244
        images: Optional[List[Image.Image]] = None,
Woosuk Kwon's avatar
Woosuk Kwon committed
245
    ) -> List[Tuple[List[int], str]]:
246
247
        outputs = self.generate(prompts,
                                do_sample=False,
248
249
                                max_new_tokens=max_tokens,
                                images=images)
250
251
252

        return [(output_ids[0], output_str[0])
                for output_ids, output_str in outputs]
253
254
255
256
257
258

    def generate_beam_search(
        self,
        prompts: List[str],
        beam_width: int,
        max_tokens: int,
259
    ) -> List[Tuple[List[List[int]], List[str]]]:
260
261
262
263
264
265
266
267
268
269
270
271
272
273
        outputs = self.generate(prompts,
                                do_sample=False,
                                max_new_tokens=max_tokens,
                                num_beams=beam_width,
                                num_return_sequences=beam_width)
        for i in range(len(outputs)):
            output_ids, output_str = outputs[i]
            for j in range(len(output_ids)):
                output_ids[j] = [
                    x for x in output_ids[j]
                    if x != self.tokenizer.pad_token_id
                ]
            outputs[i] = (output_ids, output_str)
        return outputs
Woosuk Kwon's avatar
Woosuk Kwon committed
274

275
276
277
278
279
280
281
282
283
    def generate_greedy_logprobs(
        self,
        prompts: List[str],
        max_tokens: int,
    ) -> List[List[torch.Tensor]]:
        all_logprobs = []
        for prompt in prompts:
            input_ids = self.tokenizer(prompt, return_tensors="pt").input_ids
            output = self.model.generate(
284
                self.wrap_device(input_ids),
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
                use_cache=True,
                do_sample=False,
                max_new_tokens=max_tokens,
                output_hidden_states=True,
                return_dict_in_generate=True,
            )
            seq_logprobs = []
            for hidden_states in output.hidden_states:
                last_hidden_states = hidden_states[-1][0]
                logits = torch.matmul(
                    last_hidden_states,
                    self.model.get_output_embeddings().weight.t(),
                )
                if self.model.get_output_embeddings().bias is not None:
                    logits += self.model.get_output_embeddings(
                    ).bias.unsqueeze(0)
301
                logprobs = F.log_softmax(logits, dim=-1, dtype=torch.float32)
302
303
304
305
                seq_logprobs.append(logprobs)
            all_logprobs.append(seq_logprobs)
        return all_logprobs

306
307
308
309
310
    def generate_greedy_logprobs_limit(
        self,
        prompts: List[str],
        max_tokens: int,
        num_logprobs: int,
311
312
313
314
    ) -> List[Tuple[List[int], str, List[Dict[int, float]]]]:
        all_logprobs: List[List[Dict[int, float]]] = []
        all_output_ids: List[List[int]] = []
        all_output_strs: List[str] = []
315
316
317
318

        for prompt in prompts:
            input_ids = self.tokenizer(prompt, return_tensors="pt").input_ids
            output = self.model.generate(
319
                self.wrap_device(input_ids),
320
321
322
323
324
325
326
                use_cache=True,
                do_sample=False,
                max_new_tokens=max_tokens,
                output_hidden_states=True,
                return_dict_in_generate=True,
            )

327
            seq_logprobs: List[torch.Tensor] = []
328
329
330
331
332
333
334
335
336
337
            for _, hidden_states in enumerate(output.hidden_states):
                last_hidden_states = hidden_states[-1][0]
                logits = torch.matmul(
                    last_hidden_states,
                    self.model.get_output_embeddings().weight.t(),
                )
                if getattr(self.model.get_output_embeddings(), "bias",
                           None) is not None:
                    logits += self.model.get_output_embeddings(
                    ).bias.unsqueeze(0)
338
                logprobs = F.log_softmax(logits, dim=-1, dtype=torch.float32)
339
340
341
                seq_logprobs.append(logprobs)

            # convert to dict
342
            seq_logprobs_lst: List[Dict[int, float]] = []
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
            for tok_idx, tok_logprobs in enumerate(seq_logprobs):
                # drop prompt logprobs
                if tok_idx == 0:
                    tok_logprobs = tok_logprobs[-1, :].reshape(1, -1)
                topk = tok_logprobs.topk(num_logprobs)

                tok_logprobs_dct = {}
                for token_id, logprob in zip(topk.indices[0], topk.values[0]):
                    tok_logprobs_dct[token_id.item()] = logprob.item()

                seq_logprobs_lst.append(tok_logprobs_dct)

            all_logprobs.append(seq_logprobs_lst)
            seq_ids = output.sequences[0]
            output_len = seq_ids.shape[0] - input_ids.shape[1]
            output_ids = seq_ids[-output_len:]
            all_output_ids.append(output_ids.tolist())
            all_output_strs.append(self.tokenizer.decode(output_ids))

        outputs = zip(all_output_ids, all_output_strs, all_logprobs)
        return [(output_ids, output_str, output_logprobs)
                for output_ids, output_str, output_logprobs in outputs]

366
367
368
    def encode(self, prompts: List[str]) -> List[List[torch.Tensor]]:
        return self.model.encode(prompts)

369
370
371
372
    def __del__(self):
        del self.model
        cleanup()

Woosuk Kwon's avatar
Woosuk Kwon committed
373
374
375
376
377
378
379
380
381
382
383
384

@pytest.fixture
def hf_runner():
    return HfRunner


class VllmRunner:

    def __init__(
        self,
        model_name: str,
        tokenizer_name: Optional[str] = None,
385
386
        # Use smaller max model length, otherwise bigger model cannot run due
        # to kv cache size limit.
387
        max_model_len: int = 1024,
Woosuk Kwon's avatar
Woosuk Kwon committed
388
        dtype: str = "half",
389
        disable_log_stats: bool = True,
390
        tensor_parallel_size: int = 1,
391
392
        block_size: int = 16,
        enable_chunked_prefill: bool = False,
393
        swap_space: int = 4,
394
        **kwargs,
Woosuk Kwon's avatar
Woosuk Kwon committed
395
396
397
398
399
400
    ) -> None:
        self.model = LLM(
            model=model_name,
            tokenizer=tokenizer_name,
            trust_remote_code=True,
            dtype=dtype,
401
            swap_space=swap_space,
402
            disable_log_stats=disable_log_stats,
403
            tensor_parallel_size=tensor_parallel_size,
404
            max_model_len=max_model_len,
405
406
            block_size=block_size,
            enable_chunked_prefill=enable_chunked_prefill,
407
            **kwargs,
Woosuk Kwon's avatar
Woosuk Kwon committed
408
409
410
411
412
413
        )

    def generate(
        self,
        prompts: List[str],
        sampling_params: SamplingParams,
414
        images: Optional[List[MultiModalData]] = None,
415
    ) -> List[Tuple[List[List[int]], List[str]]]:
416
        if images is not None:
417
            assert len(prompts) == len(images)
418

419
420
421
422
        inputs = [TextPrompt(prompt=prompt) for prompt in prompts]
        if images is not None:
            for i, image in enumerate(images):
                inputs[i]["multi_modal_data"] = image
423

424
        req_outputs = self.model.generate(inputs,
425
                                          sampling_params=sampling_params)
426
427

        outputs: List[Tuple[List[List[int]], List[str]]] = []
Woosuk Kwon's avatar
Woosuk Kwon committed
428
429
430
        for req_output in req_outputs:
            prompt_str = req_output.prompt
            prompt_ids = req_output.prompt_token_ids
431
432
            req_sample_output_ids: List[List[int]] = []
            req_sample_output_strs: List[str] = []
433
434
435
436
437
438
            for sample in req_output.outputs:
                output_str = sample.text
                output_ids = sample.token_ids
                req_sample_output_ids.append(prompt_ids + output_ids)
                req_sample_output_strs.append(prompt_str + output_str)
            outputs.append((req_sample_output_ids, req_sample_output_strs))
Woosuk Kwon's avatar
Woosuk Kwon committed
439
440
        return outputs

441
442
443
444
    def generate_w_logprobs(
        self,
        prompts: List[str],
        sampling_params: SamplingParams,
445
    ) -> List[Tuple[List[int], str, Optional[SampleLogprobs]]]:
446
447
448
449
        assert sampling_params.logprobs is not None

        req_outputs = self.model.generate(prompts,
                                          sampling_params=sampling_params)
450
        outputs: List[Tuple[List[int], str, Optional[SampleLogprobs]]] = []
451
452
453
454
455
456
457
458
        for req_output in req_outputs:
            for sample in req_output.outputs:
                output_str = sample.text
                output_ids = sample.token_ids
                output_logprobs = sample.logprobs
            outputs.append((output_ids, output_str, output_logprobs))
        return outputs

Woosuk Kwon's avatar
Woosuk Kwon committed
459
460
461
462
    def generate_greedy(
        self,
        prompts: List[str],
        max_tokens: int,
463
        images: Optional[List[MultiModalData]] = None,
Woosuk Kwon's avatar
Woosuk Kwon committed
464
465
    ) -> List[Tuple[List[int], str]]:
        greedy_params = SamplingParams(temperature=0.0, max_tokens=max_tokens)
466
        outputs = self.generate(prompts, greedy_params, images=images)
467
468
        return [(output_ids[0], output_str[0])
                for output_ids, output_str in outputs]
469

470
471
472
473
474
    def generate_greedy_logprobs(
        self,
        prompts: List[str],
        max_tokens: int,
        num_logprobs: int,
475
    ) -> List[Tuple[List[int], str, Optional[SampleLogprobs]]]:
476
477
478
479
480
481
482
483
        greedy_logprobs_params = SamplingParams(temperature=0.0,
                                                max_tokens=max_tokens,
                                                logprobs=num_logprobs)
        outputs = self.generate_w_logprobs(prompts, greedy_logprobs_params)

        return [(output_ids, output_str, output_logprobs)
                for output_ids, output_str, output_logprobs in outputs]

484
485
486
487
488
    def generate_beam_search(
        self,
        prompts: List[str],
        beam_width: int,
        max_tokens: int,
489
    ) -> List[Tuple[List[List[int]], List[str]]]:
490
491
492
493
494
495
        beam_search_params = SamplingParams(n=beam_width,
                                            use_beam_search=True,
                                            temperature=0.0,
                                            max_tokens=max_tokens)
        outputs = self.generate(prompts, beam_search_params)
        return outputs
Woosuk Kwon's avatar
Woosuk Kwon committed
496

497
498
499
500
501
502
503
504
    def encode(self, prompts: List[str]) -> List[List[float]]:
        req_outputs = self.model.encode(prompts)
        outputs = []
        for req_output in req_outputs:
            embedding = req_output.outputs.embedding
            outputs.append(embedding)
        return outputs

505
506
507
508
    def __del__(self):
        del self.model
        cleanup()

Woosuk Kwon's avatar
Woosuk Kwon committed
509

510
@pytest.fixture(scope="session")
Woosuk Kwon's avatar
Woosuk Kwon committed
511
512
def vllm_runner():
    return VllmRunner
513
514
515
516
517
518
519
520
521
522


def get_tokenizer_pool_config(tokenizer_group_type):
    if tokenizer_group_type is None:
        return None
    if tokenizer_group_type == "ray":
        return TokenizerPoolConfig(pool_size=1,
                                   pool_type="ray",
                                   extra_config={})
    raise ValueError(f"Unknown tokenizer_group_type: {tokenizer_group_type}")
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538


@pytest.fixture()
def temporary_enable_log_propagate():
    import logging
    logger = logging.getLogger("vllm")
    logger.propagate = True
    yield
    logger.propagate = False


@pytest.fixture()
def caplog_vllm(temporary_enable_log_propagate, caplog):
    # To capture vllm log, we should enable propagate=True temporarily
    # because caplog depends on logs propagated to the root logger.
    yield caplog