registry.py 52.2 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 Mapping, Set
5
from dataclasses import dataclass, field
6
from typing import Any, Literal, Optional
7

zhuwenwen's avatar
zhuwenwen committed
8
import os
9
import pytest
10
import torch
11
12
from packaging.version import Version
from transformers import __version__ as TRANSFORMERS_VERSION
zhuwenwen's avatar
zhuwenwen committed
13
# from ..utils import models_path_prefix
14

zhuwenwen's avatar
zhuwenwen committed
15
models_path_prefix = os.getenv('VLLM_OPTEST_MODELS_PATH') or os.getenv("OPTEST_MODELS_PATH")
16

17
from vllm.config import ModelDType, TokenizerMode
18

zhuwenwen's avatar
zhuwenwen committed
19

20
21
22
23
24
25
26
27
28
29
30
@dataclass(frozen=True)
class _HfExamplesInfo:
    default: str
    """The default model to use for testing this architecture."""

    extras: Mapping[str, str] = field(default_factory=dict)
    """Extra models to use for testing this architecture."""

    tokenizer: Optional[str] = None
    """Set the tokenizer to load for this architecture."""

31
    tokenizer_mode: TokenizerMode = "auto"
32
33
34
35
36
37
38
39
    """Set the tokenizer type for this architecture."""

    speculative_model: Optional[str] = None
    """
    The default model to use for testing this architecture, which is only used
    for speculative decoding.
    """

40
41
42
43
44
    min_transformers_version: Optional[str] = None
    """
    The minimum version of HF Transformers that is required to run this model.
    """

45
46
47
48
49
50
51
52
53
54
    max_transformers_version: Optional[str] = None
    """
    The maximum version of HF Transformers that this model runs on.
    """

    transformers_version_reason: Optional[str] = None
    """
    The reason for the minimum/maximum version requirement.
    """

55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
    skip_tokenizer_init: bool = False
    """
    If true, skip initialization of tokenizer and detokenizer. 
    """

    dtype: ModelDType = "auto"
    """
    The data type for the model weights and activations.
    """

    enforce_eager: bool = False
    """
    Whether to enforce eager execution. If True, we will
    disable CUDA graph and always execute the model in eager mode.
    If False, we will use CUDA graph and eager execution in hybrid.
    """

72
73
74
75
76
77
78
79
80
81
82
    is_available_online: bool = True
    """
    Set this to ``False`` if the name of this architecture no longer exists on
    the HF repo. To maintain backwards compatibility, we have not removed them
    from the main model registry, so without this flag the registry tests will
    fail.
    """

    trust_remote_code: bool = False
    """The ``trust_remote_code`` level required to load the model."""

83
84
85
    v0_only: bool = False
    """The model is only available with the vLLM V0 engine."""

86
87
88
    hf_overrides: dict[str, Any] = field(default_factory=dict)
    """The ``hf_overrides`` required to load the model."""

89
90
91
92
93
94
    max_model_len: Optional[int] = None
    """
    The maximum model length to use for this model. Some models default to a
    length that is too large to fit into memory in CI.
    """

95
96
97
98
99
100
    revision: Optional[str] = None
    """
    The specific revision (commit hash, tag, or branch) to use for the model.
    If not specified, the default revision will be used.
    """

101
102
103
    max_num_seqs: Optional[int] = None
    """Maximum number of sequences to be processed in a single iteration."""

104
105
106
107
108
109
    use_original_num_layers: bool = False
    """
    If True, use the original number of layers from the model config 
    instead of minimal layers for testing.
    """

110
111
112
    def check_transformers_version(
        self,
        *,
113
        on_fail: Literal["error", "skip", "return"],
114
115
        check_min_version: bool = True,
        check_max_version: bool = True,
116
    ) -> Optional[str]:
117
118
119
120
        """
        If the installed transformers version does not meet the requirements,
        perform the given action.
        """
121
122
        if (self.min_transformers_version is None
                and self.max_transformers_version is None):
123
            return None
124
125

        current_version = TRANSFORMERS_VERSION
126
        cur_base_version = Version(current_version).base_version
127
128
129
        min_version = self.min_transformers_version
        max_version = self.max_transformers_version
        msg = f"`transformers=={current_version}` installed, but `transformers"
130
131
        # Only check the base version for the min/max version, otherwise preview
        # models cannot be run because `x.yy.0.dev0`<`x.yy.0`
132
133
        if (check_min_version and min_version
                and Version(cur_base_version) < Version(min_version)):
134
            msg += f">={min_version}` is required to run this model."
135
136
        elif (check_max_version and max_version
              and Version(cur_base_version) > Version(max_version)):
137
138
            msg += f"<={max_version}` is required to run this model."
        else:
139
            return None
140

141
142
143
144
145
        if self.transformers_version_reason:
            msg += f" Reason: {self.transformers_version_reason}"

        if on_fail == "error":
            raise RuntimeError(msg)
146
        elif on_fail == "skip":
147
            pytest.skip(msg)
148

149
150
        return msg

151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
    def check_available_online(
        self,
        *,
        on_fail: Literal["error", "skip"],
    ) -> None:
        """
        If the model is not available online, perform the given action.
        """
        if not self.is_available_online:
            msg = "Model is not available online"

            if on_fail == "error":
                raise RuntimeError(msg)
            else:
                pytest.skip(msg)

167
168
169
170

# yapf: disable
_TEXT_GENERATION_EXAMPLE_MODELS = {
    # [Decoder-only]
171
    "ApertusForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "swiss-ai/Apertus-8B-2509"),
172
173
                                          min_transformers_version="4.56.0",
                                          trust_remote_code=True),
174
    "AquilaModel": _HfExamplesInfo(os.path.join(models_path_prefix,"BAAI/AquilaChat-7B"),
175
                                   trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
176
    "AquilaForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "BAAI/AquilaChat2-7B"),
177
                                         trust_remote_code=True),
178
    "ArceeForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "arcee-ai/AFM-4.5B-Base")),
zhuwenwen's avatar
zhuwenwen committed
179
    "ArcticForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "Snowflake/snowflake-arctic-instruct"),
180
                                         trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
181
    "BaiChuanForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "baichuan-inc/Baichuan-7B"),
182
                                         trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
183
    "BaichuanForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "baichuan-inc/Baichuan2-7B-chat"),
