test_embedding.py

"""Compare the embedding outputs of HF and vLLM models.

Run `pytest tests/models/embedding/language/test_embedding.py`.
"""
import os
import pytest

from vllm.config import PoolerConfig
from ....utils import models_path_prefix

from ..utils import check_embeddings_close
from vllm.platforms import current_platform


@pytest.mark.parametrize(
    "model",
    [
        # [Encoder-only]
        pytest.param(os.path.join(models_path_prefix, "BAAI/bge-base-en-v1.5"),
                     marks=[pytest.mark.core_model, pytest.mark.cpu_model]),
        pytest.param(os.path.join(models_path_prefix, "sentence-transformers/all-MiniLM-L12-v2")),
        pytest.param(os.path.join(models_path_prefix, "intfloat/multilingual-e5-large")),
        # [Decoder-only]
        pytest.param(os.path.join(models_path_prefix, "BAAI/bge-multilingual-gemma2"),
                     marks=[pytest.mark.core_model]),
        pytest.param(os.path.join(models_path_prefix, "intfloat/e5-mistral-7b-instruct"),
                     marks=[pytest.mark.core_model, pytest.mark.cpu_model]),
        pytest.param(os.path.join(models_path_prefix, "Alibaba-NLP/gte-Qwen2-1.5B-instruct")),
        pytest.param(os.path.join(models_path_prefix, "Alibaba-NLP/gte-Qwen2-7B-instruct")),
        pytest.param(os.path.join(models_path_prefix, "ssmits/Qwen2-7B-Instruct-embed-base")),
        # [Encoder-decoder]
        pytest.param(os.path.join(models_path_prefix, "sentence-transformers/stsb-roberta-base-v2")),
    ],
)


# @pytest.mark.skipif(current_platform.is_rocm(),
#                     reason="Consistent with NV.")
@pytest.mark.parametrize("dtype", ["half"])
def test_models(
    hf_runner,
    vllm_runner,
    example_prompts,
    model,
    dtype: str,
) -> None:
    vllm_extra_kwargs = {}
    if model == os.path.join(models_path_prefix, "ssmits/Qwen2-7B-Instruct-embed-base"):
        vllm_extra_kwargs["override_pooler_config"] = \
            PoolerConfig(pooling_type="MEAN")
    if model == os.path.join(models_path_prefix, "Alibaba-NLP/gte-Qwen2-7B-instruct"):
        vllm_extra_kwargs["hf_overrides"] = {"is_causal": False}

    # The example_prompts has ending "\n", for example:
    # "Write a short story about a robot that dreams for the first time.\n"
    # sentence_transformers will strip the input texts, see:
    # https://github.com/UKPLab/sentence-transformers/blob/v3.1.1/sentence_transformers/models/Transformer.py#L159
    # This makes the input_ids different between hf_model and vllm_model.
    # So we need to strip the input texts to avoid test failing.
    example_prompts = [str(s).strip() for s in example_prompts]

    with hf_runner(model, dtype=dtype,
                   is_sentence_transformer=True) as hf_model:
        hf_outputs = hf_model.encode(example_prompts)

    with vllm_runner(model,
                     task="embed",
                     dtype=dtype,
                     max_model_len=None,
                     **vllm_extra_kwargs) as vllm_model:
        vllm_outputs = vllm_model.encode(example_prompts)

        # This test is for verifying whether the model's extra_repr
        # can be printed correctly.
        def print_model(model):
            print(model)

        vllm_model.apply_model(print_model)

    check_embeddings_close(
        embeddings_0_lst=hf_outputs,
        embeddings_1_lst=vllm_outputs,
        name_0="hf",
        name_1="vllm",
        tol=1e-2,
    )