registry.py 48 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
    "Glm4MoeLiteForCausalLM": ("glm4_moe_lite", "Glm4MoeLiteForCausalLM"),
116
    "GptOssForCausalLM": ("gpt_oss", "GptOssForCausalLM"),
117
118
119
120
121
122
    "GPT2LMHeadModel": ("gpt2", "GPT2LMHeadModel"),
    "GPTBigCodeForCausalLM": ("gpt_bigcode", "GPTBigCodeForCausalLM"),
    "GPTJForCausalLM": ("gpt_j", "GPTJForCausalLM"),
    "GPTNeoXForCausalLM": ("gpt_neox", "GPTNeoXForCausalLM"),
    "GraniteForCausalLM": ("granite", "GraniteForCausalLM"),
    "GraniteMoeForCausalLM": ("granitemoe", "GraniteMoeForCausalLM"),
123
124
    "GraniteMoeHybridForCausalLM": ("granitemoehybrid", "GraniteMoeHybridForCausalLM"),  # noqa: E501
    "GraniteMoeSharedForCausalLM": ("granitemoeshared", "GraniteMoeSharedForCausalLM"),  # noqa: E501
125
    "GritLM": ("gritlm", "GritLM"),
Bijaya Dangol's avatar
Bijaya Dangol committed
126
127
    "Grok1ModelForCausalLM": ("grok1", "GrokForCausalLM"),
    "Grok1ForCausalLM": ("grok1", "GrokForCausalLM"),
128
129
    "HunYuanMoEV1ForCausalLM": ("hunyuan_v1", "HunYuanMoEV1ForCausalLM"),
    "HunYuanDenseV1ForCausalLM": ("hunyuan_v1", "HunYuanDenseV1ForCausalLM"),
130
    "HCXVisionForCausalLM": ("hyperclovax_vision", "HCXVisionForCausalLM"),
131
132
    "InternLMForCausalLM": ("llama", "LlamaForCausalLM"),
    "InternLM2ForCausalLM": ("internlm2", "InternLM2ForCausalLM"),
133
    "InternLM2VEForCausalLM": ("internlm2_ve", "InternLM2VEForCausalLM"),
134
    "InternLM3ForCausalLM": ("llama", "LlamaForCausalLM"),
135
136
    "IQuestCoderForCausalLM": ("llama", "LlamaForCausalLM"),
    "IQuestLoopCoderForCausalLM": ("iquest_loopcoder", "IQuestLoopCoderForCausalLM"),
137
    "JAISLMHeadModel": ("jais", "JAISLMHeadModel"),
138
    "Jais2ForCausalLM": ("jais2", "Jais2ForCausalLM"),
139
    "JambaForCausalLM": ("jamba", "JambaForCausalLM"),
140
    "KimiLinearForCausalLM": ("kimi_linear", "KimiLinearForCausalLM"),  # noqa: E501
141
    "Lfm2ForCausalLM": ("lfm2", "Lfm2ForCausalLM"),
Paul Pak's avatar
Paul Pak committed
142
    "Lfm2MoeForCausalLM": ("lfm2_moe", "Lfm2MoeForCausalLM"),
143
    "LlamaForCausalLM": ("llama", "LlamaForCausalLM"),
144
    "Llama4ForCausalLM": ("llama4", "Llama4ForCausalLM"),
145
146
    # For decapoda-research/llama-*
    "LLaMAForCausalLM": ("llama", "LlamaForCausalLM"),
XuruiYang's avatar
XuruiYang committed
147
    "LongcatFlashForCausalLM": ("longcat_flash", "LongcatFlashForCausalLM"),
148
    "MambaForCausalLM": ("mamba", "MambaForCausalLM"),
149
    "Mamba2ForCausalLM": ("mamba2", "Mamba2ForCausalLM"),
150
151
    "MiniCPMForCausalLM": ("minicpm", "MiniCPMForCausalLM"),
    "MiniCPM3ForCausalLM": ("minicpm3", "MiniCPM3ForCausalLM"),