184
                                         trust_remote_code=True),
185
    "BailingMoeForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "inclusionAI/Ling-lite-1.5"),
186
                                         trust_remote_code=True),
187
    "BambaForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "ibm-ai-platform/Bamba-9B-v1"),
188
                                        min_transformers_version="4.55.3",
189
190
191
                                        extras={"tiny": os.path.join(models_path_prefix, "hmellor/tiny-random-BambaForCausalLM")}),  # noqa: E501
    "BloomForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "bigscience/bloom-560m"),
                                        {"1b": os.path.join(models_path_prefix, "bigscience/bloomz-1b1")}),
192
    "ChatGLMModel": _HfExamplesInfo(os.path.join(models_path_prefix, "zai-org/chatglm3-6b"),
193
                                    trust_remote_code=True,
194
                                    max_transformers_version="4.48"),
zhuwenwen's avatar
zhuwenwen committed
195
    "ChatGLMForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "thu-coai/ShieldLM-6B-chatglm3"),  # noqa: E501
196
                                                       trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
197
    "CohereForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "CohereForAI/c4ai-command-r-v01"),
198
                                         trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
199
    "Cohere2ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "CohereForAI/c4ai-command-r7b-12-2024"), # noqa: E501
200
                                         trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
201
202
    "DbrxForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "databricks/dbrx-instruct")),
    "DeciLMForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "nvidia/Llama-3_3-Nemotron-Super-49B-v1"), # noqa: E501
203
                                         trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
204
205
    "DeepseekForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "deepseek-ai/deepseek-llm-7b-chat")),
    "DeepseekV2ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "deepseek-ai/DeepSeek-V2-Lite-Chat"),  # noqa: E501
206
                                         trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
207
    "DeepseekV3ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "deepseek-ai/DeepSeek-V3"),  # noqa: E501
Robert Shaw's avatar
Robert Shaw committed
208
                                         trust_remote_code=True),
209
    "Ernie4_5ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "baidu/ERNIE-4.5-0.3B-PT"),
210
                                            min_transformers_version="4.54"),
211
    "Ernie4_5_MoeForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "baidu/ERNIE-4.5-21B-A3B-PT"),
212
                                               min_transformers_version="4.54"),
213
    "ExaoneForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "LGAI-EXAONE/EXAONE-3.0-7.8B-Instruct"),
214
                                         trust_remote_code=True),
215
    "Exaone4ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "LGAI-EXAONE/EXAONE-4.0-32B"),
216
                                          min_transformers_version="4.54"),
217
218
    "Fairseq2LlamaForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "mgleize/fairseq2-dummy-Llama-3.2-1B")),  # noqa: E501
    "FalconForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "tiiuae/falcon-7b")),
219
220
221
222
223
    "FalconH1ForCausalLM":_HfExamplesInfo(os.path.join(models_path_prefix, "tiiuae/Falcon-H1-0.5B-Base")),
    "GemmaForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "google/gemma-1.1-2b-it")),
    "Gemma2ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "google/gemma-2-9b")),
    "Gemma3ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "google/gemma-3-1b-it")),
    "Gemma3nForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "google/gemma-3n-E2B-it"),
Robert Shaw's avatar
Robert Shaw committed
224
                                          min_transformers_version="4.53"),
225
226
227
    "GlmForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "zai-org/glm-4-9b-chat-hf")),
    "Glm4ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "zai-org/GLM-4-9B-0414")),
    "Glm4MoeForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "zai-org/GLM-4.5"),
228
                                          min_transformers_version="4.54"),   # noqa: E501
229
230
231
232
    "GPT2LMHeadModel": _HfExamplesInfo(os.path.join(models_path_prefix, "openai-community/gpt2"),
                                       {"alias": os.path.join(models_path_prefix, "gpt2")}),
    "GPTBigCodeForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "bigcode/starcoder"),
                                             extras={"tiny": os.path.join(models_path_prefix, "bigcode/tiny_starcoder_py")},  # noqa: E501
233
234
                                             min_transformers_version="4.55.1",
                                             transformers_version_reason="HF model broken in 4.55.0"),  # noqa: E501
235
236
237
238
239
240
241
    "GPTJForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "Milos/slovak-gpt-j-405M"),
                                       {"6b": os.path.join(models_path_prefix, "EleutherAI/gpt-j-6b")}),
    "GPTNeoXForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "EleutherAI/pythia-70m"),
                                          {"1b": os.path.join(models_path_prefix, "EleutherAI/pythia-1.4b")}),
    "GptOssForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "lmsys/gpt-oss-20b-bf16")),
    "GraniteForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "ibm/PowerLM-3b")),
    "GraniteMoeForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "ibm/PowerMoE-3b")),
242
    "GraniteMoeHybridForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "ibm-granite/granite-4.0-tiny-preview"), # noqa: E501
243
                                                   min_transformers_version="4.55.3"),
244
    "GraniteMoeSharedForCausalLM": _HfExamplesInfo("ibm-research/moe-7b-1b-active-shared-experts"),  # noqa: E501
Michael Goin's avatar
Michael Goin committed
245
246
    "Grok1ModelForCausalLM": _HfExamplesInfo("hpcai-tech/grok-1",
                                             trust_remote_code=True),
247
    "HunYuanMoEV1ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "tencent/Hunyuan-A13B-Instruct"),
248
                                               trust_remote_code=True),
249
    # TODO: Remove is_available_online once their config.json is fixed
250
    "HunYuanDenseV1ForCausalLM":_HfExamplesInfo(os.path.join(models_path_prefix, "tencent/Hunyuan-7B-Instruct-0124"),
251
252
                                                trust_remote_code=True,
                                                is_available_online=False),
253
    "InternLMForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix,"internlm/internlm-chat-7b"),
254
                                           trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
255
    "InternLM2ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "internlm/internlm2-chat-7b"),
256
                                            trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
257
    "InternLM2VEForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "OpenGVLab/Mono-InternVL-2B"),
258
                                              trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
259
    "InternLM3ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "internlm/internlm3-8b-instruct"),
260
                                            trust_remote_code=True),
261
262
    "JAISLMHeadModel": _HfExamplesInfo(os.path.join(models_path_prefix, "inceptionai/jais-13b-chat")),
    "JambaForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "ai21labs/AI21-Jamba-1.5-Mini"),
