registry.py 47.4 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"),
Song's avatar
Song committed
188
    "Step3TextForCausalLM": ("step3_text", "Step3TextForCausalLM"),
189
190
191
192
    "StableLMEpochForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "StableLmForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "Starcoder2ForCausalLM": ("starcoder2", "Starcoder2ForCausalLM"),
    "SolarForCausalLM": ("solar", "SolarForCausalLM"),
193
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
194
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
195
    "TeleFLMForCausalLM": ("teleflm", "TeleFLMForCausalLM"),
196
    "XverseForCausalLM": ("llama", "LlamaForCausalLM"),
197
    "Zamba2ForCausalLM": ("zamba2", "Zamba2ForCausalLM"),
198
199
200
}

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

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

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

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

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

_TRANSFORMERS_BACKEND_MODELS = {
485
    # Text generation models
486
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
    "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
505
    "TransformersForSequenceClassification": (
506
        "transformers",
507
        "TransformersForSequenceClassification",
508
    ),
509
    "TransformersMoEForSequenceClassification": (
510
        "transformers",
511
        "TransformersMoEForSequenceClassification",
512
    ),
513
514
515
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
516
    ),
517
}
518

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

529
530
531
532
# 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.
533
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
534

535
_PREVIOUSLY_SUPPORTED_MODELS = {
536
    "MotifForCausalLM": "0.10.2",
537
    "Phi3SmallForCausalLM": "0.9.2",
538
    "Phi4FlashForCausalLM": "0.10.2",
539
    "Phi4MultimodalForCausalLM": "0.12.0",
540
541
542
543
544
545
546
547
548
    # 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",
}
549

550

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

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


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

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


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

    interfaces: _ModelInfo
621
    model_cls: type[nn.Module]
622
623

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

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

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


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

643
644
645
    module_name: str
    class_name: str

646
647
648
649
650
651
652
653
    @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"

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

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

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

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

690
691
692
693
694
695
696
697
        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()
698
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
699
700
701
702
703
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

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

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

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

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

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

        return mi
740

741
    def load_model_cls(self) -> type[nn.Module]:
742
743
744
745
746
747
748
749
        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,
750
) -> type[nn.Module] | None:
751
    from vllm.platforms import current_platform
752

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


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


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

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

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

789
        `model_cls` can be either:
790

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

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

        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)
814

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

825
        self.models[model_arch] = model
826

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

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

836
837
838
839
840
841
842
843
        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 "
844
845
                    "use this model architecture."
                )
846

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

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

856
        return _try_load_model_cls(model_arch, self.models[model_arch])
857

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

862
863
864
865
866
867
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

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

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

        # 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,
891
                        trust_remote_code=model_config.trust_remote_code,
892
893
894
895
896
897
898
899
900
901
902
903
                        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,
904
                        trust_remote_code=model_config.trust_remote_code,
905
906
907
908
909
                        warn_on_fail=True,
                    )
                    if model_module is not None:
                        break
            else:
910
                if model_config.model_impl != "transformers":
911
912
913
914
915
916
917
                    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 "
918
919
                    "'auto_map' (relevant if the model is custom)."
                )
920
921

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

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

930
        return model_config._get_transformers_backend_cls()
931

932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
    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
957

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

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

979
        # Fallback to transformers impl (after resolving convert_type)
980
981
982
983
984
985
        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)
986
987
988
989
990
991
992
            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)
993
            model_info = self._try_inspect_model_cls(normalized_arch)
994
            if model_info is not None:
995
                return (model_info, arch)
996

997
        # Fallback to transformers impl (before resolving runner_type)
998
999
1000
1001
1002
        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)
1003
1004
1005
1006
1007
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)

1008
        return self._raise_for_unsupported(architectures)
1009

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

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

1033
        # Fallback to transformers impl (after resolving convert_type)
1034
1035
1036
1037
1038
1039
        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)
1040
1041
1042
1043
1044
1045
1046
            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)
1047
            model_cls = self._try_load_model_cls(normalized_arch)
1048
1049
            if model_cls is not None:
                return (model_cls, arch)
1050

1051
        # Fallback to transformers impl (before resolving runner_type)
1052
1053
1054
1055
1056
        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)
1057
1058
1059
1060
1061
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1062
        return self._raise_for_unsupported(architectures)
1063

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

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

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

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

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

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

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

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

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

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

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

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

1160

1161
1162
1163
1164
1165
1166
1167
1168
1169
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()
    }
)
1170
1171
1172
1173
1174

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1175
1176
1177
1178
1179
    # 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")

1180
        # `cloudpickle` allows pickling lambda functions directly
1181
        import cloudpickle
1182

1183
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1184
1185
1186

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

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

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


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

1208
1209
1210
1211
1212
    load_general_plugins()

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

    result = fn()
1213
1214
1215

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


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