152
153
154
    "MiniMaxForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxText01ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxM1ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
155
    "MiniMaxM2ForCausalLM": ("minimax_m2", "MiniMaxM2ForCausalLM"),
156
    "MistralForCausalLM": ("mistral", "MistralForCausalLM"),
157
    "MistralLarge3ForCausalLM": ("mistral_large_3", "MistralLarge3ForCausalLM"),
158
159
160
161
    "MixtralForCausalLM": ("mixtral", "MixtralForCausalLM"),
    # transformers's mpt class has lower case
    "MptForCausalLM": ("mpt", "MPTForCausalLM"),
    "MPTForCausalLM": ("mpt", "MPTForCausalLM"),
162
    "MiMoForCausalLM": ("mimo", "MiMoForCausalLM"),
163
    "MiMoV2FlashForCausalLM": ("mimo_v2_flash", "MiMoV2FlashForCausalLM"),
164
    "NemotronForCausalLM": ("nemotron", "NemotronForCausalLM"),
Luis Vega's avatar
Luis Vega committed
165
    "NemotronHForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
166
    "OlmoForCausalLM": ("olmo", "OlmoForCausalLM"),
167
    "Olmo2ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
168
    "Olmo3ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
169
170
171
    "OlmoeForCausalLM": ("olmoe", "OlmoeForCausalLM"),
    "OPTForCausalLM": ("opt", "OPTForCausalLM"),
    "OrionForCausalLM": ("orion", "OrionForCausalLM"),
172
    "OuroForCausalLM": ("ouro", "OuroForCausalLM"),
173
    "PanguEmbeddedForCausalLM": ("openpangu", "PanguEmbeddedForCausalLM"),
174
    "PanguProMoEV2ForCausalLM": ("openpangu", "PanguProMoEV2ForCausalLM"),
175
    "PanguUltraMoEForCausalLM": ("openpangu", "PanguUltraMoEForCausalLM"),
176
177
178
179
    "PersimmonForCausalLM": ("persimmon", "PersimmonForCausalLM"),
    "PhiForCausalLM": ("phi", "PhiForCausalLM"),
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
    "PhiMoEForCausalLM": ("phimoe", "PhiMoEForCausalLM"),
Shinichi Hemmi's avatar
Shinichi Hemmi committed
180
    "Plamo2ForCausalLM": ("plamo2", "Plamo2ForCausalLM"),
181
    "Plamo3ForCausalLM": ("plamo3", "Plamo3ForCausalLM"),
182
    "QWenLMHeadModel": ("qwen", "QWenLMHeadModel"),
183
184
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
    "Qwen2MoeForCausalLM": ("qwen2_moe", "Qwen2MoeForCausalLM"),
185
186
    "Qwen3ForCausalLM": ("qwen3", "Qwen3ForCausalLM"),
    "Qwen3MoeForCausalLM": ("qwen3_moe", "Qwen3MoeForCausalLM"),
187
    "RWForCausalLM": ("falcon", "FalconForCausalLM"),
188
    "SeedOssForCausalLM": ("seed_oss", "SeedOssForCausalLM"),
Li Xie's avatar
Li Xie committed
189
    "Step1ForCausalLM": ("step1", "Step1ForCausalLM"),
Song's avatar
Song committed
190
    "Step3TextForCausalLM": ("step3_text", "Step3TextForCausalLM"),
csy0225's avatar
csy0225 committed
191
    "Step3p5ForCausalLM": ("step3p5", "Step3p5ForCausalLM"),
192
193
194
195
    "StableLMEpochForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "StableLmForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "Starcoder2ForCausalLM": ("starcoder2", "Starcoder2ForCausalLM"),
    "SolarForCausalLM": ("solar", "SolarForCausalLM"),
196
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
197
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
198
    "TeleFLMForCausalLM": ("teleflm", "TeleFLMForCausalLM"),
