registry.py 47.5 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3
4
5
6
"""
Whenever you add an architecture to this page, please also update
`tests/models/registry.py` with example HuggingFace models for it.
"""
7

8
import importlib
9
import json
10
import os
11
import pickle
12
13
import subprocess
import sys
14
import tempfile
15
from abc import ABC, abstractmethod
16
from collections.abc import Callable, Set
17
from dataclasses import asdict, dataclass, field
18
from functools import lru_cache
19
from pathlib import Path
20
from typing import TYPE_CHECKING, Any, TypeVar
21
22

import torch.nn as nn
23
import transformers
24

25
from vllm import envs
26
27
28
29
30
from vllm.config import (
    ModelConfig,
    iter_architecture_defaults,
    try_match_architecture_defaults,
)
31
from vllm.logger import init_logger
32
from vllm.logging_utils import logtime
33
from vllm.transformers_utils.dynamic_module import try_get_class_from_dynamic_module
34
from vllm.utils.hashing import safe_hash
35

36
37
if TYPE_CHECKING:
    from vllm.config.model import AttnTypeStr
38
    from vllm.config.pooler import SequencePoolingType, TokenPoolingType
39
40
else:
    AttnTypeStr = Any
41
42
    SequencePoolingType = Any
    TokenPoolingType = Any
43
44


45
46
47
48
49
from .interfaces import (
    has_inner_state,
    has_noops,
    is_attention_free,
    is_hybrid,
Patrick von Platen's avatar
Patrick von Platen committed
50
    requires_raw_input_tokens,
51
    supports_cross_encoding,
52
    supports_mamba_prefix_caching,
53
54
55
56
57
58
59
    supports_multimodal,
    supports_multimodal_encoder_tp_data,
    supports_multimodal_raw_input_only,
    supports_pp,
    supports_transcription,
)
from .interfaces_base import (
60
    get_attn_type,
61
62
    get_default_seq_pooling_type,
    get_default_tok_pooling_type,
63
64
65
    is_pooling_model,
    is_text_generation_model,
)
66
67
68

logger = init_logger(__name__)

