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

4
import base64
5
import json
6
7

import numpy as np
8
9
import openai
import pytest
10
import pytest_asyncio
11
import requests
12
13
import torch
import torch.nn.functional as F
14

15
from tests.models.language.pooling.embed_utils import run_embedding_correctness_test
16
17
from tests.models.utils import check_embeddings_close
from tests.utils import RemoteOpenAIServer
18
19
from vllm.entrypoints.pooling.embed.protocol import EmbeddingResponse
from vllm.entrypoints.pooling.pooling.protocol import PoolingResponse
20
from vllm.platforms import current_platform
21
from vllm.tokenizers import get_tokenizer
22
23
24
25
26
from vllm.utils.serial_utils import (
    EMBED_DTYPE_TO_TORCH_DTYPE,
    ENDIANNESS,
    MetadataItem,
    binary2tensor,
27
    build_metadata_items,
28
29
    decode_pooling_output,
)
30

31
MODEL_NAME = "intfloat/multilingual-e5-small"
32
DUMMY_CHAT_TEMPLATE = """{% for message in messages %}{{message['role'] + ': ' + message['content'] + '\\n'}}{% endfor %}"""  # noqa: E501
33
DTYPE = "bfloat16"
34
35


36
37
38
39
40
41
42
43
44
if current_platform.is_rocm():
    # Disable Flash/MemEfficient SDP on ROCm to avoid HF Transformers
    # accuracy issues: https://github.com/vllm-project/vllm/issues/30167
    # TODO: Remove once ROCm SDP accuracy issues are resolved on HuggingFace
    torch.backends.cuda.enable_flash_sdp(False)
    torch.backends.cuda.enable_mem_efficient_sdp(False)
    torch.backends.cuda.enable_math_sdp(True)


45
@pytest.fixture(scope="module")
46
def server():
47
    args = [
48
49
        "--runner",
        "pooling",
50
51
        # use half precision for speed and memory savings in CI environment
        "--dtype",
52
        DTYPE,
53
54
        "--enforce-eager",
        "--max-model-len",
55
        "512",
56
57
        "--chat-template",
        DUMMY_CHAT_TEMPLATE,
58
59
    ]

60
61
62
63
    # ROCm: Use Flex Attention to support encoder-only self-attention.
    if current_platform.is_rocm():
        args.extend(["--attention-backend", "FLEX_ATTENTION"])

64
    with RemoteOpenAIServer(MODEL_NAME, args) as remote_server:
65
        yield remote_server
66
67


68
@pytest_asyncio.fixture
69
70
async def client(server):
    async with server.get_async_client() as async_client:
71
        yield async_client
72
73


74
75
@pytest.fixture(scope="module")
def hf_model(hf_runner):
76
    with hf_runner(MODEL_NAME, dtype=DTYPE, is_sentence_transformer=True) as hf_model:
77
78
79
        yield hf_model


80
@pytest.mark.asyncio
81
@pytest.mark.parametrize("model_name", [MODEL_NAME])
82
async def test_single_embedding(hf_model, client: openai.AsyncOpenAI, model_name: str):
83
84
85
86
87
    input_texts = [
        "The chef prepared a delicious meal.",
    ]

    # test single embedding
88
    embedding_response = await client.embeddings.create(
89
90
91
92
        model=model_name,
        input=input_texts,
        encoding_format="float",
    )
93
    embeddings = EmbeddingResponse.model_validate(
94
95
        embedding_response.model_dump(mode="json")
    )
96

97
98
    assert embeddings.id is not None
    assert len(embeddings.data) == 1
99
    assert len(embeddings.data[0].embedding) == 384
100
    assert embeddings.usage.completion_tokens == 0
101
102
    assert embeddings.usage.prompt_tokens == 11
    assert embeddings.usage.total_tokens == 11
103

104
    vllm_outputs = [d.embedding for d in embeddings.data]
105
    run_embedding_correctness_test(hf_model, input_texts, vllm_outputs)
106

107
108
    # test using token IDs
    input_tokens = [1, 1, 1, 1, 1]