263
                                        min_transformers_version="4.55.3",
264
                                        extras={
265
266
                                            "tiny": os.path.join(models_path_prefix, "ai21labs/Jamba-tiny-dev"),
                                            "random": os.path.join(models_path_prefix, "ai21labs/Jamba-tiny-random"),  # noqa: E501
267
                                        }),
268
    "Lfm2ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix,"LiquidAI/LFM2-1.2B"),
269
                                       min_transformers_version="4.54"),
270
    "LlamaForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix,"meta-llama/Llama-3.2-1B-Instruct"),
271
                                        extras={"guard": "meta-llama/Llama-Guard-3-1B",  # noqa: E501
272
273
                                                "hermes": "NousResearch/Hermes-3-Llama-3.1-8B", # noqa: E501
                                                "fp8": "RedHatAI/Meta-Llama-3.1-8B-Instruct-FP8"}),  # noqa: E501
274
    "LLaMAForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix,"decapoda-research/llama-7b-hf"),
275
                                        is_available_online=False),
276
    "Llama4ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "meta-llama/Llama-4-Scout-17B-16E-Instruct"), # noqa: E501
277
                                         is_available_online=False),
278
    "MambaForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "state-spaces/mamba-130m-hf")),
279
    "Mamba2ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "mistralai/Mamba-Codestral-7B-v0.1"),
280
281
                                         min_transformers_version="4.55.3",
                                         extras={
282
                                            "random": os.path.join(models_path_prefix, "yujiepan/mamba2-codestral-v0.1-tiny-random"), # noqa: E501
283
                                         }),
284
285
    "FalconMambaForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "tiiuae/falcon-mamba-7b-instruct")),  # noqa: E501
    "MiniCPMForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "openbmb/MiniCPM-2B-sft-bf16"),
286
                                         trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
287
    "MiniCPM3ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "openbmb/MiniCPM3-4B"),
288
                                         trust_remote_code=True),
289
    "MiniMaxForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "MiniMaxAI/MiniMax-Text-01-hf")),
zhuwenwen's avatar
zhuwenwen committed
290
    "MiniMaxText01ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "MiniMaxAI/MiniMax-Text-01"),
291
292
                                                trust_remote_code=True,
                                                revision="a59aa9cbc53b9fb8742ca4e9e1531b9802b6fdc3"),  # noqa: E501
293
    "MiniMaxM1ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "MiniMaxAI/MiniMax-M1-40k"),
294
                                            trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
295
296
    "MistralForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "mistralai/Mistral-7B-Instruct-v0.1")),
    "MixtralForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "mistralai/Mixtral-8x7B-Instruct-v0.1"),  # noqa: E501
zhuwenwen's avatar
zhuwenwen committed
297
                                          {"tiny": os.path.join(models_path_prefix, "TitanML/tiny-mixtral")}),  # noqa: E501
298
    "MotifForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "Motif-Technologies/Motif-2.6B"),
299
300
                                        trust_remote_code=True,
                                        v0_only=True),
zhuwenwen's avatar
zhuwenwen committed
301
302
303
    "MptForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "mpt"), is_available_online=False),
    "MPTForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "mosaicml/mpt-7b")),
    "NemotronForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "nvidia/Minitron-8B-Base")),
zhuwenwen's avatar
zhuwenwen committed
304
    "NemotronHForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "nvidia/Nemotron-H-8B-Base-8K"),
Luis Vega's avatar
Luis Vega committed
305
                                            trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
306
    "OlmoForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "allenai/OLMo-1B-hf")),
zhuwenwen's avatar
zhuwenwen committed
307
    "Olmo2ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "allenai/OLMo-2-0425-1B")),
zhuwenwen's avatar
zhuwenwen committed
308
309
310
311
    "OlmoeForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "allenai/OLMoE-1B-7B-0924-Instruct")),
    "OPTForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "facebook/opt-125m"),
                                      {"1b": os.path.join(models_path_prefix, "facebook/opt-iml-max-1.3b")}),
    "OrionForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "OrionStarAI/Orion-14B-Chat"),
312
                                        trust_remote_code=True),
313
314
315
316
    "PersimmonForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "adept/persimmon-8b-chat")),
    "PhiForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "microsoft/phi-2")),
    "Phi3ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "microsoft/Phi-3-mini-4k-instruct")),
    "Phi4FlashForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "microsoft/Phi-4-mini-flash-reasoning"), # noqa: E501
317
318
319
                                        trust_remote_code=True,
                                        v0_only=True,
                                        max_model_len=10240),
320
    "PhiMoEForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "microsoft/Phi-3.5-MoE-instruct"),
321
                                         trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
322
    "Plamo2ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "pfnet/plamo-2-1b"),
Shinichi Hemmi's avatar
Shinichi Hemmi committed
323
                                        trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
324
    "QWenLMHeadModel": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen-7B-Chat"),
325
326
                                       max_transformers_version="4.53",
                                       transformers_version_reason="HF model uses remote code that is not compatible with latest Transformers",  # noqa: E501
327
                                       trust_remote_code=True),
328
    "Qwen2ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen2-0.5B-Instruct"),
329
                                        extras={"2.5": "Qwen/Qwen2.5-0.5B-Instruct"}), # noqa: E501
330
331
332
333
    "Qwen2MoeForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen1.5-MoE-A2.7B-Chat")),
    "Qwen3ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen3-8B")),
    "Qwen3MoeForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen3-30B-A3B")),
    "Qwen3NextForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen3-Next-80B-A3B-Instruct"),
334
                                            min_transformers_version="4.56.2"),
335
336
    "RWForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "tiiuae/falcon-40b")),
    "SeedOssForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "ByteDance-Seed/Seed-OSS-36B-Instruct"), # noqa: E501
337
338
                                          trust_remote_code=True,
                                          is_available_online=False),
339
340
341
342
343
    "SmolLM3ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix,"HuggingFaceTB/SmolLM3-3B")),
    "StableLMEpochForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix,"stabilityai/stablelm-zephyr-3b")),  # noqa: E501
    "StableLmForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix,"stabilityai/stablelm-3b-4e1t")),
    "Starcoder2ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix,"bigcode/starcoder2-3b")),
    "Step3TextForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix,"stepfun-ai/step3"),