199
    "XverseForCausalLM": ("llama", "LlamaForCausalLM"),
200
    "Zamba2ForCausalLM": ("zamba2", "Zamba2ForCausalLM"),
201
202
203
}

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

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

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

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

486
_TRANSFORMERS_SUPPORTED_MODELS = {
487
488
489
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
490
491
492
493
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
494
495
496
}

_TRANSFORMERS_BACKEND_MODELS = {
497
    # Text generation models
498
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
    "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
517
    "TransformersForSequenceClassification": (
518
        "transformers",
519
        "TransformersForSequenceClassification",
520
    ),
521
    "TransformersMoEForSequenceClassification": (
522
        "transformers",
523
        "TransformersMoEForSequenceClassification",
524
    ),
525
526
527
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
528
    ),
529
}
530

531
_VLLM_MODELS = {
532
    **_TEXT_GENERATION_MODELS,
533
    **_EMBEDDING_MODELS,
534
    **_CROSS_ENCODER_MODELS,
535
    **_MULTIMODAL_MODELS,
536
    **_SPECULATIVE_DECODING_MODELS,
537
538
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
539
540
}

541
542
543
544
# 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.
545
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
546

547
_PREVIOUSLY_SUPPORTED_MODELS = {
548
    "MotifForCausalLM": "0.10.2",
549
    "Phi3SmallForCausalLM": "0.9.2",
550
    "Phi4FlashForCausalLM": "0.10.2",
551
    "Phi4MultimodalForCausalLM": "0.12.0",
552
553
554
555
556
557
558
559
560
    # 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",
}
561

562

563
564
@dataclass(frozen=True)
class _ModelInfo:
565
    architecture: str
566
    is_text_generation_model: bool
567
    is_pooling_model: bool
568
    attn_type: AttnTypeStr
569
570
    default_seq_pooling_type: SequencePoolingType
    default_tok_pooling_type: TokenPoolingType
571
    supports_cross_encoding: bool
572
    supports_multimodal: bool
573
    supports_multimodal_raw_input_only: bool
Patrick von Platen's avatar
Patrick von Platen committed
574
    requires_raw_input_tokens: bool
575
    supports_multimodal_encoder_tp_data: bool
576
    supports_pp: bool
577
578
    has_inner_state: bool
    is_attention_free: bool
579
    is_hybrid: bool
580
    has_noops: bool
581
    supports_mamba_prefix_caching: bool
582
    supports_transcription: bool
583
    supports_transcription_only: bool
584
585

    @staticmethod
586
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
587
        return _ModelInfo(
588
            architecture=model.__name__,
589
            is_text_generation_model=is_text_generation_model(model),
590
            is_pooling_model=is_pooling_model(model),
591
592
            default_seq_pooling_type=get_default_seq_pooling_type(model),
            default_tok_pooling_type=get_default_tok_pooling_type(model),
593
            attn_type=get_attn_type(model),
594
            supports_cross_encoding=supports_cross_encoding(model),
595
            supports_multimodal=supports_multimodal(model),
596
597
598
            supports_multimodal_raw_input_only=supports_multimodal_raw_input_only(
                model
            ),
Patrick von Platen's avatar
Patrick von Platen committed
599
            requires_raw_input_tokens=requires_raw_input_tokens(model),
600
601
602
            supports_multimodal_encoder_tp_data=supports_multimodal_encoder_tp_data(
                model
            ),
603
            supports_pp=supports_pp(model),
604
605
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
606
            is_hybrid=is_hybrid(model),
607
            supports_mamba_prefix_caching=supports_mamba_prefix_caching(model),
608
            supports_transcription=supports_transcription(model),
609
610
611
            supports_transcription_only=(
                supports_transcription(model) and model.supports_transcription_only
            ),
612
            has_noops=has_noops(model),
613
        )
614
615


616
617
618
619
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
620

621
    @abstractmethod