109
    embedding_response = await client.embeddings.create(
110
111
112
113
        model=model_name,
        input=input_tokens,
        encoding_format="float",
    )
114
    embeddings = EmbeddingResponse.model_validate(
115
116
        embedding_response.model_dump(mode="json")
    )
117

118
119
    assert embeddings.id is not None
    assert len(embeddings.data) == 1
120
    assert len(embeddings.data[0].embedding) == 384
121
122
123
124
125
126
    assert embeddings.usage.completion_tokens == 0
    assert embeddings.usage.prompt_tokens == 5
    assert embeddings.usage.total_tokens == 5


@pytest.mark.asyncio
127
@pytest.mark.parametrize("model_name", [MODEL_NAME])
128
async def test_batch_embedding(hf_model, client: openai.AsyncOpenAI, model_name: str):
129
    # test list[str]
130
    input_texts = [
131
132
133
        "The cat sat on the mat.",
        "A feline was resting on a rug.",
        "Stars twinkle brightly in the night sky.",
134
    ]
135
    embedding_response = await client.embeddings.create(
136
137
138
139
        model=model_name,
        input=input_texts,
        encoding_format="float",
    )
140
    embeddings = EmbeddingResponse.model_validate(
141
142
        embedding_response.model_dump(mode="json")
    )
143

144
145
    assert embeddings.id is not None
    assert len(embeddings.data) == 3
146
    assert len(embeddings.data[0].embedding) == 384
147
    assert embeddings.usage.completion_tokens == 0
148
149
    assert embeddings.usage.prompt_tokens == 33
    assert embeddings.usage.total_tokens == 33
150

151
    vllm_outputs = [d.embedding for d in embeddings.data]
152
    run_embedding_correctness_test(hf_model, input_texts, vllm_outputs)
153

154
    # test list[list[int]]
155
156
157
158
159
160
    input_tokens = [
        [4, 5, 7, 9, 20],
        [15, 29, 499],
        [24, 24, 24, 24, 24],
        [25, 32, 64, 77],
    ]
161
    embedding_response = await client.embeddings.create(
162
163
164
165
        model=model_name,
        input=input_tokens,
        encoding_format="float",
    )
166
    embeddings = EmbeddingResponse.model_validate(
167
168
        embedding_response.model_dump(mode="json")
    )
169

170
171
    assert embeddings.id is not None
    assert len(embeddings.data) == 4
172
    assert len(embeddings.data[0].embedding) == 384
173
174
175
    assert embeddings.usage.completion_tokens == 0
    assert embeddings.usage.prompt_tokens == 17
    assert embeddings.usage.total_tokens == 17
176
177
178


@pytest.mark.asyncio
179
@pytest.mark.parametrize("model_name", [MODEL_NAME])
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
async def test_conversation_embedding(
    server: RemoteOpenAIServer, client: openai.AsyncOpenAI, model_name: str
):
    messages = [
        {
            "role": "user",
            "content": "The cat sat on the mat.",
        },
        {
            "role": "assistant",
            "content": "A feline was resting on a rug.",
        },
        {
            "role": "user",
            "content": "Stars twinkle brightly in the night sky.",
        },
    ]
197

198
199
200
201
202
203
204
205
    chat_response = requests.post(
        server.url_for("v1/embeddings"),
        json={
            "model": model_name,
            "messages": messages,
            "encoding_format": "float",
        },
    )
206
    chat_response.raise_for_status()
207
    chat_embeddings = EmbeddingResponse.model_validate(chat_response.json())
208

209
    tokenizer = get_tokenizer(tokenizer_name=model_name)
210
211
212
213
214
215
216
217
218
219
220
221
222
223
    prompt = tokenizer.apply_chat_template(
        messages,
        chat_template=DUMMY_CHAT_TEMPLATE,
        add_generation_prompt=True,
        continue_final_message=False,
        tokenize=False,
    )
    completion_response = await client.embeddings.create(
        model=model_name,
        input=prompt,
        encoding_format="float",
        # To be consistent with chat
        extra_body={"add_special_tokens": False},
    )
