registry.py 47.8 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"),
191
192
193
194
    "StableLMEpochForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "StableLmForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "Starcoder2ForCausalLM": ("starcoder2", "Starcoder2ForCausalLM"),
    "SolarForCausalLM": ("solar", "SolarForCausalLM"),
195
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
196
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
197
    "TeleFLMForCausalLM": ("teleflm", "TeleFLMForCausalLM"),
198
    "XverseForCausalLM": ("llama", "LlamaForCausalLM"),
199
    "Zamba2ForCausalLM": ("zamba2", "Zamba2ForCausalLM"),
200
201
202
}

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

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

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

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

482
_TRANSFORMERS_SUPPORTED_MODELS = {
483
484
485
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
486
487
488
489
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
490
491
492
}

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

527
_VLLM_MODELS = {
528
    **_TEXT_GENERATION_MODELS,
529
    **_EMBEDDING_MODELS,
530
    **_CROSS_ENCODER_MODELS,
531
    **_MULTIMODAL_MODELS,
532
    **_SPECULATIVE_DECODING_MODELS,
533
534
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
535
536
}

537
538
539
540
# 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.
541
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
542

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

558

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

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


612
613
614
615
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
616

617
    @abstractmethod
618
    def load_model_cls(self) -> type[nn.Module]:
619
        raise NotImplementedError
620
621


622
623
624
625
626
627
628
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
629
    model_cls: type[nn.Module]
630
631

    @staticmethod
632
    def from_model_cls(model_cls: type[nn.Module]):
633
634
635
636
637
638
639
640
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

641
    def load_model_cls(self) -> type[nn.Module]:
642
643
644
645
646
647
648
649
        return self.model_cls


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

651
652
653
    module_name: str
    class_name: str

654
655
656
657
658
659
660
661
    @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"

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

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

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

694
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
695
696
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
697

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

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

716
717
        if model_path.exists():
            with open(model_path, "rb") as f:
718
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
719
720
721

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

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

        # save cache file
744
745
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
746
747

        return mi
748

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

761
    current_platform.verify_model_arch(model_arch)
762
763
764
    try:
        return model.load_model_cls()
    except Exception:
765
        logger.exception("Error in loading model architecture '%s'", model_arch)
766
        return None
767
768


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


781
782
783
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
784
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
785

786
    def get_supported_archs(self) -> Set[str]:
787
        return self.models.keys()
788

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

797
        `model_cls` can be either:
798

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

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

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

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

833
        self.models[model_arch] = model
834

835
    def _raise_for_unsupported(self, architectures: list[str]):
836
        all_supported_archs = self.get_supported_archs()
837

838
839
840
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
841
842
                "to be inspected. Please check the logs for more details."
            )
843

844
845
846
847
848
849
850
851
        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 "
852
853
                    "use this model architecture."
                )
854

855
856
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
857
858
            f"Supported architectures: {all_supported_archs}"
        )
859

860
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
861
862
        if model_arch not in self.models:
            return None
863

864
        return _try_load_model_cls(model_arch, self.models[model_arch])
865

866
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
867
868
        if model_arch not in self.models:
            return None
869

870
871
872
873
874
875
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
876
    ) -> str | None:
877
878
879
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

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

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

        if not model_module.is_backend_compatible():
930
            if model_config.model_impl != "transformers":
931
                return None
932

933
934
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
935
936
                "is not compatible with vLLM."
            )
937

938
        return model_config._get_transformers_backend_cls()
939

940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
    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
965

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

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

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

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

1016
        return self._raise_for_unsupported(architectures)
1017

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

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

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

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

1070
        return self._raise_for_unsupported(architectures)
1071

1072
1073
    def is_text_generation_model(
        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_text_generation_model
1079

1080
    def is_pooling_model(
1081
        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.is_pooling_model
1087

1088
1089
    def is_cross_encoder_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_cross_encoding
1095

1096
1097
    def is_multimodal_model(
        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
1103

1104
    def is_multimodal_raw_input_only_model(
1105
        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_multimodal_raw_input_only
1111

1112
1113
    def is_pp_supported_model(
        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.supports_pp
1119

1120
1121
    def model_has_inner_state(
        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.has_inner_state
1127

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

1136
1137
    def is_hybrid_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.is_hybrid

1144
1145
    def is_noops_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.has_noops

1152
1153
    def is_transcription_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

1160
1161
    def is_transcription_only_model(
        self,
1162
        architectures: str | list[str],
1163
        model_config: ModelConfig,
1164
    ) -> bool:
1165
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1166
1167
        return model_cls.supports_transcription_only

1168

1169
1170
1171
1172
1173
1174
1175
1176
1177
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()
    }
)
1178
1179
1180
1181
1182

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1183
1184
1185
1186
1187
    # 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")

1188
        # `cloudpickle` allows pickling lambda functions directly
1189
        import cloudpickle
1190

1191
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1192
1193
1194

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

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

1208
        with open(output_filepath, "rb") as f:
1209
1210
1211
1212
1213
1214
            return pickle.load(f)


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

1216
1217
1218
1219
1220
    load_general_plugins()

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

    result = fn()
1221
1222
1223

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1224
1225
1226


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