622
    def load_model_cls(self) -> type[nn.Module]:
623
        raise NotImplementedError
624
625


626
627
628
629
630
631
632
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
633
    model_cls: type[nn.Module]
634
635

    @staticmethod
636
    def from_model_cls(model_cls: type[nn.Module]):
637
638
639
640
641
642
643
644
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

645
    def load_model_cls(self) -> type[nn.Module]:
646
647
648
649
650
651
652
653
        return self.model_cls


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

655
656
657
    module_name: str
    class_name: str

658
659
660
661
662
663
664
665
    @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"

666
    def _load_modelinfo_from_cache(self, module_hash: str) -> _ModelInfo | None:
667
668
        try:
            try:
669
                modelinfo_path = self._get_cache_dir() / self._get_cache_filename()
670
671
672
                with open(modelinfo_path, encoding="utf-8") as file:
                    mi_dict = json.load(file)
            except FileNotFoundError:
673
                logger.debug(
674
                    "Cached model info file for class %s.%s not found",
675
676
677
                    self.module_name,
                    self.class_name,
                )
678
679
680
                return None

            if mi_dict["hash"] != module_hash:
681
                logger.debug(
682
                    "Cached model info file for class %s.%s is stale",
683
684
685
                    self.module_name,
                    self.class_name,
                )
686
687
688
689
690
                return None

            # file not changed, use cached _ModelInfo properties
            return _ModelInfo(**mi_dict["modelinfo"])
        except Exception:
691
            logger.debug(
692
                "Cached model info for class %s.%s error. ",
693
694
695
                self.module_name,
                self.class_name,
            )
696
697
            return None

698
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
699
700
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
701

702
703
704
705
706
707
708
709
        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()
710
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
711
712
713
714
715
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

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

720
721
        if model_path.exists():
            with open(model_path, "rb") as f:
722
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
723
724
725

            mi = self._load_modelinfo_from_cache(module_hash)
            if mi is not None:
726
                logger.debug(
727
                    "Loaded model info for class %s.%s from cache",
728
729
730
                    self.module_name,
                    self.class_name,
                )
731
732
                return mi
            else:
733
                logger.debug(
734
                    "Cache model info for class %s.%s miss. Loading model instead.",
735
736
737
                    self.module_name,
                    self.class_name,
                )
738
739
740

        # Performed in another process to avoid initializing CUDA
        mi = _run_in_subprocess(
741
742
743
744
745
            lambda: _ModelInfo.from_model_cls(self.load_model_cls())
        )
        logger.debug(
            "Loaded model info for class %s.%s", self.module_name, self.class_name
        )
746
747

        # save cache file
748
749
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
750
751

        return mi
752

753
    def load_model_cls(self) -> type[nn.Module]:
754
755
756
757
758
759
760
761
        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,
762
) -> type[nn.Module] | None:
763
    from vllm.platforms import current_platform
764

765
    current_platform.verify_model_arch(model_arch)
766
767
768
    try:
        return model.load_model_cls()
    except Exception:
769
        logger.exception("Error in loading model architecture '%s'", model_arch)
770
        return None
771
772


773
774
775
776
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
777
) -> _ModelInfo | None:
778
779
780
    try:
        return model.inspect_model_cls()
    except Exception:
781
        logger.exception("Error in inspecting model architecture '%s'", model_arch)
782
        return None
783
784


785
786
787
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
788
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
789

790
    def get_supported_archs(self) -> Set[str]:
791
        return self.models.keys()
792

793
794
795
    def register_model(
        self,
        model_arch: str,
796
        model_cls: type[nn.Module] | str,
797
    ) -> None:
798
799
800
        """
        Register an external model to be used in vLLM.

801
        `model_cls` can be either:
802

803
        - A [`torch.nn.Module`][] class directly referencing the model.
804
        - A string in the format `<module>:<class>` which can be used to
805
806
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
807
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
808
        """