224
    completion_embeddings = EmbeddingResponse.model_validate(
225
226
        completion_response.model_dump(mode="json")
    )
227

228
229
230
    assert chat_embeddings.id is not None
    assert completion_embeddings.id is not None
    assert chat_embeddings.created <= completion_embeddings.created
231
232
233
    assert chat_embeddings.model_dump(exclude={"id", "created"}) == (
        completion_embeddings.model_dump(exclude={"id", "created"})
    )
234
235
236
237


@pytest.mark.asyncio
@pytest.mark.parametrize("model_name", [MODEL_NAME])
238
239
240
async def test_batch_base64_embedding(
    hf_model, client: openai.AsyncOpenAI, model_name: str
):
241
242
    input_texts = [
        "Hello my name is",
243
        "The best thing about vLLM is that it supports many different models",
244
245
    ]

246
247
248
    responses_float = await client.embeddings.create(
        input=input_texts, model=model_name, encoding_format="float"
    )
249
    float_data = [d.embedding for d in responses_float.data]
250
    run_embedding_correctness_test(hf_model, input_texts, float_data)
251

252
253
254
    responses_base64 = await client.embeddings.create(
        input=input_texts, model=model_name, encoding_format="base64"
    )
255
    base64_data = []
256
    for data in responses_base64.data:
257
        base64_data.append(
258
259
            np.frombuffer(base64.b64decode(data.embedding), dtype="float32").tolist()
        )
260

261
    run_embedding_correctness_test(hf_model, input_texts, base64_data)
262
263

    # Default response is float32 decoded from base64 by OpenAI Client
264
265
266
    responses_default = await client.embeddings.create(
        input=input_texts, model=model_name
    )
267
    default_data = [d.embedding for d in responses_default.data]
268
    run_embedding_correctness_test(hf_model, input_texts, default_data)
269
270


271
272
@pytest.mark.asyncio
@pytest.mark.parametrize("model_name", [MODEL_NAME])
273
274
async def test_base64_embed_dtype_and_endianness(
    server: RemoteOpenAIServer, client: openai.AsyncOpenAI, model_name: str
275
276
277
278
279
280
281
282
283
284
):
    input_texts = [
        "The best thing about vLLM is that it supports many different models",
    ]

    responses_float = await client.embeddings.create(
        input=input_texts, model=model_name, encoding_format="float"
    )
    float_data = [d.embedding for d in responses_float.data]

285
286
287
288
289
290
291
292
293
294
295
    for embed_dtype in EMBED_DTYPE_TO_TORCH_DTYPE:
        for endianness in ENDIANNESS:
            responses_base64 = requests.post(
                server.url_for("/v1/embeddings"),
                json={
                    "model": model_name,
                    "input": input_texts,
                    "encoding_format": "base64",
                    "embed_dtype": embed_dtype,
                    "endianness": endianness,
                },
296
297
            )

298
299
300
301
302
303
304
305
306
307
308
309
310
            base64_data = []
            for data in responses_base64.json()["data"]:
                binary = base64.b64decode(data["embedding"])
                tensor = binary2tensor(binary, (-1,), embed_dtype, endianness)
                base64_data.append(tensor.to(torch.float32).tolist())

            check_embeddings_close(
                embeddings_0_lst=float_data,
                embeddings_1_lst=base64_data,
                name_0="float_data",
                name_1="base64_data",
                tol=1e-2,
            )
311
312
313
314


@pytest.mark.asyncio
@pytest.mark.parametrize("model_name", [MODEL_NAME])
315
316
async def test_bytes_embed_dtype_and_endianness(
    server: RemoteOpenAIServer, client: openai.AsyncOpenAI, model_name: str
317
318
319
320
321
):
    input_texts = [
        "The best thing about vLLM is that it supports many different models",
    ]