344
                                            trust_remote_code=True),
345
    "SolarForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix,"upstage/solar-pro-preview-instruct"),
346
                                        trust_remote_code=True),
347
    "TeleChat2ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "Tele-AI/TeleChat2-3B"),
348
                                            trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
349
    "TeleFLMForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "CofeAI/FLM-2-52B-Instruct-2407"),
350
                                            trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
351
    "XverseForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "xverse/XVERSE-7B-Chat"),
zhuwenwen's avatar
zhuwenwen committed
352
                                         tokenizer=os.path.join(models_path_prefix, "meta-llama/Llama-2-7b"),
353
                                         trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
354
    "Zamba2ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "Zyphra/Zamba2-7B-instruct")),
355
356
357
358
    "Ernie4_5_ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "baidu/ERNIE-4.5-0.3B-PT"),
                                        trust_remote_code=True),
    "Ernie4_5_MoeForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "baidu/ERNIE-4.5-21B-A3B-PT"),
                                        trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
359
    "MiMoForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "XiaomiMiMo/MiMo-7B-RL"),
360
                                        trust_remote_code=True),
361
    "Dots1ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix,"rednote-hilab/dots.llm1.inst")),
362
    # [Encoder-decoder]
363
364
365
    "BartModel": _HfExamplesInfo(os.path.join(models_path_prefix,"facebook/bart-base")),
    "BartForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix,"facebook/bart-large-cnn")),
    "MBartForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix,"facebook/mbart-large-en-ro"),  # noqa: E501
汪志鹏's avatar
汪志鹏 committed
366
                                                    hf_overrides={"architectures": ["MBartForConditionalGeneration"]}),  # noqa: E501
367
368
369
370
}

_EMBEDDING_EXAMPLE_MODELS = {
    # [Text-only]
371
372
    "BertModel": _HfExamplesInfo(os.path.join(models_path_prefix, "BAAI/bge-base-en-v1.5")),
    "Gemma2Model": _HfExamplesInfo(os.path.join(models_path_prefix, "BAAI/bge-multilingual-gemma2")),  # noqa: E501
373
    "Gemma3TextModel": _HfExamplesInfo(os.path.join(models_path_prefix, "google/embeddinggemma-300m")),
374
375
    "GritLM": _HfExamplesInfo(os.path.join(models_path_prefix, "parasail-ai/GritLM-7B-vllm")),
    "GteModel": _HfExamplesInfo(os.path.join(models_path_prefix, "Snowflake/snowflake-arctic-embed-m-v2.0"),
376
                                               trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
377
    "GteNewModel": _HfExamplesInfo(os.path.join(models_path_prefix, "Alibaba-NLP/gte-base-en-v1.5"),
378
                                   trust_remote_code=True,
379
                                   hf_overrides={"architectures": ["GteNewModel"]}),  # noqa: E501
zhuwenwen's avatar
zhuwenwen committed
380
    "InternLM2ForRewardModel": _HfExamplesInfo(os.path.join(models_path_prefix, "internlm/internlm2-1_8b-reward"),
381
                                               trust_remote_code=True),
382
383
384
385
    "JambaForSequenceClassification": _HfExamplesInfo(os.path.join(models_path_prefix, "ai21labs/Jamba-tiny-reward-dev")),  # noqa: E501
    "LlamaModel": _HfExamplesInfo(os.path.join(models_path_prefix, "llama"), is_available_online=False),
    "MistralModel": _HfExamplesInfo(os.path.join(models_path_prefix, "intfloat/e5-mistral-7b-instruct")),
    "ModernBertModel": _HfExamplesInfo(os.path.join(models_path_prefix, "Alibaba-NLP/gte-modernbert-base"),
386
                                trust_remote_code=True),
387
    "NomicBertModel": _HfExamplesInfo(os.path.join(models_path_prefix, "nomic-ai/nomic-embed-text-v2-moe"),
388
                                               trust_remote_code=True),  # noqa: E501
389
390
    "Qwen2Model": _HfExamplesInfo(os.path.join(models_path_prefix, "ssmits/Qwen2-7B-Instruct-embed-base")),
    "Qwen2ForRewardModel": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen2.5-Math-RM-72B"),
391
392
                                           max_transformers_version="4.53",
                                           transformers_version_reason="HF model uses remote code that is not compatible with latest Transformers"),  # noqa: E501
393
    "Qwen2ForProcessRewardModel": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen2.5-Math-PRM-7B"),
394
395
                                                  max_transformers_version="4.53",
                                                  transformers_version_reason="HF model uses remote code that is not compatible with latest Transformers"),  # noqa: E501
396
397
398
    "RobertaModel": _HfExamplesInfo(os.path.join(models_path_prefix, "sentence-transformers/stsb-roberta-base-v2")),  # noqa: E501
    "RobertaForMaskedLM": _HfExamplesInfo(os.path.join(models_path_prefix, "sentence-transformers/all-roberta-large-v1")),  # noqa: E501
    "XLMRobertaModel": _HfExamplesInfo(os.path.join(models_path_prefix, "intfloat/multilingual-e5-small")),  # noqa: E501
399
    # [Multimodal]
zhuwenwen's avatar
zhuwenwen committed
400
401
    "LlavaNextForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "royokong/e5-v")),
    "Phi3VForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "TIGER-Lab/VLM2Vec-Full"),
402
                                         trust_remote_code=True),
403
    "Qwen2VLForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "MrLight/dse-qwen2-2b-mrl-v1"), # noqa: E501
zhuwenwen's avatar
zhuwenwen committed
404
    "PrithviGeoSpatialMAE": _HfExamplesInfo(os.path.join(models_path_prefix, "ibm-nasa-geospatial/Prithvi-EO-2.0-300M-TL-Sen1Floods11"), # noqa: E501
405
406
407
408
409
410
411
                                            dtype=torch.float16,
                                            enforce_eager=True,
                                            skip_tokenizer_init=True,
                                            # This is to avoid the model
                                            # going OOM in CI
                                            max_num_seqs=32,
                                            ),
412
    "Terratorch": _HfExamplesInfo(os.path.join(models_path_prefix, "ibm-nasa-geospatial/Prithvi-EO-2.0-300M-TL-Sen1Floods11"), # noqa: E501
413
414
415
416
417
418
                                  dtype=torch.float16,
                                  enforce_eager=True,
                                  skip_tokenizer_init=True,
                                  # This is to avoid the model going OOM in CI
                                  max_num_seqs=32,
                                  ),