69
70
_TEXT_GENERATION_MODELS = {
    # [Decoder-only]
71
    "AfmoeForCausalLM": ("afmoe", "AfmoeForCausalLM"),
72
    "ApertusForCausalLM": ("apertus", "ApertusForCausalLM"),
73
74
    "AquilaModel": ("llama", "LlamaForCausalLM"),
    "AquilaForCausalLM": ("llama", "LlamaForCausalLM"),  # AquilaChat2
Raghav Ravishankar's avatar
Raghav Ravishankar committed
75
    "ArceeForCausalLM": ("arcee", "ArceeForCausalLM"),
76
    "ArcticForCausalLM": ("arctic", "ArcticForCausalLM"),
77
78
79
80
    # baichuan-7b, upper case 'C' in the class name
    "BaiChuanForCausalLM": ("baichuan", "BaiChuanForCausalLM"),
    # baichuan-13b, lower case 'c' in the class name
    "BaichuanForCausalLM": ("baichuan", "BaichuanForCausalLM"),
81
    "BailingMoeForCausalLM": ("bailing_moe", "BailingMoeForCausalLM"),
ant-yy's avatar
ant-yy committed
82
    "BailingMoeV2ForCausalLM": ("bailing_moe", "BailingMoeV2ForCausalLM"),
Yu Chin Fabian Lim's avatar
Yu Chin Fabian Lim committed
83
    "BambaForCausalLM": ("bamba", "BambaForCausalLM"),
84
    "BloomForCausalLM": ("bloom", "BloomForCausalLM"),
85
    "ChatGLMModel": ("chatglm", "ChatGLMForCausalLM"),
86
    "ChatGLMForConditionalGeneration": ("chatglm", "ChatGLMForCausalLM"),
87
    "CohereForCausalLM": ("commandr", "CohereForCausalLM"),
88
    "Cohere2ForCausalLM": ("commandr", "CohereForCausalLM"),
89
    "CwmForCausalLM": ("llama", "LlamaForCausalLM"),
90
    "DbrxForCausalLM": ("dbrx", "DbrxForCausalLM"),
91
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
92
    "DeepseekForCausalLM": ("deepseek_v2", "DeepseekForCausalLM"),
93
    "DeepseekV2ForCausalLM": ("deepseek_v2", "DeepseekV2ForCausalLM"),
94
    "DeepseekV3ForCausalLM": ("deepseek_v2", "DeepseekV3ForCausalLM"),
95
    "DeepseekV32ForCausalLM": ("deepseek_v2", "DeepseekV3ForCausalLM"),
96
    "Dots1ForCausalLM": ("dots1", "Dots1ForCausalLM"),
97
    "Ernie4_5ForCausalLM": ("ernie45", "Ernie4_5ForCausalLM"),
98
    "Ernie4_5_MoeForCausalLM": ("ernie45_moe", "Ernie4_5_MoeForCausalLM"),
99
    "ExaoneForCausalLM": ("exaone", "ExaoneForCausalLM"),
100
    "Exaone4ForCausalLM": ("exaone4", "Exaone4ForCausalLM"),
Kyungmin Lee's avatar
Kyungmin Lee committed
101
    "ExaoneMoEForCausalLM": ("exaone_moe", "ExaoneMoeForCausalLM"),
102
    "Fairseq2LlamaForCausalLM": ("fairseq2_llama", "Fairseq2LlamaForCausalLM"),
103
104
105
    "FalconForCausalLM": ("falcon", "FalconForCausalLM"),
    "FalconMambaForCausalLM": ("mamba", "MambaForCausalLM"),
    "FalconH1ForCausalLM": ("falcon_h1", "FalconH1ForCausalLM"),
106
    "FlexOlmoForCausalLM": ("flex_olmo", "FlexOlmoForCausalLM"),
107
108
    "GemmaForCausalLM": ("gemma", "GemmaForCausalLM"),
    "Gemma2ForCausalLM": ("gemma2", "Gemma2ForCausalLM"),
109
    "Gemma3ForCausalLM": ("gemma3", "Gemma3ForCausalLM"),
Nicolò Lucchesi's avatar
Nicolò Lucchesi committed
110
    "Gemma3nForCausalLM": ("gemma3n", "Gemma3nForCausalLM"),
111
    "Qwen3NextForCausalLM": ("qwen3_next", "Qwen3NextForCausalLM"),
112
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
113
    "Glm4ForCausalLM": ("glm4", "Glm4ForCausalLM"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
114
    "Glm4MoeForCausalLM": ("glm4_moe", "Glm4MoeForCausalLM"),
115
    "GptOssForCausalLM": ("gpt_oss", "GptOssForCausalLM"),
116
117
118
119
120
121
    "GPT2LMHeadModel": ("gpt2", "GPT2LMHeadModel"),
    "GPTBigCodeForCausalLM": ("gpt_bigcode", "GPTBigCodeForCausalLM"),
    "GPTJForCausalLM": ("gpt_j", "GPTJForCausalLM"),
    "GPTNeoXForCausalLM": ("gpt_neox", "GPTNeoXForCausalLM"),
    "GraniteForCausalLM": ("granite", "GraniteForCausalLM"),
    "GraniteMoeForCausalLM": ("granitemoe", "GraniteMoeForCausalLM"),
122
123
    "GraniteMoeHybridForCausalLM": ("granitemoehybrid", "GraniteMoeHybridForCausalLM"),  # noqa: E501
    "GraniteMoeSharedForCausalLM": ("granitemoeshared", "GraniteMoeSharedForCausalLM"),  # noqa: E501
124
    "GritLM": ("gritlm", "GritLM"),
Bijaya Dangol's avatar
Bijaya Dangol committed
125
126
    "Grok1ModelForCausalLM": ("grok1", "GrokForCausalLM"),
    "Grok1ForCausalLM": ("grok1", "GrokForCausalLM"),
127
128
    "HunYuanMoEV1ForCausalLM": ("hunyuan_v1", "HunYuanMoEV1ForCausalLM"),
    "HunYuanDenseV1ForCausalLM": ("hunyuan_v1", "HunYuanDenseV1ForCausalLM"),
129
    "HCXVisionForCausalLM": ("hyperclovax_vision", "HCXVisionForCausalLM"),
130
131
    "InternLMForCausalLM": ("llama", "LlamaForCausalLM"),
    "InternLM2ForCausalLM": ("internlm2", "InternLM2ForCausalLM"),
132
    "InternLM2VEForCausalLM": ("internlm2_ve", "InternLM2VEForCausalLM"),
133
    "InternLM3ForCausalLM": ("llama", "LlamaForCausalLM"),
134
135
    "IQuestCoderForCausalLM": ("llama", "LlamaForCausalLM"),
    "IQuestLoopCoderForCausalLM": ("iquest_loopcoder", "IQuestLoopCoderForCausalLM"),
136
    "JAISLMHeadModel": ("jais", "JAISLMHeadModel"),
137
    "Jais2ForCausalLM": ("jais2", "Jais2ForCausalLM"),
138
    "JambaForCausalLM": ("jamba", "JambaForCausalLM"),
139
    "KimiLinearForCausalLM": ("kimi_linear", "KimiLinearForCausalLM"),  # noqa: E501
140
    "Lfm2ForCausalLM": ("lfm2", "Lfm2ForCausalLM"),
Paul Pak's avatar
Paul Pak committed
141
    "Lfm2MoeForCausalLM": ("lfm2_moe", "Lfm2MoeForCausalLM"),
142
    "LlamaForCausalLM": ("llama", "LlamaForCausalLM"),
143
    "Llama4ForCausalLM": ("llama4", "Llama4ForCausalLM"),
144
145
    # For decapoda-research/llama-*
    "LLaMAForCausalLM": ("llama", "LlamaForCausalLM"),
XuruiYang's avatar
XuruiYang committed
146
    "LongcatFlashForCausalLM": ("longcat_flash", "LongcatFlashForCausalLM"),
147
    "MambaForCausalLM": ("mamba", "MambaForCausalLM"),
148
    "Mamba2ForCausalLM": ("mamba2", "Mamba2ForCausalLM"),
149
150
    "MiniCPMForCausalLM": ("minicpm", "MiniCPMForCausalLM"),
    "MiniCPM3ForCausalLM": ("minicpm3", "MiniCPM3ForCausalLM"),
151
152
153
    "MiniMaxForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxText01ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxM1ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
154
    "MiniMaxM2ForCausalLM": ("minimax_m2", "MiniMaxM2ForCausalLM"),
155
    "MistralForCausalLM": ("llama", "LlamaForCausalLM"),
156
    "MistralLarge3ForCausalLM": ("mistral_large_3", "MistralLarge3ForCausalLM"),
157
158
159
160
    "MixtralForCausalLM": ("mixtral", "MixtralForCausalLM"),
    # transformers's mpt class has lower case
    "MptForCausalLM": ("mpt", "MPTForCausalLM"),
    "MPTForCausalLM": ("mpt", "MPTForCausalLM"),
161
    "MiMoForCausalLM": ("mimo", "MiMoForCausalLM"),
162
    "MiMoV2FlashForCausalLM": ("mimo_v2_flash", "MiMoV2FlashForCausalLM"),
163
    "NemotronForCausalLM": ("nemotron", "NemotronForCausalLM"),
Luis Vega's avatar
Luis Vega committed
164
    "NemotronHForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
165
    "OlmoForCausalLM": ("olmo", "OlmoForCausalLM"),
166
    "Olmo2ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
167
    "Olmo3ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
168
169
170
    "OlmoeForCausalLM": ("olmoe", "OlmoeForCausalLM"),
    "OPTForCausalLM": ("opt", "OPTForCausalLM"),
    "OrionForCausalLM": ("orion", "OrionForCausalLM"),
171
    "OuroForCausalLM": ("ouro", "OuroForCausalLM"),
172
    "PanguEmbeddedForCausalLM": ("openpangu", "PanguEmbeddedForCausalLM"),
173
    "PanguProMoEV2ForCausalLM": ("openpangu", "PanguProMoEV2ForCausalLM"),
174
    "PanguUltraMoEForCausalLM": ("openpangu", "PanguUltraMoEForCausalLM"),
175
176
177
178
    "PersimmonForCausalLM": ("persimmon", "PersimmonForCausalLM"),
    "PhiForCausalLM": ("phi", "PhiForCausalLM"),
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
    "PhiMoEForCausalLM": ("phimoe", "PhiMoEForCausalLM"),
Shinichi Hemmi's avatar
Shinichi Hemmi committed
179
    "Plamo2ForCausalLM": ("plamo2", "Plamo2ForCausalLM"),
180
    "Plamo3ForCausalLM": ("plamo3", "Plamo3ForCausalLM"),
181
    "QWenLMHeadModel": ("qwen", "QWenLMHeadModel"),
182
183
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
    "Qwen2MoeForCausalLM": ("qwen2_moe", "Qwen2MoeForCausalLM"),
184
185
    "Qwen3ForCausalLM": ("qwen3", "Qwen3ForCausalLM"),
    "Qwen3MoeForCausalLM": ("qwen3_moe", "Qwen3MoeForCausalLM"),
186
    "RWForCausalLM": ("falcon", "FalconForCausalLM"),
187
    "SeedOssForCausalLM": ("seed_oss", "SeedOssForCausalLM"),
Li Xie's avatar
Li Xie committed
188
    "Step1ForCausalLM": ("step1", "Step1ForCausalLM"),
Song's avatar
Song committed
189
    "Step3TextForCausalLM": ("step3_text", "Step3TextForCausalLM"),
190
191
192
193
    "StableLMEpochForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "StableLmForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "Starcoder2ForCausalLM": ("starcoder2", "Starcoder2ForCausalLM"),
    "SolarForCausalLM": ("solar", "SolarForCausalLM"),
194
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
195
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
196
    "TeleFLMForCausalLM": ("teleflm", "TeleFLMForCausalLM"),
197
    "XverseForCausalLM": ("llama", "LlamaForCausalLM"),
198
    "Zamba2ForCausalLM": ("zamba2", "Zamba2ForCausalLM"),
199
200
201
}

_EMBEDDING_MODELS = {
202
    # [Text-only]
203
    "BertModel": ("bert", "BertEmbeddingModel"),
204
    "BertSpladeSparseEmbeddingModel": ("bert", "BertSpladeSparseEmbeddingModel"),
205
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
206
    "Gemma2Model": ("gemma2", "Gemma2ForCausalLM"),
207
    "Gemma3TextModel": ("gemma3", "Gemma3Model"),
208
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
209
    "GPT2ForSequenceClassification": ("gpt2", "GPT2ForSequenceClassification"),
210
    "GritLM": ("gritlm", "GritLM"),
211
212
    "GteModel": ("bert_with_rope", "SnowflakeGteNewModel"),
    "GteNewModel": ("bert_with_rope", "GteNewModel"),
213
    "InternLM2ForRewardModel": ("internlm2", "InternLM2ForRewardModel"),
214
    "JambaForSequenceClassification": ("jamba", "JambaForSequenceClassification"),  # noqa: E501
215
    "LlamaBidirectionalModel": ("llama", "LlamaBidirectionalModel"),
216
    "LlamaModel": ("llama", "LlamaForCausalLM"),
217
218
    **{
        # Multiple models share the same architecture, so we include them all
219
220
        k: (mod, arch)
        for k, (mod, arch) in _TEXT_GENERATION_MODELS.items()
221
222
        if arch == "LlamaForCausalLM"
    },
223
    "MistralModel": ("llama", "LlamaForCausalLM"),
224
    "ModernBertModel": ("modernbert", "ModernBertModel"),
225
    "NomicBertModel": ("bert_with_rope", "NomicBertModel"),
226
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
227
    "Qwen2Model": ("qwen2", "Qwen2ForCausalLM"),
228
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
229
    "Qwen2ForRewardModel": ("qwen2_rm", "Qwen2ForRewardModel"),
230
    "Qwen2ForProcessRewardModel": ("qwen2_rm", "Qwen2ForProcessRewardModel"),
231
232
    "RobertaForMaskedLM": ("roberta", "RobertaEmbeddingModel"),
    "RobertaModel": ("roberta", "RobertaEmbeddingModel"),
233
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
234
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
235
    "XLMRobertaModel": ("roberta", "RobertaEmbeddingModel"),
236
    # [Multimodal]
237
    "CLIPModel": ("clip", "CLIPEmbeddingModel"),
238
239
240
    "LlavaNextForConditionalGeneration": (
        "llava_next",
        "LlavaNextForConditionalGeneration",
241
    ),
242
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
243
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
244
    "SiglipModel": ("siglip", "SiglipEmbeddingModel"),
245
246
    # Technically Terratorch models work on images, both in
    # input and output. I am adding it here because it piggy-backs on embedding
247
    # models for the time being.
248
249
    "PrithviGeoSpatialMAE": ("terratorch", "Terratorch"),
    "Terratorch": ("terratorch", "Terratorch"),
250
251
}

252
253
_CROSS_ENCODER_MODELS = {
    "BertForSequenceClassification": ("bert", "BertForSequenceClassification"),
254
    "BertForTokenClassification": ("bert", "BertForTokenClassification"),
255
256
257
258
    "GteNewForSequenceClassification": (
        "bert_with_rope",
        "GteNewForSequenceClassification",
    ),
259
260
261
262
263
    "JinaVLForRanking": ("jina_vl", "JinaVLForSequenceClassification"),
    "LlamaBidirectionalForSequenceClassification": (
        "llama",
        "LlamaBidirectionalForSequenceClassification",
    ),
264
265
266
267
    "ModernBertForSequenceClassification": (
        "modernbert",
        "ModernBertForSequenceClassification",
    ),
268
269
270
271
    "ModernBertForTokenClassification": (
        "modernbert",
        "ModernBertForTokenClassification",
    ),
272
273
274
275
276
    "RobertaForSequenceClassification": ("roberta", "RobertaForSequenceClassification"),
    "XLMRobertaForSequenceClassification": (
        "roberta",
        "RobertaForSequenceClassification",
    ),
277
278
}

279
_MULTIMODAL_MODELS = {
280
    # [Decoder-only]
281
    "AriaForConditionalGeneration": ("aria", "AriaForConditionalGeneration"),
282
283
284
285
    "AudioFlamingo3ForConditionalGeneration": (
        "audioflamingo3",
        "AudioFlamingo3ForConditionalGeneration",
    ),
286
287
288
    "AyaVisionForConditionalGeneration": (
        "aya_vision",
        "AyaVisionForConditionalGeneration",
289
    ),
290
    "BagelForConditionalGeneration": ("bagel", "BagelForConditionalGeneration"),
291
    "BeeForConditionalGeneration": ("bee", "BeeForConditionalGeneration"),
292
    "Blip2ForConditionalGeneration": ("blip2", "Blip2ForConditionalGeneration"),
293
294
295
    "ChameleonForConditionalGeneration": (
        "chameleon",
        "ChameleonForConditionalGeneration",
296
    ),
297
298
299
    "Cohere2VisionForConditionalGeneration": (
        "cohere2_vision",
        "Cohere2VisionForConditionalGeneration",
300
    ),
301
    "DeepseekVLV2ForCausalLM": ("deepseek_vl2", "DeepseekVLV2ForCausalLM"),
302
    "DeepseekOCRForCausalLM": ("deepseek_ocr", "DeepseekOCRForCausalLM"),
Roger Wang's avatar
Roger Wang committed
303
    "DotsOCRForCausalLM": ("dots_ocr", "DotsOCRForCausalLM"),
304
305
306
    "Ernie4_5_VLMoeForConditionalGeneration": (
        "ernie45_vl",
        "Ernie4_5_VLMoeForConditionalGeneration",
307
    ),
308
    "FuyuForCausalLM": ("fuyu", "FuyuForCausalLM"),
309
    "Gemma3ForConditionalGeneration": ("gemma3_mm", "Gemma3ForConditionalGeneration"),  # noqa: E501
310
311
312
    "Gemma3nForConditionalGeneration": (
        "gemma3n_mm",
        "Gemma3nForConditionalGeneration",
313
    ),
314
    "GlmAsrForConditionalGeneration": ("glmasr", "GlmAsrForConditionalGeneration"),
315
    "GLM4VForCausalLM": ("glm4v", "GLM4VForCausalLM"),
316
    "Glm4vForConditionalGeneration": ("glm4_1v", "Glm4vForConditionalGeneration"),  # noqa: E501
Jee Jee Li's avatar
Jee Jee Li committed
317
    "Glm4vMoeForConditionalGeneration": ("glm4_1v", "Glm4vMoeForConditionalGeneration"),  # noqa: E501
318
319
320
    "GraniteSpeechForConditionalGeneration": (
        "granite_speech",
        "GraniteSpeechForConditionalGeneration",
321
    ),
322
    "H2OVLChatModel": ("h2ovl", "H2OVLChatModel"),
323
324
325
326
    "HunYuanVLForConditionalGeneration": (
        "hunyuan_vision",
        "HunYuanVLForConditionalGeneration",
    ),
ltd0924's avatar
ltd0924 committed
327
    "StepVLForConditionalGeneration": ("step_vl", "StepVLForConditionalGeneration"),
328
    "InternVLChatModel": ("internvl", "InternVLChatModel"),
329
    "NemotronH_Nano_VL_V2": ("nano_nemotron_vl", "NemotronH_Nano_VL_V2"),
Zero's avatar
Zero committed
330
331
332
333
    "OpenCUAForConditionalGeneration": (
        "opencua",
        "OpenCUAForConditionalGeneration",
    ),
334
335
336
    "InternS1ForConditionalGeneration": (
        "interns1",
        "InternS1ForConditionalGeneration",
337
    ),
338
339
340
    "InternVLForConditionalGeneration": (
        "interns1",
        "InternS1ForConditionalGeneration",
341
    ),
342
343
344
345
    "Idefics3ForConditionalGeneration": (
        "idefics3",
        "Idefics3ForConditionalGeneration",
    ),
oscardev256's avatar
oscardev256 committed
346
    "IsaacForConditionalGeneration": ("isaac", "IsaacForConditionalGeneration"),
347
    "SmolVLMForConditionalGeneration": ("smolvlm", "SmolVLMForConditionalGeneration"),  # noqa: E501
348
    "KananaVForConditionalGeneration": ("kanana_v", "KananaVForConditionalGeneration"),
349
    "KeyeForConditionalGeneration": ("keye", "KeyeForConditionalGeneration"),
350
351
352
    "KeyeVL1_5ForConditionalGeneration": (
        "keye_vl1_5",
        "KeyeVL1_5ForConditionalGeneration",
353
    ),
354
    "RForConditionalGeneration": ("rvl", "RForConditionalGeneration"),
355
    "KimiVLForConditionalGeneration": ("kimi_vl", "KimiVLForConditionalGeneration"),  # noqa: E501
356
357
358
359
    "LightOnOCRForConditionalGeneration": (
        "lightonocr",
        "LightOnOCRForConditionalGeneration",
    ),
360
    "Lfm2VlForConditionalGeneration": ("lfm2_vl", "Lfm2VLForConditionalGeneration"),
361
    "Llama_Nemotron_Nano_VL": ("nemotron_vl", "LlamaNemotronVLChatModel"),
362
    "Llama4ForConditionalGeneration": ("mllama4", "Llama4ForConditionalGeneration"),  # noqa: E501
363
    "LlavaForConditionalGeneration": ("llava", "LlavaForConditionalGeneration"),
364
365
366
    "LlavaNextForConditionalGeneration": (
        "llava_next",
        "LlavaNextForConditionalGeneration",
367
    ),
368
369
370
    "LlavaNextVideoForConditionalGeneration": (
        "llava_next_video",
        "LlavaNextVideoForConditionalGeneration",
371
    ),
372
373
374
    "LlavaOnevisionForConditionalGeneration": (
        "llava_onevision",
        "LlavaOnevisionForConditionalGeneration",
375
    ),
376
    "MantisForConditionalGeneration": ("llava", "MantisForConditionalGeneration"),  # noqa: E501
377
    "MiDashengLMModel": ("midashenglm", "MiDashengLMModel"),
378
379
380
    "MiniMaxVL01ForConditionalGeneration": (
        "minimax_vl_01",
        "MiniMaxVL01ForConditionalGeneration",
381
    ),
382
    "MiniCPMO": ("minicpmo", "MiniCPMO"),
383
    "MiniCPMV": ("minicpmv", "MiniCPMV"),
384
385
386
    "Mistral3ForConditionalGeneration": (
        "mistral3",
        "Mistral3ForConditionalGeneration",
387
    ),
388
    "MolmoForCausalLM": ("molmo", "MolmoForCausalLM"),
389
    "Molmo2ForConditionalGeneration": ("molmo2", "Molmo2ForConditionalGeneration"),
390
    "NVLM_D": ("nvlm_d", "NVLM_D_Model"),
391
    "Ovis": ("ovis", "Ovis"),
392
    "Ovis2_5": ("ovis2_5", "Ovis2_5"),
393
394
395
396
    "PaddleOCRVLForConditionalGeneration": (
        "paddleocr_vl",
        "PaddleOCRVLForConditionalGeneration",
    ),
397
398
399
400
    "PaliGemmaForConditionalGeneration": (
        "paligemma",
        "PaliGemmaForConditionalGeneration",
    ),
401
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
402
    "Phi4MMForCausalLM": ("phi4mm", "Phi4MMForCausalLM"),
403
    "PixtralForConditionalGeneration": ("pixtral", "PixtralForConditionalGeneration"),  # noqa: E501
404
    "QwenVLForConditionalGeneration": ("qwen_vl", "QwenVLForConditionalGeneration"),  # noqa: E501
405
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
406
407
408
    "Qwen2_5_VLForConditionalGeneration": (
        "qwen2_5_vl",
        "Qwen2_5_VLForConditionalGeneration",
409
    ),
410
411
412
    "Qwen2AudioForConditionalGeneration": (
        "qwen2_audio",
        "Qwen2AudioForConditionalGeneration",
413
    ),
414
415
416
    "Qwen2_5OmniModel": (
        "qwen2_5_omni_thinker",
        "Qwen2_5OmniThinkerForConditionalGeneration",
417
    ),
418
419
420
    "Qwen2_5OmniForConditionalGeneration": (
        "qwen2_5_omni_thinker",
        "Qwen2_5OmniThinkerForConditionalGeneration",
421
    ),
422
423
424
425
    "Qwen3OmniMoeForConditionalGeneration": (
        "qwen3_omni_moe_thinker",
        "Qwen3OmniMoeThinkerForConditionalGeneration",
    ),
426
    "Qwen3VLForConditionalGeneration": ("qwen3_vl", "Qwen3VLForConditionalGeneration"),  # noqa: E501
427
428
429
    "Qwen3VLMoeForConditionalGeneration": (
        "qwen3_vl_moe",
        "Qwen3VLMoeForConditionalGeneration",
430
    ),
431
    "SkyworkR1VChatModel": ("skyworkr1v", "SkyworkR1VChatModel"),
Song's avatar
Song committed
432
    "Step3VLForConditionalGeneration": ("step3_vl", "Step3VLForConditionalGeneration"),  # noqa: E501
汪志鹏's avatar
汪志鹏 committed
433
    "TarsierForConditionalGeneration": ("tarsier", "TarsierForConditionalGeneration"),  # noqa: E501
434
435
436
    "Tarsier2ForConditionalGeneration": (
        "qwen2_vl",
        "Tarsier2ForConditionalGeneration",
437
    ),
438
    "UltravoxModel": ("ultravox", "UltravoxModel"),
Patrick von Platen's avatar
Patrick von Platen committed
439
    "VoxtralForConditionalGeneration": ("voxtral", "VoxtralForConditionalGeneration"),  # noqa: E501
Patrick von Platen's avatar
Patrick von Platen committed
440
    "VoxtralStreamingGeneration": ("voxtral_streaming", "VoxtralStreamingGeneration"),  # noqa: E501
441
    # [Encoder-decoder]
442
443
444
445
    "NemotronParseForConditionalGeneration": (
        "nemotron_parse",
        "NemotronParseForConditionalGeneration",
    ),
446
    "WhisperForConditionalGeneration": ("whisper", "WhisperForConditionalGeneration"),  # noqa: E501
447
}
448
449

_SPECULATIVE_DECODING_MODELS = {
450
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
451
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
zhiweiz's avatar
zhiweiz committed
452
    "EagleLlama4ForCausalLM": ("llama4_eagle", "EagleLlama4ForCausalLM"),
453
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
454
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
455
    "LlamaForCausalLMEagle3": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
456
    "Eagle3Qwen2_5vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
457
    "Eagle3Qwen3vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
458
459
460
461
    "EagleMistralLarge3ForCausalLM": (
        "mistral_large_3_eagle",
        "EagleMistralLarge3ForCausalLM",
    ),
462
    "EagleDeepSeekMTPModel": ("deepseek_eagle", "EagleDeepseekV3ForCausalLM"),
463
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
464
    "ErnieMTPModel": ("ernie_mtp", "ErnieMTP"),
Kyungmin Lee's avatar
Kyungmin Lee committed
465
    "ExaoneMoeMTP": ("exaone_moe_mtp", "ExaoneMoeMTP"),
XuruiYang's avatar
XuruiYang committed
466
    "LongCatFlashMTPModel": ("longcat_flash_mtp", "LongCatFlashMTP"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
467
    "Glm4MoeMTPModel": ("glm4_moe_mtp", "Glm4MoeMTP"),
468
    "MedusaModel": ("medusa", "Medusa"),
469
    "OpenPanguMTPModel": ("openpangu_mtp", "OpenPanguMTP"),
470
    "Qwen3NextMTP": ("qwen3_next_mtp", "Qwen3NextMTP"),
471
472
473
    # Temporarily disabled.
    # # TODO(woosuk): Re-enable this once the MLP Speculator is supported in V1.
    # "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
474
}
475

476
_TRANSFORMERS_SUPPORTED_MODELS = {
477
478
479
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
480
481
482
483
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
484
485
486
}

_TRANSFORMERS_BACKEND_MODELS = {
487
    # Text generation models
488
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
    "TransformersMoEForCausalLM": ("transformers", "TransformersMoEForCausalLM"),
    # Multimodal models
    "TransformersMultiModalForCausalLM": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
    "TransformersMultiModalMoEForCausalLM": (
        "transformers",
        "TransformersMultiModalMoEForCausalLM",
    ),
    # Embedding models
    "TransformersEmbeddingModel": ("transformers", "TransformersEmbeddingModel"),
    "TransformersMoEEmbeddingModel": ("transformers", "TransformersMoEEmbeddingModel"),
    "TransformersMultiModalEmbeddingModel": (
        "transformers",
        "TransformersMultiModalEmbeddingModel",
    ),
    # Sequence classification models
507
    "TransformersForSequenceClassification": (
508
        "transformers",
509
        "TransformersForSequenceClassification",
510
    ),
511
    "TransformersMoEForSequenceClassification": (
512
        "transformers",
513
        "TransformersMoEForSequenceClassification",
514
    ),
515
516
517
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
518
    ),
519
}
520

521
_VLLM_MODELS = {
522
    **_TEXT_GENERATION_MODELS,
523
    **_EMBEDDING_MODELS,
524
    **_CROSS_ENCODER_MODELS,
525
    **_MULTIMODAL_MODELS,
526
    **_SPECULATIVE_DECODING_MODELS,
527
528
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
529
530
}

531
532
533
534
# This variable is used as the args for subprocess.run(). We
# can modify  this variable to alter the args if needed. e.g.
# when we use par format to pack things together, sys.executable
# might not be the target we want to run.
535
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
536

537
_PREVIOUSLY_SUPPORTED_MODELS = {
538
    "MotifForCausalLM": "0.10.2",
539
    "Phi3SmallForCausalLM": "0.9.2",
540
    "Phi4FlashForCausalLM": "0.10.2",
541
    "Phi4MultimodalForCausalLM": "0.12.0",
542
543
544
545
546
547
548
549
550
    # encoder-decoder models except whisper
    # have been removed for V0 deprecation.
    "BartModel": "0.10.2",
    "BartForConditionalGeneration": "0.10.2",
    "DonutForConditionalGeneration": "0.10.2",
    "Florence2ForConditionalGeneration": "0.10.2",
    "MBartForConditionalGeneration": "0.10.2",
    "MllamaForConditionalGeneration": "0.10.2",
}
551

552

553
554
@dataclass(frozen=True)
class _ModelInfo:
555
    architecture: str
556
    is_text_generation_model: bool
557
    is_pooling_model: bool
558
    attn_type: AttnTypeStr
559
560
    default_seq_pooling_type: SequencePoolingType
    default_tok_pooling_type: TokenPoolingType
561
    supports_cross_encoding: bool
562
    supports_multimodal: bool
563
    supports_multimodal_raw_input_only: bool
Patrick von Platen's avatar
Patrick von Platen committed
564
    requires_raw_input_tokens: bool
565
    supports_multimodal_encoder_tp_data: bool
566
    supports_pp: bool
567
568
    has_inner_state: bool
    is_attention_free: bool
569
    is_hybrid: bool
570
    has_noops: bool
571
    supports_mamba_prefix_caching: bool
572
    supports_transcription: bool
573
    supports_transcription_only: bool
574
575

    @staticmethod
576
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
577
        return _ModelInfo(
578
            architecture=model.__name__,
579
            is_text_generation_model=is_text_generation_model(model),
580
            is_pooling_model=is_pooling_model(model),
581
582
            default_seq_pooling_type=get_default_seq_pooling_type(model),
            default_tok_pooling_type=get_default_tok_pooling_type(model),
583
            attn_type=get_attn_type(model),
584
            supports_cross_encoding=supports_cross_encoding(model),
585
            supports_multimodal=supports_multimodal(model),
586
587
588
            supports_multimodal_raw_input_only=supports_multimodal_raw_input_only(
                model
            ),
Patrick von Platen's avatar
Patrick von Platen committed
589
            requires_raw_input_tokens=requires_raw_input_tokens(model),
590
591
592
            supports_multimodal_encoder_tp_data=supports_multimodal_encoder_tp_data(
                model
            ),
593
            supports_pp=supports_pp(model),
594
595
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
596
            is_hybrid=is_hybrid(model),
597
            supports_mamba_prefix_caching=supports_mamba_prefix_caching(model),
598
            supports_transcription=supports_transcription(model),
599
600
601
            supports_transcription_only=(
                supports_transcription(model) and model.supports_transcription_only
            ),
602
            has_noops=has_noops(model),
603
        )
604
605


606
607
608
609
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
610

611
    @abstractmethod
612
    def load_model_cls(self) -> type[nn.Module]:
613
        raise NotImplementedError
614
615


616
617
618
619
620
621
622
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
623
    model_cls: type[nn.Module]
624
625

    @staticmethod
626
    def from_model_cls(model_cls: type[nn.Module]):
627
628
629
630
631
632
633
634
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

    def inspect_model_cls(self) -> _ModelInfo:
        return self.interfaces

635
    def load_model_cls(self) -> type[nn.Module]:
636
637
638
639
640
641
642
643
        return self.model_cls


@dataclass(frozen=True)
class _LazyRegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has not been imported in the main process.
    """
644

645
646
647
    module_name: str
    class_name: str

648
649
650
651
652
653
654
655
    @staticmethod
    def _get_cache_dir() -> Path:
        return Path(envs.VLLM_CACHE_ROOT) / "modelinfos"

    def _get_cache_filename(self) -> str:
        cls_name = f"{self.module_name}-{self.class_name}".replace(".", "-")
        return f"{cls_name}.json"

656
    def _load_modelinfo_from_cache(self, module_hash: str) -> _ModelInfo | None:
657
658
        try:
            try:
659
                modelinfo_path = self._get_cache_dir() / self._get_cache_filename()
660
661
662
                with open(modelinfo_path, encoding="utf-8") as file:
                    mi_dict = json.load(file)
            except FileNotFoundError:
663
                logger.debug(
664
                    "Cached model info file for class %s.%s not found",
665
666
667
                    self.module_name,
                    self.class_name,
                )
668
669
670
                return None

            if mi_dict["hash"] != module_hash:
671
                logger.debug(
672
                    "Cached model info file for class %s.%s is stale",
673
674
675
                    self.module_name,
                    self.class_name,
                )
676
677
678
679
680
                return None

            # file not changed, use cached _ModelInfo properties
            return _ModelInfo(**mi_dict["modelinfo"])
        except Exception:
681
            logger.debug(
682
                "Cached model info for class %s.%s error. ",
683
684
685
                self.module_name,
                self.class_name,
            )
686
687
            return None

688
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
689
690
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
691

692
693
694
695
696
697
698
699
        try:
            modelinfo_dict = {
                "hash": module_hash,
                "modelinfo": asdict(mi),
            }
            cache_dir = self._get_cache_dir()
            cache_dir.mkdir(parents=True, exist_ok=True)
            modelinfo_path = cache_dir / self._get_cache_filename()
700
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
701
702
703
704
705
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

    @logtime(logger=logger, msg="Registry inspect model class")
706
    def inspect_model_cls(self) -> _ModelInfo:
707
        model_path = Path(__file__).parent / f"{self.module_name.split('.')[-1]}.py"
708
        module_hash = None
709

710
711
        if model_path.exists():
            with open(model_path, "rb") as f:
712
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
713
714
715

            mi = self._load_modelinfo_from_cache(module_hash)
            if mi is not None:
716
                logger.debug(
717
                    "Loaded model info for class %s.%s from cache",
718
719
720
                    self.module_name,
                    self.class_name,
                )
721
722
                return mi
            else:
723
                logger.debug(
724
                    "Cache model info for class %s.%s miss. Loading model instead.",
725
726
727
                    self.module_name,
                    self.class_name,
                )
728
729
730

        # Performed in another process to avoid initializing CUDA
        mi = _run_in_subprocess(
731
732
733
734
735
            lambda: _ModelInfo.from_model_cls(self.load_model_cls())
        )
        logger.debug(
            "Loaded model info for class %s.%s", self.module_name, self.class_name
        )
736
737

        # save cache file
738
739
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
740
741

        return mi
742

743
    def load_model_cls(self) -> type[nn.Module]:
744
745
746
747
748
749
750
751
        mod = importlib.import_module(self.module_name)
        return getattr(mod, self.class_name)


@lru_cache(maxsize=128)
def _try_load_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
752
) -> type[nn.Module] | None:
753
    from vllm.platforms import current_platform
754

755
    current_platform.verify_model_arch(model_arch)
756
757
758
    try:
        return model.load_model_cls()
    except Exception:
759
        logger.exception("Error in loading model architecture '%s'", model_arch)
760
        return None
761
762


763
764
765
766
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
767
) -> _ModelInfo | None:
768
769
770
    try:
        return model.inspect_model_cls()
    except Exception:
771
        logger.exception("Error in inspecting model architecture '%s'", model_arch)
772
        return None
773
774


775
776
777
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
778
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
779

780
    def get_supported_archs(self) -> Set[str]:
781
        return self.models.keys()
782

783
784
785
    def register_model(
        self,
        model_arch: str,
786
        model_cls: type[nn.Module] | str,
787
    ) -> None:
788
789
790
        """
        Register an external model to be used in vLLM.

791
        `model_cls` can be either:
792

793
        - A [`torch.nn.Module`][] class directly referencing the model.
794
        - A string in the format `<module>:<class>` which can be used to
795
796
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
797
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
798
        """
799
800
801
802
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

803
        if model_arch in self.models:
804
805
            logger.warning(
                "Model architecture %s is already registered, and will be "
806
807
808
809
                "overwritten by the new model class %s.",
                model_arch,
                model_cls,
            )
810
811
812
813
814
815

        if isinstance(model_cls, str):
            split_str = model_cls.split(":")
            if len(split_str) != 2:
                msg = "Expected a string in the format `<module>:<class>`"
                raise ValueError(msg)
816

817
            model = _LazyRegisteredModel(*split_str)
818
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
819
            model = _RegisteredModel.from_model_cls(model_cls)
820
        else:
821
822
823
824
            msg = (
                "`model_cls` should be a string or PyTorch model class, "
                f"not a {type(model_arch)}"
            )
825
            raise TypeError(msg)
826

827
        self.models[model_arch] = model
828

829
    def _raise_for_unsupported(self, architectures: list[str]):
830
        all_supported_archs = self.get_supported_archs()
831

832
833
834
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
835
836
                "to be inspected. Please check the logs for more details."
            )
837

838
839
840
841
842
843
844
845
        for arch in architectures:
            if arch in _PREVIOUSLY_SUPPORTED_MODELS:
                previous_version = _PREVIOUSLY_SUPPORTED_MODELS[arch]

                raise ValueError(
                    f"Model architecture {arch} was supported in vLLM until "
                    f"v{previous_version}, and is not supported anymore. "
                    "Please use an older version of vLLM if you want to "
846
847
                    "use this model architecture."
                )
848

849
850
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
851
852
            f"Supported architectures: {all_supported_archs}"
        )
853

854
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
855
856
        if model_arch not in self.models:
            return None
857

858
        return _try_load_model_cls(model_arch, self.models[model_arch])
859

860
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
861
862
        if model_arch not in self.models:
            return None
863

864
865
866
867
868
869
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
870
    ) -> str | None:
871
872
873
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

874
875
876
        auto_map: dict[str, str] = (
            getattr(model_config.hf_config, "auto_map", None) or dict()
        )
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892

        # Make sure that config class is always initialized before model class,
        # otherwise the model class won't be able to access the config class,
        # the expected auto_map should have correct order like:
        # "auto_map": {
        #     "AutoConfig": "<your-repo-name>--<config-name>",
        #     "AutoModel": "<your-repo-name>--<config-name>",
        #     "AutoModelFor<Task>": "<your-repo-name>--<config-name>",
        # },
        for prefix in ("AutoConfig", "AutoModel"):
            for name, module in auto_map.items():
                if name.startswith(prefix):
                    try_get_class_from_dynamic_module(
                        module,
                        model_config.model,
                        revision=model_config.revision,
893
                        trust_remote_code=model_config.trust_remote_code,
894
895
896
897
898
899
900
901
902
903
904
905
                        warn_on_fail=False,
                    )

        model_module = getattr(transformers, architecture, None)

        if model_module is None:
            for name, module in auto_map.items():
                if name.startswith("AutoModel"):
                    model_module = try_get_class_from_dynamic_module(
                        module,
                        model_config.model,
                        revision=model_config.revision,
906
                        trust_remote_code=model_config.trust_remote_code,
907
908
909
910
911
                        warn_on_fail=True,
                    )
                    if model_module is not None:
                        break
            else:
912
                if model_config.model_impl != "transformers":
913
914
915
916
917
918
919
                    return None

                raise ValueError(
                    f"Cannot find model module. {architecture!r} is not a "
                    "registered model in the Transformers library (only "
                    "relevant if the model is meant to be in Transformers) "
                    "and 'AutoModel' is not present in the model config's "
920
921
                    "'auto_map' (relevant if the model is custom)."
                )
922
923

        if not model_module.is_backend_compatible():
924
            if model_config.model_impl != "transformers":
925
                return None
926

927
928
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
929
930
                "is not compatible with vLLM."
            )
931

932
        return model_config._get_transformers_backend_cls()
933

934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
    def _normalize_arch(
        self,
        architecture: str,
        model_config: ModelConfig,
    ) -> str:
        if architecture in self.models:
            return architecture

        # This may be called in order to resolve runner_type and convert_type
        # in the first place, in which case we consider the default match
        match = try_match_architecture_defaults(
            architecture,
            runner_type=getattr(model_config, "runner_type", None),
            convert_type=getattr(model_config, "convert_type", None),
        )
        if match:
            suffix, _ = match

            # Get the name of the base model to convert
            for repl_suffix, _ in iter_architecture_defaults():
                base_arch = architecture.replace(suffix, repl_suffix)
                if base_arch in self.models:
                    return base_arch

        return architecture
959

960
961
    def inspect_model_cls(
        self,
962
        architectures: str | list[str],
963
        model_config: ModelConfig,
964
    ) -> tuple[_ModelInfo, str]:
965
966
        if isinstance(architectures, str):
            architectures = [architectures]
967
968
        if not architectures:
            raise ValueError("No model architectures are specified")
969
970

        # Require transformers impl
971
        if model_config.model_impl == "transformers":
972
            arch = self._try_resolve_transformers(architectures[0], model_config)
973
974
975
976
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)
977
        elif model_config.model_impl == "terratorch":
978
979
            model_info = self._try_inspect_model_cls("Terratorch")
            return (model_info, "Terratorch")
980

981
        # Fallback to transformers impl (after resolving convert_type)
982
983
984
985
986
987
        if (
            all(arch not in self.models for arch in architectures)
            and model_config.model_impl == "auto"
            and getattr(model_config, "convert_type", "none") == "none"
        ):
            arch = self._try_resolve_transformers(architectures[0], model_config)
988
989
990
991
992
993
994
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)

        for arch in architectures:
            normalized_arch = self._normalize_arch(arch, model_config)
995
            model_info = self._try_inspect_model_cls(normalized_arch)
996
            if model_info is not None:
997
                return (model_info, arch)
998

999
        # Fallback to transformers impl (before resolving runner_type)
1000
1001
1002
1003
1004
        if (
            all(arch not in self.models for arch in architectures)
            and model_config.model_impl == "auto"
        ):
            arch = self._try_resolve_transformers(architectures[0], model_config)
1005
1006
1007
1008
1009
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)

1010
        return self._raise_for_unsupported(architectures)
1011

1012
1013
    def resolve_model_cls(
        self,
1014
        architectures: str | list[str],
1015
        model_config: ModelConfig,
1016
    ) -> tuple[type[nn.Module], str]:
1017
1018
        if isinstance(architectures, str):
            architectures = [architectures]
1019
1020
        if not architectures:
            raise ValueError("No model architectures are specified")
1021
1022

        # Require transformers impl
1023
        if model_config.model_impl == "transformers":
1024
            arch = self._try_resolve_transformers(architectures[0], model_config)
1025
1026
1027
1028
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)
1029
        elif model_config.model_impl == "terratorch":
1030
1031
1032
1033
            arch = "Terratorch"
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
1034

1035
        # Fallback to transformers impl (after resolving convert_type)
1036
1037
1038
1039
1040
1041
        if (
            all(arch not in self.models for arch in architectures)
            and model_config.model_impl == "auto"
            and getattr(model_config, "convert_type", "none") == "none"
        ):
            arch = self._try_resolve_transformers(architectures[0], model_config)
1042
1043
1044
1045
1046
1047
1048
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

        for arch in architectures:
            normalized_arch = self._normalize_arch(arch, model_config)
1049
            model_cls = self._try_load_model_cls(normalized_arch)
1050
1051
            if model_cls is not None:
                return (model_cls, arch)
1052

1053
        # Fallback to transformers impl (before resolving runner_type)
1054
1055
1056
1057
1058
        if (
            all(arch not in self.models for arch in architectures)
            and model_config.model_impl == "auto"
        ):
            arch = self._try_resolve_transformers(architectures[0], model_config)
1059
1060
1061
1062
1063
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1064
        return self._raise_for_unsupported(architectures)
1065

1066
1067
    def is_text_generation_model(
        self,
1068
        architectures: str | list[str],
1069
        model_config: ModelConfig,
1070
    ) -> bool:
1071
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1072
        return model_cls.is_text_generation_model
1073

1074
    def is_pooling_model(
1075
        self,
1076
        architectures: str | list[str],
1077
        model_config: ModelConfig,
1078
    ) -> bool:
1079
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1080
        return model_cls.is_pooling_model
1081

1082
1083
    def is_cross_encoder_model(
        self,
1084
        architectures: str | list[str],
1085
        model_config: ModelConfig,
1086
    ) -> bool:
1087
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1088
        return model_cls.supports_cross_encoding
1089

1090
1091
    def is_multimodal_model(
        self,
1092
        architectures: str | list[str],
1093
        model_config: ModelConfig,
1094
    ) -> bool:
1095
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1096
        return model_cls.supports_multimodal
1097

1098
    def is_multimodal_raw_input_only_model(
1099
        self,
1100
        architectures: str | list[str],
1101
        model_config: ModelConfig,
1102
    ) -> bool:
1103
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1104
        return model_cls.supports_multimodal_raw_input_only
1105

1106
1107
    def is_pp_supported_model(
        self,
1108
        architectures: str | list[str],
1109
        model_config: ModelConfig,
1110
    ) -> bool:
1111
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1112
        return model_cls.supports_pp
1113

1114
1115
    def model_has_inner_state(
        self,
1116
        architectures: str | list[str],
1117
        model_config: ModelConfig,
1118
    ) -> bool:
1119
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1120
        return model_cls.has_inner_state
1121

1122
1123
    def is_attention_free_model(
        self,
1124
        architectures: str | list[str],
1125
        model_config: ModelConfig,
1126
    ) -> bool:
1127
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1128
        return model_cls.is_attention_free
1129

1130
1131
    def is_hybrid_model(
        self,
1132
        architectures: str | list[str],
1133
        model_config: ModelConfig,
1134
    ) -> bool:
1135
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1136
1137
        return model_cls.is_hybrid

1138
1139
    def is_noops_model(
        self,
1140
        architectures: str | list[str],
1141
        model_config: ModelConfig,
1142
    ) -> bool:
1143
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1144
1145
        return model_cls.has_noops

1146
1147
    def is_transcription_model(
        self,
1148
        architectures: str | list[str],
1149
        model_config: ModelConfig,
1150
    ) -> bool:
1151
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1152
1153
        return model_cls.supports_transcription

1154
1155
    def is_transcription_only_model(
        self,
1156
        architectures: str | list[str],
1157
        model_config: ModelConfig,
1158
    ) -> bool:
1159
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1160
1161
        return model_cls.supports_transcription_only

1162

1163
1164
1165
1166
1167
1168
1169
1170
1171
ModelRegistry = _ModelRegistry(
    {
        model_arch: _LazyRegisteredModel(
            module_name=f"vllm.model_executor.models.{mod_relname}",
            class_name=cls_name,
        )
        for model_arch, (mod_relname, cls_name) in _VLLM_MODELS.items()
    }
)
1172
1173
1174
1175
1176

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1177
1178
1179
1180
1181
    # NOTE: We use a temporary directory instead of a temporary file to avoid
    # issues like https://stackoverflow.com/questions/23212435/permission-denied-to-write-to-my-temporary-file
    with tempfile.TemporaryDirectory() as tempdir:
        output_filepath = os.path.join(tempdir, "registry_output.tmp")

1182
        # `cloudpickle` allows pickling lambda functions directly
1183
        import cloudpickle
1184

1185
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1186
1187
1188

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
1189
1190
1191
        returned = subprocess.run(
            _SUBPROCESS_COMMAND, input=input_bytes, capture_output=True
        )
1192
1193
1194
1195
1196
1197

        # check if the subprocess is successful
        try:
            returned.check_returncode()
        except Exception as e:
            # wrap raised exception to provide more information
1198
1199
1200
            raise RuntimeError(
                f"Error raised in subprocess:\n{returned.stderr.decode()}"
            ) from e
1201

1202
        with open(output_filepath, "rb") as f:
1203
1204
1205
1206
1207
1208
            return pickle.load(f)


def _run() -> None:
    # Setup plugins
    from vllm.plugins import load_general_plugins
1209

1210
1211
1212
1213
1214
    load_general_plugins()

    fn, output_file = pickle.loads(sys.stdin.buffer.read())

    result = fn()
1215
1216
1217

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1218
1219
1220


if __name__ == "__main__":
1221
    _run()