322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
    responses_float = await client.embeddings.create(
        input=input_texts, model=model_name, encoding_format="float"
    )
    float_data = [d.embedding for d in responses_float.data]

    for embed_dtype in list(EMBED_DTYPE_TO_TORCH_DTYPE.keys()):
        for endianness in ENDIANNESS:
            responses_bytes = requests.post(
                server.url_for("/v1/embeddings"),
                json={
                    "model": model_name,
                    "input": input_texts,
                    "encoding_format": "bytes",
                    "embed_dtype": embed_dtype,
                    "endianness": endianness,
                },
            )

            metadata = json.loads(responses_bytes.headers["metadata"])
            body = responses_bytes.content
            items = [MetadataItem(**x) for x in metadata["data"]]

            bytes_data = decode_pooling_output(items=items, body=body)
            bytes_data = [x.to(torch.float32).tolist() for x in bytes_data]

            check_embeddings_close(
                embeddings_0_lst=float_data,
                embeddings_1_lst=bytes_data,
                name_0="float_data",
                name_1="bytes_data",
                tol=1e-2,
            )


356
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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
@pytest.mark.asyncio
@pytest.mark.parametrize("model_name", [MODEL_NAME])
async def test_bytes_only_embed_dtype_and_endianness(
    server: RemoteOpenAIServer, client: openai.AsyncOpenAI, model_name: str
):
    input_texts = [
        "The best thing about vLLM is that it supports many different models",
    ] * 2

    responses_float = await client.embeddings.create(
        input=input_texts, model=model_name, encoding_format="float"
    )
    float_data = [d.embedding for d in responses_float.data]
    embedding_size = len(float_data[0])

    for embed_dtype in list(EMBED_DTYPE_TO_TORCH_DTYPE.keys()):
        for endianness in ENDIANNESS:
            responses_bytes = requests.post(
                server.url_for("/v1/embeddings"),
                json={
                    "model": model_name,
                    "input": input_texts,
                    "encoding_format": "bytes_only",
                    "embed_dtype": embed_dtype,
                    "endianness": endianness,
                },
            )

            assert "metadata" not in responses_bytes.headers
            body = responses_bytes.content
            items = build_metadata_items(
                embed_dtype=embed_dtype,
                endianness=endianness,
                shape=(embedding_size,),
                n_request=len(input_texts),
            )

            bytes_data = decode_pooling_output(items=items, body=body)
            bytes_data = [x.to(torch.float32).tolist() for x in bytes_data]

            check_embeddings_close(
                embeddings_0_lst=float_data,
                embeddings_1_lst=bytes_data,
                name_0="float_data",
                name_1="bytes_data",
                tol=1e-2,
            )


405
406
407
408
409
410
411
412
413
@pytest.mark.asyncio
@pytest.mark.parametrize("model_name", [MODEL_NAME])
@pytest.mark.parametrize("param_name", ["encoding_format", "embed_dtype", "endianness"])
async def test_params_not_supported(
    server: RemoteOpenAIServer, model_name: str, param_name: str
):
    input_texts = [
        "The best thing about vLLM is that it supports many different models",
    ]
414
415
416
417
418
419
420

    responses_base64 = requests.post(
        server.url_for("/v1/embeddings"),
        json={
            "model": model_name,
            "input": input_texts,
            "encoding_format": "base64",
421
            param_name: f"bad_{param_name}",
422
423
424
425
        },
    )

    assert responses_base64.status_code == 400
426
427
    assert "literal_error" in responses_base64.json()["error"]["message"]
    assert f"bad_{param_name}" in responses_base64.json()["error"]["message"]
428
429


430
@pytest.mark.asyncio
431
@pytest.mark.parametrize("model_name", [MODEL_NAME])
432
async def test_single_embedding_truncation(client: openai.AsyncOpenAI, model_name: str):
433
434
435
436
437
    input_texts = [
        "Como o Brasil pode fomentar o desenvolvimento de modelos de IA?",
    ]

    # test single embedding
438
    embedding_response = await client.embeddings.create(
439
440
        model=model_name, input=input_texts, extra_body={"truncate_prompt_tokens": 10}
    )