419
420
}

421
422
_SEQUENCE_CLASSIFICATION_EXAMPLE_MODELS = {
    # [Decoder-only]
423
    "GPT2ForSequenceClassification": _HfExamplesInfo(os.path.join(models_path_prefix, "nie3e/sentiment-polish-gpt2-small")),  # noqa: E501
424
425

    # [Cross-encoder]
426
427
    "BertForSequenceClassification": _HfExamplesInfo(os.path.join(models_path_prefix, "cross-encoder/ms-marco-MiniLM-L-6-v2")),  # noqa: E501
    "GteNewForSequenceClassification": _HfExamplesInfo(os.path.join(models_path_prefix, "Alibaba-NLP/gte-multilingual-reranker-base"),  # noqa: E501
428
429
                                                       trust_remote_code=True,
                                                       hf_overrides={
430
431
432
433
                                                           "architectures": [os.path.join(models_path_prefix, "GteNewForSequenceClassification")]}),# noqa: E501
    "ModernBertForSequenceClassification": _HfExamplesInfo(os.path.join(models_path_prefix, "Alibaba-NLP/gte-reranker-modernbert-base")), # noqa: E501
    "RobertaForSequenceClassification": _HfExamplesInfo(os.path.join(models_path_prefix, "cross-encoder/quora-roberta-base")),  # noqa: E501
    "XLMRobertaForSequenceClassification": _HfExamplesInfo(os.path.join(models_path_prefix, "BAAI/bge-reranker-v2-m3")),  # noqa: E501
434
435
}

436
437
_AUTOMATIC_CONVERTED_MODELS = {
    # Use as_seq_cls_model for automatic conversion
438
    "GemmaForSequenceClassification": _HfExamplesInfo(os.path.join(models_path_prefix, "BAAI/bge-reranker-v2-gemma"),  # noqa: E501
439
440
441
                                                      hf_overrides={"architectures": ["GemmaForSequenceClassification"], # noqa: E501
                                                                    "classifier_from_token": ["Yes"],  # noqa: E501
                                                                    "method": "no_post_processing"}),  # noqa: E501
442
443
444
    "LlamaForSequenceClassification": _HfExamplesInfo(os.path.join(models_path_prefix, "Skywork/Skywork-Reward-V2-Llama-3.2-1B")),  # noqa: E501
    "Qwen2ForSequenceClassification": _HfExamplesInfo(os.path.join(models_path_prefix, "jason9693/Qwen2.5-1.5B-apeach")),  # noqa: E501
    "Qwen3ForSequenceClassification": _HfExamplesInfo(os.path.join(models_path_prefix, "tomaarsen/Qwen3-Reranker-0.6B-seq-cls")),  # noqa: E501
445
446
}

447
448
_MULTIMODAL_EXAMPLE_MODELS = {
    # [Decoder-only]
449
450
451
452
453
454
455
456
    "AriaForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "rhymes-ai/Aria")),
    "AyaVisionForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "CohereForAI/aya-vision-8b")), # noqa: E501
    "Blip2ForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "Salesforce/blip2-opt-2.7b"),  # noqa: E501
                                                     extras={"6b": os.path.join(models_path_prefix, "Salesforce/blip2-opt-6.7b")}),  # noqa: E501
    "ChameleonForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "facebook/chameleon-7b")),  # noqa: E501
    "Cohere2VisionForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "CohereLabs/command-a-vision-07-2025")), # noqa: E501
    "DeepseekVLV2ForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "deepseek-ai/deepseek-vl2-tiny"),  # noqa: E501
                                                extras={"fork": os.path.join(models_path_prefix, "Isotr0py/deepseek-vl2-tiny")},  # noqa: E501
457
458
                                                max_transformers_version="4.48",  # noqa: E501
                                                transformers_version_reason="HF model is not compatible.",  # noqa: E501
459
                                                hf_overrides={"architectures": ["DeepseekVLV2ForCausalLM"]}),  # noqa: E501
460
    "Emu3ForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "BAAI/Emu3-Chat-hf")),
461
    "Ernie4_5_VLMoeForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "baidu/ERNIE-4.5-VL-28B-A3B-PT"),  # noqa: E501
462
                                                              trust_remote_code=True),
463
464
465
    "FuyuForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "adept/fuyu-8b")),
    "Gemma3ForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "google/gemma-3-4b-it")),
    "Gemma3nForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "google/gemma-3n-E2B-it"),    # noqa: E501
Nicolò Lucchesi's avatar
Nicolò Lucchesi committed
466
                                        min_transformers_version="4.53"),
467
468
    "GraniteSpeechForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "ibm-granite/granite-speech-3.3-2b")),  # noqa: E501
    "GLM4VForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "zai-org/glm-4v-9b"),
469
470
                                        trust_remote_code=True,
                                        hf_overrides={"architectures": ["GLM4VForCausalLM"]}),  # noqa: E501
471
472
    "Glm4vForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "zai-org/GLM-4.1V-9B-Thinking")),  # noqa: E501
    "Glm4vMoeForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "zai-org/GLM-4.5V"),
473
                                                        min_transformers_version="4.56"),  # noqa: E501
474
    "H2OVLChatModel": _HfExamplesInfo(os.path.join(models_path_prefix, "h2oai/h2ovl-mississippi-800m"),
475
                                      trust_remote_code=True,
476
                                      extras={"2b": os.path.join(models_path_prefix, "h2oai/h2ovl-mississippi-2b")},  # noqa: E501
477
478
                                      max_transformers_version="4.48",  # noqa: E501
                                      transformers_version_reason="HF model is not compatible."),  # noqa: E501
479
    "HCXVisionForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix,"naver-hyperclovax/HyperCLOVAX-SEED-Vision-Instruct-3B"),  # noqa: E501
480
                                            trust_remote_code=True),
481
482
    "Idefics3ForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix,"HuggingFaceM4/Idefics3-8B-Llama3"),  # noqa: E501
                                                        {"tiny": os.path.join(models_path_prefix,"HuggingFaceTB/SmolVLM-256M-Instruct")},    # noqa: E501