809
810
811
812
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

813
        if model_arch in self.models:
814
815
            logger.warning(
                "Model architecture %s is already registered, and will be "
816
817
818
819
                "overwritten by the new model class %s.",
                model_arch,
                model_cls,
            )
820
821
822
823
824
825

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

827
            model = _LazyRegisteredModel(*split_str)
828
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
829
            model = _RegisteredModel.from_model_cls(model_cls)
830
        else:
831
832
833
834
            msg = (
                "`model_cls` should be a string or PyTorch model class, "
                f"not a {type(model_arch)}"
            )
835
            raise TypeError(msg)
836

837
        self.models[model_arch] = model
838

839
    def _raise_for_unsupported(self, architectures: list[str]):
840
        all_supported_archs = self.get_supported_archs()
841

842
843
844
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
845
846
                "to be inspected. Please check the logs for more details."
            )
847

848
849
850
851
852
853
854
855
        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 "
856
857
                    "use this model architecture."
                )
858

859
860
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
861
862
            f"Supported architectures: {all_supported_archs}"
        )
863

864
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
865
866
        if model_arch not in self.models:
            return None
867

868
        return _try_load_model_cls(model_arch, self.models[model_arch])
869

870
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
871
872
        if model_arch not in self.models:
            return None
873

874
875
876
877
878
879
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
880
    ) -> str | None:
881
882
883
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

884
885
886
        auto_map: dict[str, str] = (
            getattr(model_config.hf_config, "auto_map", None) or dict()
        )
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902

        # 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,
903
                        trust_remote_code=model_config.trust_remote_code,
904
905
906
907
908
909
910
911
912
913
914
915
                        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,
916
                        trust_remote_code=model_config.trust_remote_code,
917
918
919
920
921
                        warn_on_fail=True,
                    )
                    if model_module is not None:
                        break
            else:
922
                if model_config.model_impl != "transformers":
923
924
925
926
927
928
929
                    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 "
930
931
                    "'auto_map' (relevant if the model is custom)."
                )
932
933

        if not model_module.is_backend_compatible():
934
            if model_config.model_impl != "transformers":
935
                return None
936

937
938
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
939
940
                "is not compatible with vLLM."
            )
941

942
        return model_config._get_transformers_backend_cls()
943

944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
    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
969

970
971
    def inspect_model_cls(
        self,
972
        architectures: str | list[str],
973
        model_config: ModelConfig,
974
    ) -> tuple[_ModelInfo, str]:
975
976
        if isinstance(architectures, str):
            architectures = [architectures]
977
978
        if not architectures:
            raise ValueError("No model architectures are specified")
979
980

        # Require transformers impl
981
        if model_config.model_impl == "transformers":
982
            arch = self._try_resolve_transformers(architectures[0], model_config)
983
984
985
986
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)
987
        elif model_config.model_impl == "terratorch":
988
989
            model_info = self._try_inspect_model_cls("Terratorch")
            return (model_info, "Terratorch")
990

991
        # Fallback to transformers impl (after resolving convert_type)
992
993
994
995
996
997
        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)
998
999
1000
1001
1002
1003
1004
            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)
1005
            model_info = self._try_inspect_model_cls(normalized_arch)
1006
            if model_info is not None:
1007
                return (model_info, arch)
1008

1009
        # Fallback to transformers impl (before resolving runner_type)
1010
1011
1012
1013
1014
        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)
1015
1016
1017
1018
1019
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)

1020
        return self._raise_for_unsupported(architectures)
1021

1022
1023
    def resolve_model_cls(
        self,
1024
        architectures: str | list[str],
1025
        model_config: ModelConfig,
1026
    ) -> tuple[type[nn.Module], str]:
1027
1028
        if isinstance(architectures, str):
            architectures = [architectures]
1029
1030
        if not architectures:
            raise ValueError("No model architectures are specified")
1031
1032

        # Require transformers impl
1033
        if model_config.model_impl == "transformers":