441
    embeddings = EmbeddingResponse.model_validate(
442
443
        embedding_response.model_dump(mode="json")
    )
444

445
446
    assert embeddings.id is not None
    assert len(embeddings.data) == 1
447
    assert len(embeddings.data[0].embedding) == 384
448
449
450
451
452
    assert embeddings.usage.completion_tokens == 0
    assert embeddings.usage.prompt_tokens == 10
    assert embeddings.usage.total_tokens == 10

    input_tokens = [
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
        1,
        24428,
        289,
        18341,
        26165,
        285,
        19323,
        283,
        289,
        26789,
        3871,
        28728,
        9901,
        340,
        2229,
        385,
        340,
        315,
        28741,
        28804,
        2,
474
    ]
475
    embedding_response = await client.embeddings.create(
476
477
        model=model_name, input=input_tokens, extra_body={"truncate_prompt_tokens": 10}
    )
478
    embeddings = EmbeddingResponse.model_validate(
479
480
        embedding_response.model_dump(mode="json")
    )
481
482
483

    assert embeddings.id is not None
    assert len(embeddings.data) == 1
484
    assert len(embeddings.data[0].embedding) == 384
485
486
487
488
489
490
    assert embeddings.usage.completion_tokens == 0
    assert embeddings.usage.prompt_tokens == 10
    assert embeddings.usage.total_tokens == 10


@pytest.mark.asyncio
491
@pytest.mark.parametrize("model_name", [MODEL_NAME])
492
493
494
async def test_single_embedding_truncation_invalid(
    client: openai.AsyncOpenAI, model_name: str
):
495
496
497
498
499
    input_texts = [
        "Como o Brasil pode fomentar o desenvolvimento de modelos de IA?",
    ]

    with pytest.raises(openai.BadRequestError):
500
        response = await client.embeddings.create(
501
502
            model=model_name,
            input=input_texts,
503
504
            extra_body={"truncate_prompt_tokens": 8193},
        )
505
        assert "error" in response.object
506
507
508
509
        assert (
            "truncate_prompt_tokens value is greater than max_model_len. "
            "Please, select a smaller truncation size." in response.message
        )
510
511
512


@pytest.mark.asyncio
513
async def test_invocations(server: RemoteOpenAIServer, client: openai.AsyncOpenAI):
514
515
516
517
518
519
520
521
522
523
524
525
    input_texts = [
        "The chef prepared a delicious meal.",
    ]

    request_args = {
        "model": MODEL_NAME,
        "input": input_texts,
        "encoding_format": "float",
    }

    completion_response = await client.embeddings.create(**request_args)

526
527
528
    invocation_response = requests.post(
        server.url_for("invocations"), json=request_args
    )
529
530
531
532
533
534
    invocation_response.raise_for_status()

    completion_output = completion_response.model_dump()
    invocation_output = invocation_response.json()

    assert completion_output.keys() == invocation_output.keys()
535
536
537
    for completion_data, invocation_data in zip(
        completion_output["data"], invocation_output["data"]
    ):
538
        assert completion_data.keys() == invocation_data.keys()
539
540
541
542
543
544
        check_embeddings_close(
            embeddings_0_lst=[completion_data["embedding"]],
            embeddings_1_lst=[invocation_data["embedding"]],
            name_0="completion",
            name_1="invocation",
        )
545
546
547
548


@pytest.mark.asyncio
async def test_invocations_conversation(server: RemoteOpenAIServer):
549
550
551
552
553
554
555
556
557
558
559
560
561
562
    messages = [
        {
            "role": "user",
            "content": "The cat sat on the mat.",
        },
        {
            "role": "assistant",
            "content": "A feline was resting on a rug.",
        },
        {
            "role": "user",
            "content": "Stars twinkle brightly in the night sky.",
        },
    ]
563
564
565
566
567
568
569

    request_args = {
        "model": MODEL_NAME,
        "messages": messages,
        "encoding_format": "float",
    }

570
    chat_response = requests.post(server.url_for("v1/embeddings"), json=request_args)