483
484
                                                        min_transformers_version="4.56",
                                                        transformers_version_reason="HF model broken in 4.55"),  # noqa: E501
485
    "InternS1ForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix,"internlm/Intern-S1"),
486
                                                        trust_remote_code=True),  # noqa: E501
487
488
489
490
491
492
    "InternVLChatModel": _HfExamplesInfo(os.path.join(models_path_prefix,"OpenGVLab/InternVL2-1B"),
                                         extras={"2B": os.path.join(models_path_prefix,"OpenGVLab/InternVL2-2B"),
                                                 "3.0": os.path.join(models_path_prefix,"OpenGVLab/InternVL3-1B"),   # noqa: E501
                                                 "3.5-qwen3": os.path.join(models_path_prefix,"OpenGVLab/InternVL3_5-1B"),   # noqa: E501
                                                 "3.5-qwen3moe": os.path.join(models_path_prefix,"OpenGVLab/InternVL3_5-30B-A3B"),   # noqa: E501
                                                 "3.5-gptoss": os.path.join(models_path_prefix,"OpenGVLab/InternVL3_5-GPT-OSS-20B-A4B-Preview")},  # noqa: E501
Lyu Han's avatar
Lyu Han committed
493
                                         trust_remote_code=True),
494
495
    "InternVLForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix,"OpenGVLab/InternVL3-1B-hf")),    # noqa: E501
    "KeyeForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix,"Kwai-Keye/Keye-VL-8B-Preview"), # noqa: E501
496
                                                    trust_remote_code=True),
497
    "KeyeVL1_5ForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "Kwai-Keye/Keye-VL-1_5-8B"), # noqa: E501
498
                                                         trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
499
    "KimiVLForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "moonshotai/Kimi-VL-A3B-Instruct"),  # noqa: E501
500
                                                      extras={"thinking": "moonshotai/Kimi-VL-A3B-Thinking"},  # noqa: E501
501
                                                      trust_remote_code=True),
502
    "Llama4ForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "meta-llama/Llama-4-Scout-17B-16E-Instruct"),   # noqa: E501
503
                                                      max_model_len=10240,
504
                                                      extras={"llama-guard-4": os.path.join(models_path_prefix, "meta-llama/Llama-Guard-4-12B")}, # noqa: E501
505
                                                      ),
zhuwenwen's avatar
zhuwenwen committed
506
507
508
509
510
511
512
    "LlavaForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "llava-hf/llava-1.5-7b-hf"),
                                                     extras={"mistral": os.path.join(models_path_prefix, "mistral-community/pixtral-12b"), # noqa: E501
                                                             "mistral-fp8": os.path.join(models_path_prefix, "nm-testing/pixtral-12b-FP8-dynamic")}),  # noqa: E501
    "LlavaNextForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "llava-hf/llava-v1.6-mistral-7b-hf")),  # noqa: E501
    "LlavaNextVideoForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "llava-hf/LLaVA-NeXT-Video-7B-hf")),  # noqa: E501
    "LlavaOnevisionForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "llava-hf/llava-onevision-qwen2-0.5b-ov-hf")),  # noqa: E501
    "MantisForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "TIGER-Lab/Mantis-8B-siglip-llama3"),  # noqa: E501
513
514
                                                      max_transformers_version="4.48",  # noqa: E501
                                                      transformers_version_reason="HF model is not compatible.",  # noqa: E501
515
                                                      hf_overrides={"architectures": ["MantisForConditionalGeneration"]}),  # noqa: E501
516
    "MiDashengLMModel": _HfExamplesInfo(os.path.join(models_path_prefix, "mispeech/midashenglm-7b"),
517
                            trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
518
    "MiniCPMO": _HfExamplesInfo(os.path.join(models_path_prefix, "openbmb/MiniCPM-o-2_6"),
519
                                trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
520
    "MiniCPMV": _HfExamplesInfo(os.path.join(models_path_prefix, "openbmb/MiniCPM-Llama3-V-2_5"),
tc-mb's avatar
tc-mb committed
521
                                extras={"2.6": "openbmb/MiniCPM-V-2_6", "4.0": "openbmb/MiniCPM-V-4", "4.5": "openbmb/MiniCPM-V-4_5"},  # noqa: E501
522
                                trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
523
    "MiniMaxVL01ForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "MiniMaxAI/MiniMax-VL-01"), # noqa: E501
524
525
                                              trust_remote_code=True,
                                              v0_only=True),
zhuwenwen's avatar
zhuwenwen committed
526
527
528
    "Mistral3ForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "mistralai/Mistral-Small-3.1-24B-Instruct-2503"),  # noqa: E501
                                                        extras={"fp8": os.path.join(models_path_prefix, "nm-testing/Mistral-Small-3.1-24B-Instruct-2503-FP8-dynamic")}),  # noqa: E501
    "MolmoForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "allenai/Molmo-7B-D-0924"),
529
                                        max_transformers_version="4.48",
530
                                        transformers_version_reason="Incorrectly-detected `tensorflow` import.",  # noqa: E501
zhuwenwen's avatar
zhuwenwen committed
531
                                        extras={"olmo": os.path.join(models_path_prefix, "allenai/Molmo-7B-O-0924")},  # noqa: E501
532
                                        trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
533
    "NVLM_D": _HfExamplesInfo(os.path.join(models_path_prefix, "nvidia/NVLM-D-72B"),
534
                              trust_remote_code=True),
535
536

    "Llama_Nemotron_Nano_VL" : _HfExamplesInfo(os.path.join(models_path_prefix, "nvidia/Llama-3.1-Nemotron-Nano-VL-8B-V1"), # noqa: E501
537
                                                     trust_remote_code=True),
538
    "NemotronH_Nano_VL": _HfExamplesInfo(os.path.join(models_path_prefix, "nano_vl_dummy"),
539
540
                                          is_available_online=False,
                                          trust_remote_code=True),
541
    "Ovis": _HfExamplesInfo(os.path.join(models_path_prefix, "AIDC-AI/Ovis2-1B"), trust_remote_code=True,
542
543
                            max_transformers_version="4.53",
                            transformers_version_reason="HF model is not compatible",  # noqa: E501
544
545
                            extras={"1.6-llama": os.path.join(models_path_prefix, "AIDC-AI/Ovis1.6-Llama3.2-3B"),
                                    "1.6-gemma": os.path.join(models_path_prefix, "AIDC-AI/Ovis1.6-Gemma2-9B")}),  # noqa: E501
546
    "Ovis2_5": _HfExamplesInfo(os.path.join(models_path_prefix, "AIDC-AI/Ovis2.5-2B"),
547
                               trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
548
549
    "PaliGemmaForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "google/paligemma-3b-mix-224"),  # noqa: E501
                                                         extras={"v2": os.path.join(models_path_prefix, "google/paligemma2-3b-ft-docci-448")}),  # noqa: E501
550
    "Phi3VForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "microsoft/Phi-3-vision-128k-instruct"),
551
                                        trust_remote_code=True,
552
553
                                        max_transformers_version="4.48",
                                        transformers_version_reason="Use of deprecated imports which have been removed.",  # noqa: E501
554
555
                                        extras={"phi3.5": os.path.join(models_path_prefix, "microsoft/Phi-3.5-vision-instruct")}),  # noqa: E501
    "Phi4MMForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "microsoft/Phi-4-multimodal-instruct"),