1034
            arch = self._try_resolve_transformers(architectures[0], model_config)
1035
1036
1037
1038
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)
1039
        elif model_config.model_impl == "terratorch":
1040
1041
1042
1043
            arch = "Terratorch"
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
1044

1045
        # Fallback to transformers impl (after resolving convert_type)
1046
1047
1048
1049
1050
1051
        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)
1052
1053
1054
1055
1056
1057
1058
            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)
1059
            model_cls = self._try_load_model_cls(normalized_arch)
1060
1061
            if model_cls is not None:
                return (model_cls, arch)
1062

1063
        # Fallback to transformers impl (before resolving runner_type)
1064
1065
1066
1067
1068
        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)
1069
1070
1071
1072
1073
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1074
        return self._raise_for_unsupported(architectures)
1075

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

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

1092
1093
    def is_cross_encoder_model(
        self,
1094
        architectures: str | list[str],
1095
        model_config: ModelConfig,
1096
    ) -> bool:
1097
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1098
        return model_cls.supports_cross_encoding
1099

1100
1101
    def is_multimodal_model(
        self,
1102
        architectures: str | list[str],
1103
        model_config: ModelConfig,
1104
    ) -> bool:
1105
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1106
        return model_cls.supports_multimodal
1107

1108
    def is_multimodal_raw_input_only_model(
1109
        self,
1110
        architectures: str | list[str],
1111
        model_config: ModelConfig,
1112
    ) -> bool:
1113
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1114
        return model_cls.supports_multimodal_raw_input_only
1115

1116
1117
    def is_pp_supported_model(
        self,
1118
        architectures: str | list[str],
1119
        model_config: ModelConfig,
1120
    ) -> bool:
1121
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1122
        return model_cls.supports_pp
1123

1124
1125
    def model_has_inner_state(
        self,
1126
        architectures: str | list[str],
1127
        model_config: ModelConfig,
1128
    ) -> bool:
1129
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1130
        return model_cls.has_inner_state
1131

1132
1133
    def is_attention_free_model(
        self,
1134
        architectures: str | list[str],
1135
        model_config: ModelConfig,
1136
    ) -> bool:
1137
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1138
        return model_cls.is_attention_free
1139

1140
1141
    def is_hybrid_model(
        self,
1142
        architectures: str | list[str],
1143
        model_config: ModelConfig,
1144
    ) -> bool:
1145
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1146
1147
        return model_cls.is_hybrid

1148
1149
    def is_noops_model(
        self,
1150
        architectures: str | list[str],
1151
        model_config: ModelConfig,
1152
    ) -> bool:
1153
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1154
1155
        return model_cls.has_noops

1156
1157
    def is_transcription_model(
        self,
1158
        architectures: str | list[str],
1159
        model_config: ModelConfig,
1160
    ) -> bool:
1161
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1162
1163
        return model_cls.supports_transcription

1164
1165
    def is_transcription_only_model(
        self,
1166
        architectures: str | list[str],
1167
        model_config: ModelConfig,
1168
    ) -> bool:
1169
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1170
1171
        return model_cls.supports_transcription_only

1172

1173
1174
1175
1176
1177
1178
1179
1180
1181
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()
    }
)
1182
1183
1184
1185
1186

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1187
1188
1189
1190
1191
    # 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")

1192
        # `cloudpickle` allows pickling lambda functions directly
1193
        import cloudpickle
1194

1195
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1196
1197
1198

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
1199
1200
1201
        returned = subprocess.run(
            _SUBPROCESS_COMMAND, input=input_bytes, capture_output=True
        )
1202
1203
1204
1205
1206
1207

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

1212
        with open(output_filepath, "rb") as f:
1213
1214
1215
1216
1217
1218
            return pickle.load(f)


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

1220
1221
1222
1223
1224
    load_general_plugins()

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

    result = fn()
1225
1226
1227

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1228
1229
1230


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