571
572
    chat_response.raise_for_status()

573
574
575
    invocation_response = requests.post(
        server.url_for("invocations"), json=request_args
    )
576
577
578
579
580
581
    invocation_response.raise_for_status()

    chat_output = chat_response.json()
    invocation_output = invocation_response.json()

    assert chat_output.keys() == invocation_output.keys()
582
583
584
    for chat_data, invocation_data in zip(
        chat_output["data"], invocation_output["data"]
    ):
585
        assert chat_data.keys() == invocation_data.keys()
586
587
588
589
590
591
        check_embeddings_close(
            embeddings_0_lst=[chat_data["embedding"]],
            embeddings_1_lst=[invocation_data["embedding"]],
            name_0="chat",
            name_1="invocation",
        )
592
593
594
595
596
597
598
599
600
601
602
603


@pytest.mark.asyncio
@pytest.mark.parametrize("model_name", [MODEL_NAME])
async def test_normalize(server: RemoteOpenAIServer, model_name: str):
    input_text = ["The chef prepared a delicious meal."]

    async def get_outputs(normalize):
        request_args = {
            "model": MODEL_NAME,
            "input": input_text,
            "encoding_format": "float",
604
            "normalize": normalize,
605
606
        }

607
        response = requests.post(server.url_for("v1/embeddings"), json=request_args)
608
609
        outputs = response.json()

610
        return torch.tensor([x["embedding"] for x in outputs["data"]])
611
612
613
614
615

    default = await get_outputs(normalize=None)
    w_normal = await get_outputs(normalize=True)
    wo_normal = await get_outputs(normalize=False)

616
617
618
619
620
621
622
    assert torch.allclose(default, w_normal, atol=1e-2), "Default should use normal."
    assert not torch.allclose(w_normal, wo_normal, atol=1e-2), (
        "wo_normal should not use normal."
    )
    assert torch.allclose(w_normal, F.normalize(wo_normal, p=2, dim=-1), atol=1e-2), (
        "w_normal should be close to normal(wo_normal)."
    )
623
624
625
626


@pytest.mark.asyncio
@pytest.mark.parametrize("model_name", [MODEL_NAME])
627
628
async def test_pooling_embed(server: RemoteOpenAIServer, model_name: str):
    task = "embed"
629
630
631
632
    input_text = ["The chef prepared a delicious meal."]

    response = requests.post(
        server.url_for("pooling"),
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
        json={
            "model": model_name,
            "input": input_text,
            "encoding_format": "float",
            "task": task,
        },
    )

    poolings = PoolingResponse.model_validate(response.json())

    assert len(poolings.data) == 1
    assert len(poolings.data[0].data) == 384


@pytest.mark.asyncio
@pytest.mark.parametrize("model_name", [MODEL_NAME])
async def test_pooling_token_embed(server: RemoteOpenAIServer, model_name: str):
    task = "token_embed"
    input_text = ["The chef prepared a delicious meal."]

    response = requests.post(
        server.url_for("pooling"),
        json={
            "model": model_name,
            "input": input_text,
            "encoding_format": "float",
            "task": task,
        },
661
662
663
664
665
666
667
    )

    poolings = PoolingResponse.model_validate(response.json())

    assert len(poolings.data) == 1
    assert len(poolings.data[0].data) == 11
    assert len(poolings.data[0].data[0]) == 384
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688


@pytest.mark.asyncio
@pytest.mark.parametrize("model_name", [MODEL_NAME])
@pytest.mark.parametrize("task", ["classify", "token_classify", "plugin"])
async def test_pooling_not_supported(
    server: RemoteOpenAIServer, model_name: str, task: str
):
    response = requests.post(
        server.url_for("pooling"),
        json={
            "model": model_name,
            "input": "test",
            "encoding_format": "float",
            "task": task,
        },
    )
    assert response.json()["error"]["type"] == "BadRequestError"
    assert response.json()["error"]["message"].startswith(
        f"Task {task} is not supported"
    )