556
                                        trust_remote_code=True),
557
    "Phi4MultimodalForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "microsoft/Phi-4-multimodal-instruct"),  # noqa: E501
558
                                                 revision="refs/pr/70"),
zhuwenwen's avatar
zhuwenwen committed
559
    "PixtralForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "mistralai/Pixtral-12B-2409"),  # noqa: E501
560
                                                       tokenizer_mode="mistral"),
zhuwenwen's avatar
zhuwenwen committed
561
562
    "QwenVLForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen-VL"),
                                                      extras={"chat": os.path.join(models_path_prefix, "Qwen/Qwen-VL-Chat")},  # noqa: E501
563
564
                                                      trust_remote_code=True,
                                                      hf_overrides={"architectures": ["QwenVLForConditionalGeneration"]}),  # noqa: E501
zhuwenwen's avatar
zhuwenwen committed
565
566
    "Qwen2AudioForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen2-Audio-7B-Instruct")),  # noqa: E501
    "Qwen2VLForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen2-VL-2B-Instruct")),  # noqa: E501
567
    "Qwen2_5_VLForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen2.5-VL-3B-Instruct"), # noqa: E501
568
                                                          max_model_len=4096),
zhuwenwen's avatar
zhuwenwen committed
569
570
    "Qwen2_5OmniModel": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen2.5-Omni-3B")),
    "Qwen2_5OmniForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen2.5-Omni-7B-AWQ")),  # noqa: E501
571
    "RForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "YannQi/R-4B"),
572
                                                 trust_remote_code=True),
573
    "SkyworkR1VChatModel": _HfExamplesInfo(os.path.join(models_path_prefix, "Skywork/Skywork-R1V-38B"),
574
                                           trust_remote_code=True),
575
    "SmolVLMForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "HuggingFaceTB/SmolVLM2-2.2B-Instruct"),  # noqa: E501
576
577
                                                       min_transformers_version="4.56",
                                                       transformers_version_reason="HF model broken in 4.55"),  # noqa: E501
zhuwenwen's avatar
zhuwenwen committed
578
    "Step3VLForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "stepfun-ai/step3"),
579
                                                        trust_remote_code=True),
zhuwenwen's avatar
zhuwenwen committed
580
    "UltravoxModel": _HfExamplesInfo(os.path.join(models_path_prefix, "fixie-ai/ultravox-v0_5-llama-3_2-1b"),  # noqa: E501
581
                                     trust_remote_code=True),
582
583
    "TarsierForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "omni-research/Tarsier-7b")),  # noqa: E501
    "Tarsier2ForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "omni-research/Tarsier2-Recap-7b"),  # noqa: E501
584
                                                        hf_overrides={"architectures": ["Tarsier2ForConditionalGeneration"]}),  # noqa: E501
585
    "VoxtralForConditionalGeneration": _HfExamplesInfo(
586
        os.path.join(models_path_prefix, "mistralai/Voxtral-Mini-3B-2507"),
587
588
589
590
        min_transformers_version="4.54",
        # disable this temporarily until we support HF format
        is_available_online=False,
    ),
591
    # [Encoder-decoder]
592
    "DonutForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "naver-clova-ix/donut-base-finetuned-docvqa"),  # noqa: E501
汪志鹏's avatar
汪志鹏 committed
593
                                                    hf_overrides={"architectures": ["DonutForConditionalGeneration"], "model_type": "donut"},  # noqa: E501
594
                                                    extras={"dolphin": os.path.join(models_path_prefix, "ByteDance/Dolphin")}),  # noqa: E501
595
596
    # Florence-2 uses BartFastTokenizer which can't be loaded from AutoTokenizer
    # Therefore, we borrow the BartTokenizer from the original Bart model
zhuwenwen's avatar
zhuwenwen committed
597
598
    "Florence2ForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix,"microsoft/Florence-2-base"),  # noqa: E501
                                                         tokenizer=os.path.join(models_path_prefix,"Isotr0py/Florence-2-tokenizer"),  # noqa: E501
599
                                                         trust_remote_code=True),  # noqa: E501
zhuwenwen's avatar
zhuwenwen committed
600
601
    "MllamaForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "meta-llama/Llama-3.2-11B-Vision-Instruct")),  # noqa: E501
    "WhisperForConditionalGeneration": _HfExamplesInfo(os.path.join(models_path_prefix, "openai/whisper-large-v3")),  # noqa: E501
602
    # [Cross-encoder]
603
    "JinaVLForRanking": _HfExamplesInfo(os.path.join(models_path_prefix, "jinaai/jina-reranker-m0")),   # noqa: E501
604
605
}

606

607
_SPECULATIVE_DECODING_EXAMPLE_MODELS = {
zhuwenwen's avatar
zhuwenwen committed
608
609
    "MedusaModel": _HfExamplesInfo(os.path.join(models_path_prefix, "JackFram/llama-68m"),
                                   speculative_model=os.path.join(models_path_prefix, "abhigoyal/vllm-medusa-llama-68m-random")),  # noqa: E501
610
611
612
613
    # Temporarily disabled.
    # TODO(woosuk): Re-enable this once the MLP Speculator is supported in V1.
    # "MLPSpeculatorPreTrainedModel": _HfExamplesInfo("JackFram/llama-160m",
    #                                                 speculative_model="ibm-ai-platform/llama-160m-accelerator"),  # noqa: E501
zhuwenwen's avatar
zhuwenwen committed
614
615
    "DeepSeekMTPModel": _HfExamplesInfo(os.path.join(models_path_prefix, "luccafong/deepseek_mtp_main_random"),
                                        speculative_model=os.path.join(models_path_prefix, "luccafong/deepseek_mtp_draft_random"),  # noqa: E501
616
                                        trust_remote_code=True),
617
    "EagleDeepSeekMTPModel": _HfExamplesInfo(os.path.join(models_path_prefix, "eagle618/deepseek-v3-random"),
618
619
                                        speculative_model="eagle618/eagle-deepseek-v3-random",  # noqa: E501
                                        trust_remote_code=True),
620
    "EagleLlamaForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "meta-llama/Meta-Llama-3-8B-Instruct"), # noqa: E501
621
622
                                             trust_remote_code=True,
                                             speculative_model="yuhuili/EAGLE-LLaMA3-Instruct-8B",
623
                                             tokenizer="meta-llama/Meta-Llama-3-8B-Instruct"), # noqa: E501
624
    "Eagle3LlamaForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "meta-llama/Llama-3.1-8B-Instruct"),  # noqa: E501
625
                                            trust_remote_code=True,
626
627
628
629
                                            speculative_model="yuhuili/EAGLE3-LLaMA3.1-Instruct-8B", # noqa: E501
                                            tokenizer="meta-llama/Llama-3.1-8B-Instruct",
                                            use_original_num_layers=True,
                                            max_model_len=10240),
630
    "LlamaForCausalLMEagle3": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen3-8B"),  # noqa: E501
631
                                            trust_remote_code=True,
632
                                            speculative_model="AngelSlim/Qwen3-8B_eagle3",   # noqa: E501
633
634
                                            tokenizer="Qwen/Qwen3-8B",
                                            use_original_num_layers=True),
zhiweiz's avatar
zhiweiz committed
635
    "EagleLlama4ForCausalLM": _HfExamplesInfo(
636
        os.path.join(models_path_prefix, "morgendave/EAGLE-Llama-4-Scout-17B-16E-Instruct"),
zhiweiz's avatar
zhiweiz committed
637
        trust_remote_code=True,
638
639
640
        speculative_model=os.path.join(models_path_prefix, "morgendave/EAGLE-Llama-4-Scout-17B-16E-Instruct"),
        tokenizer=os.path.join(models_path_prefix, "meta-llama/Llama-4-Scout-17B-16E-Instruct")),  # noqa: E501
    "EagleMiniCPMForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "openbmb/MiniCPM-1B-sft-bf16"),
641
642
                                            trust_remote_code=True,
                                            is_available_online=False,
643
644
                                            speculative_model=os.path.join(models_path_prefix, "openbmb/MiniCPM-2B-sft-bf16"),
                                            tokenizer=os.path.join(models_path_prefix, "openbmb/MiniCPM-2B-sft-bf16")),
645
    "ErnieMTPModel": _HfExamplesInfo(os.path.join(models_path_prefix, "baidu/ERNIE-4.5-21B-A3B-PT"),
646
                                    trust_remote_code=True,
647
                                    speculative_model=os.path.join(models_path_prefix, "baidu/ERNIE-4.5-21B-A3B-PT")),
648
649
    "Glm4MoeMTPModel": _HfExamplesInfo(os.path.join(models_path_prefix, "zai-org/GLM-4.5"),
                                        speculative_model=os.path.join(models_path_prefix, "zai-org/GLM-4.5"),
zhuwenwen's avatar
zhuwenwen committed
650
651
                                        min_transformers_version="4.54",
                                        is_available_online=False),
652
    "MiMoMTPModel": _HfExamplesInfo(os.path.join(models_path_prefix, "XiaomiMiMo/MiMo-7B-RL"),
653
                                    trust_remote_code=True,
654
655
                                    speculative_model=os.path.join(models_path_prefix, "XiaomiMiMo/MiMo-7B-RL")),
    "Qwen3NextMTP": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen3-Next-80B-A3B-Instruct"),
656
                                     min_transformers_version="4.56.2"),
657
658
}

659
_TRANSFORMERS_BACKEND_MODELS = {
660
    "TransformersModel": _HfExamplesInfo(os.path.join(models_path_prefix, "Qwen/Qwen3-Embedding-0.6B")),
661
    "TransformersForCausalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "hmellor/Ilama-3.2-1B"), trust_remote_code=True),  # noqa: E501
662
    "TransformersForMultimodalLM": _HfExamplesInfo(os.path.join(models_path_prefix, "BAAI/Emu3-Chat-hf")),
663
664
}

665
666
667
_EXAMPLE_MODELS = {
    **_TEXT_GENERATION_EXAMPLE_MODELS,
    **_EMBEDDING_EXAMPLE_MODELS,
668
    **_SEQUENCE_CLASSIFICATION_EXAMPLE_MODELS,
669
670
    **_MULTIMODAL_EXAMPLE_MODELS,
    **_SPECULATIVE_DECODING_EXAMPLE_MODELS,
671
    **_TRANSFORMERS_BACKEND_MODELS,
672
673
674
675
676
677
678
679
680
}


class HfExampleModels:
    def __init__(self, hf_models: Mapping[str, _HfExamplesInfo]) -> None:
        super().__init__()

        self.hf_models = hf_models

681
    def get_supported_archs(self) -> Set[str]:
682
683
684
685
686
        return self.hf_models.keys()

    def get_hf_info(self, model_arch: str) -> _HfExamplesInfo:
        return self.hf_models[model_arch]

687
688
689
690
691
    def find_hf_info(self, model_id: str) -> _HfExamplesInfo:
        for info in self.hf_models.values():
            if info.default == model_id:
                return info

692
693
694
695
696
        # Fallback to extras
        for info in self.hf_models.values():
            if any(extra == model_id for extra in info.extras.values()):
                return info

697
698
        raise ValueError(f"No example model defined for {model_id}")

699

Patrick von Platen's avatar
Patrick von Platen committed
700
HF_EXAMPLE_MODELS = HfExampleModels(_EXAMPLE_MODELS)
701
AUTO_EXAMPLE_MODELS = HfExampleModels(_AUTOMATIC_CONVERTED_MODELS)