registry.py 48.1 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"),
zhuwenwen's avatar
zhuwenwen 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
    "HunYuanForCausalLM": ("hunyuan", "HunYuanForCausalLM"),
131
    "HCXVisionForCausalLM": ("hyperclovax_vision", "HCXVisionForCausalLM"),
132
133
    "InternLMForCausalLM": ("llama", "LlamaForCausalLM"),
    "InternLM2ForCausalLM": ("internlm2", "InternLM2ForCausalLM"),
134
    "InternLM2VEForCausalLM": ("internlm2_ve", "InternLM2VEForCausalLM"),
135
    "InternLM3ForCausalLM": ("llama", "LlamaForCausalLM"),
136
137
    "IQuestCoderForCausalLM": ("llama", "LlamaForCausalLM"),
    "IQuestLoopCoderForCausalLM": ("iquest_loopcoder", "IQuestLoopCoderForCausalLM"),
138
    "JAISLMHeadModel": ("jais", "JAISLMHeadModel"),
139
    "Jais2ForCausalLM": ("jais2", "Jais2ForCausalLM"),
140
    "JambaForCausalLM": ("jamba", "JambaForCausalLM"),
141
    "KimiLinearForCausalLM": ("kimi_linear", "KimiLinearForCausalLM"),  # noqa: E501
142
    "Lfm2ForCausalLM": ("lfm2", "Lfm2ForCausalLM"),
Paul Pak's avatar
Paul Pak committed
143
    "Lfm2MoeForCausalLM": ("lfm2_moe", "Lfm2MoeForCausalLM"),
144
    "LlamaForCausalLM": ("llama", "LlamaForCausalLM"),
145
    "Llama4ForCausalLM": ("llama4", "Llama4ForCausalLM"),
146
147
    # For decapoda-research/llama-*
    "LLaMAForCausalLM": ("llama", "LlamaForCausalLM"),
zhuwenwen's avatar
zhuwenwen committed
148
    "LongcatFlashForCausalLM": ("longcat_flash", "LongcatFlashForCausalLM"),
149
    "MambaForCausalLM": ("mamba", "MambaForCausalLM"),
150
    "Mamba2ForCausalLM": ("mamba2", "Mamba2ForCausalLM"),
151
152
    "MiniCPMForCausalLM": ("minicpm", "MiniCPMForCausalLM"),
    "MiniCPM3ForCausalLM": ("minicpm3", "MiniCPM3ForCausalLM"),
153
154
155
    "MiniMaxForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxText01ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxM1ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
156
    "MiniMaxM2ForCausalLM": ("minimax_m2", "MiniMaxM2ForCausalLM"),
157
    "MistralForCausalLM": ("mistral", "MistralForCausalLM"),
158
    "MistralLarge3ForCausalLM": ("mistral_large_3", "MistralLarge3ForCausalLM"),
159
160
161
162
    "MixtralForCausalLM": ("mixtral", "MixtralForCausalLM"),
    # transformers's mpt class has lower case
    "MptForCausalLM": ("mpt", "MPTForCausalLM"),
    "MPTForCausalLM": ("mpt", "MPTForCausalLM"),
163
    "MiMoForCausalLM": ("mimo", "MiMoForCausalLM"),
164
    "MiMoV2FlashForCausalLM": ("mimo_v2_flash", "MiMoV2FlashForCausalLM"),
165
    "NemotronForCausalLM": ("nemotron", "NemotronForCausalLM"),
Luis Vega's avatar
Luis Vega committed
166
    "NemotronHForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
167
    "OlmoForCausalLM": ("olmo", "OlmoForCausalLM"),
168
    "Olmo2ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
169
    "Olmo3ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
170
171
172
    "OlmoeForCausalLM": ("olmoe", "OlmoeForCausalLM"),
    "OPTForCausalLM": ("opt", "OPTForCausalLM"),
    "OrionForCausalLM": ("orion", "OrionForCausalLM"),
173
    "OuroForCausalLM": ("ouro", "OuroForCausalLM"),
174
    "PanguEmbeddedForCausalLM": ("openpangu", "PanguEmbeddedForCausalLM"),
175
    "PanguProMoEV2ForCausalLM": ("openpangu", "PanguProMoEV2ForCausalLM"),
176
    "PanguUltraMoEForCausalLM": ("openpangu", "PanguUltraMoEForCausalLM"),
177
178
179
180
    "PersimmonForCausalLM": ("persimmon", "PersimmonForCausalLM"),
    "PhiForCausalLM": ("phi", "PhiForCausalLM"),
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
    "PhiMoEForCausalLM": ("phimoe", "PhiMoEForCausalLM"),
Shinichi Hemmi's avatar
Shinichi Hemmi committed
181
    "Plamo2ForCausalLM": ("plamo2", "Plamo2ForCausalLM"),
182
    "Plamo3ForCausalLM": ("plamo3", "Plamo3ForCausalLM"),
183
    "QWenLMHeadModel": ("qwen", "QWenLMHeadModel"),
184
185
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
    "Qwen2MoeForCausalLM": ("qwen2_moe", "Qwen2MoeForCausalLM"),
186
187
    "Qwen3ForCausalLM": ("qwen3", "Qwen3ForCausalLM"),
    "Qwen3MoeForCausalLM": ("qwen3_moe", "Qwen3MoeForCausalLM"),
188
    "RWForCausalLM": ("falcon", "FalconForCausalLM"),
189
    "SeedOssForCausalLM": ("seed_oss", "SeedOssForCausalLM"),
Li Xie's avatar
Li Xie committed
190
    "Step1ForCausalLM": ("step1", "Step1ForCausalLM"),
zhuwenwen's avatar
zhuwenwen committed
191
    "Step3TextForCausalLM": ("step3_text", "Step3TextForCausalLM"),
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
    # Technically Terratorch models work on images, both in
249
250
    # input and output. I am adding it here because it piggy-backs on embedding
    # 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
324
325
    "Glm4vForConditionalGeneration": ("glm4_1v", "Glm4vForConditionalGeneration"),
    "Glm4vMoeForConditionalGeneration": ("glm4_1v", "Glm4vMoeForConditionalGeneration"),
    "GlmOcrForConditionalGeneration": ("glm_ocr", "GlmOcrForConditionalGeneration"),  # noqa: E501
326
327
328
    "GraniteSpeechForConditionalGeneration": (
        "granite_speech",
        "GraniteSpeechForConditionalGeneration",
329
    ),
330
    "H2OVLChatModel": ("h2ovl", "H2OVLChatModel"),
331
332
333
334
    "HunYuanVLForConditionalGeneration": (
        "hunyuan_vision",
        "HunYuanVLForConditionalGeneration",
    ),
ltd0924's avatar
ltd0924 committed
335
    "StepVLForConditionalGeneration": ("step_vl", "StepVLForConditionalGeneration"),
336
    "InternVLChatModel": ("internvl", "InternVLChatModel"),
337
    "NemotronH_Nano_VL_V2": ("nano_nemotron_vl", "NemotronH_Nano_VL_V2"),
Zero's avatar
Zero committed
338
339
340
341
    "OpenCUAForConditionalGeneration": (
        "opencua",
        "OpenCUAForConditionalGeneration",
    ),
342
343
344
    "InternS1ForConditionalGeneration": (
        "interns1",
        "InternS1ForConditionalGeneration",
345
    ),
346
347
348
    "InternVLForConditionalGeneration": (
        "interns1",
        "InternS1ForConditionalGeneration",
349
    ),
350
351
352
353
    "Idefics3ForConditionalGeneration": (
        "idefics3",
        "Idefics3ForConditionalGeneration",
    ),
oscardev256's avatar
oscardev256 committed
354
    "IsaacForConditionalGeneration": ("isaac", "IsaacForConditionalGeneration"),
355
    "SmolVLMForConditionalGeneration": ("smolvlm", "SmolVLMForConditionalGeneration"),  # noqa: E501
356
    "KananaVForConditionalGeneration": ("kanana_v", "KananaVForConditionalGeneration"),
357
    "KeyeForConditionalGeneration": ("keye", "KeyeForConditionalGeneration"),
358
359
360
    "KeyeVL1_5ForConditionalGeneration": (
        "keye_vl1_5",
        "KeyeVL1_5ForConditionalGeneration",
361
    ),
362
    "RForConditionalGeneration": ("rvl", "RForConditionalGeneration"),
363
    "KimiVLForConditionalGeneration": ("kimi_vl", "KimiVLForConditionalGeneration"),  # noqa: E501
Roger Wang's avatar
Roger Wang committed
364
    "KimiK25ForConditionalGeneration": ("kimi_k25", "KimiK25ForConditionalGeneration"),  # noqa: E501
365
366
367
368
    "LightOnOCRForConditionalGeneration": (
        "lightonocr",
        "LightOnOCRForConditionalGeneration",
    ),
369
    "Lfm2VlForConditionalGeneration": ("lfm2_vl", "Lfm2VLForConditionalGeneration"),
370
    "Llama_Nemotron_Nano_VL": ("nemotron_vl", "LlamaNemotronVLChatModel"),
371
    "Llama4ForConditionalGeneration": ("mllama4", "Llama4ForConditionalGeneration"),  # noqa: E501
372
    "LlavaForConditionalGeneration": ("llava", "LlavaForConditionalGeneration"),
373
374
375
    "LlavaNextForConditionalGeneration": (
        "llava_next",
        "LlavaNextForConditionalGeneration",
376
    ),
377
378
379
    "LlavaNextVideoForConditionalGeneration": (
        "llava_next_video",
        "LlavaNextVideoForConditionalGeneration",
380
    ),
381
382
383
    "LlavaOnevisionForConditionalGeneration": (
        "llava_onevision",
        "LlavaOnevisionForConditionalGeneration",
384
    ),
385
    "MantisForConditionalGeneration": ("llava", "MantisForConditionalGeneration"),  # noqa: E501
386
    "MiDashengLMModel": ("midashenglm", "MiDashengLMModel"),
387
388
389
    "MiniMaxVL01ForConditionalGeneration": (
        "minimax_vl_01",
        "MiniMaxVL01ForConditionalGeneration",
390
    ),
391
    "MiniCPMO": ("minicpmo", "MiniCPMO"),
392
    "MiniCPMV": ("minicpmv", "MiniCPMV"),
393
394
395
    "Mistral3ForConditionalGeneration": (
        "mistral3",
        "Mistral3ForConditionalGeneration",
396
    ),
397
    "MolmoForCausalLM": ("molmo", "MolmoForCausalLM"),
398
    "Molmo2ForConditionalGeneration": ("molmo2", "Molmo2ForConditionalGeneration"),
399
    "NVLM_D": ("nvlm_d", "NVLM_D_Model"),
400
    "Ovis": ("ovis", "Ovis"),
401
    "Ovis2_5": ("ovis2_5", "Ovis2_5"),
402
403
404
405
    "PaddleOCRVLForConditionalGeneration": (
        "paddleocr_vl",
        "PaddleOCRVLForConditionalGeneration",
    ),
406
407
408
409
    "PaliGemmaForConditionalGeneration": (
        "paligemma",
        "PaliGemmaForConditionalGeneration",
    ),
410
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
411
    "Phi4MMForCausalLM": ("phi4mm", "Phi4MMForCausalLM"),
412
    "PixtralForConditionalGeneration": ("pixtral", "PixtralForConditionalGeneration"),  # noqa: E501
413
    "QwenVLForConditionalGeneration": ("qwen_vl", "QwenVLForConditionalGeneration"),  # noqa: E501
414
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
415
416
417
    "Qwen2_5_VLForConditionalGeneration": (
        "qwen2_5_vl",
        "Qwen2_5_VLForConditionalGeneration",
418
    ),
419
420
421
    "Qwen2AudioForConditionalGeneration": (
        "qwen2_audio",
        "Qwen2AudioForConditionalGeneration",
422
    ),
423
424
425
    "Qwen2_5OmniModel": (
        "qwen2_5_omni_thinker",
        "Qwen2_5OmniThinkerForConditionalGeneration",
426
    ),
427
428
429
    "Qwen2_5OmniForConditionalGeneration": (
        "qwen2_5_omni_thinker",
        "Qwen2_5OmniThinkerForConditionalGeneration",
430
    ),
431
432
433
434
    "Qwen3OmniMoeForConditionalGeneration": (
        "qwen3_omni_moe_thinker",
        "Qwen3OmniMoeThinkerForConditionalGeneration",
    ),
435
    "Qwen3VLForConditionalGeneration": ("qwen3_vl", "Qwen3VLForConditionalGeneration"),  # noqa: E501
436
437
438
    "Qwen3VLMoeForConditionalGeneration": (
        "qwen3_vl_moe",
        "Qwen3VLMoeForConditionalGeneration",
439
    ),
440
    "SkyworkR1VChatModel": ("skyworkr1v", "SkyworkR1VChatModel"),
zhuwenwen's avatar
zhuwenwen committed
441
    "Step3VLForConditionalGeneration": ("step3_vl", "Step3VLForConditionalGeneration"),  # noqa: E501
汪志鹏's avatar
汪志鹏 committed
442
    "TarsierForConditionalGeneration": ("tarsier", "TarsierForConditionalGeneration"),  # noqa: E501
443
444
445
    "Tarsier2ForConditionalGeneration": (
        "qwen2_vl",
        "Tarsier2ForConditionalGeneration",
446
    ),
447
    "UltravoxModel": ("ultravox", "UltravoxModel"),
Patrick von Platen's avatar
Patrick von Platen committed
448
    "VoxtralForConditionalGeneration": ("voxtral", "VoxtralForConditionalGeneration"),  # noqa: E501
Patrick von Platen's avatar
Patrick von Platen committed
449
    "VoxtralStreamingGeneration": ("voxtral_streaming", "VoxtralStreamingGeneration"),  # noqa: E501
450
    # [Encoder-decoder]
451
452
453
454
    "NemotronParseForConditionalGeneration": (
        "nemotron_parse",
        "NemotronParseForConditionalGeneration",
    ),
455
    "WhisperForConditionalGeneration": ("whisper", "WhisperForConditionalGeneration"),  # noqa: E501
456
}
457
458

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

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

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

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

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

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

563

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

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


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

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


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

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

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

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

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


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

656
657
658
    module_name: str
    class_name: str

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

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

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

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

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

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

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

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

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

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

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

        return mi
753

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

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


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


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

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

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

802
        `model_cls` can be either:
803

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

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

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

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

838
        self.models[model_arch] = model
839

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

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

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

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

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

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

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

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

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

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

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

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

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

943
        return model_config._get_transformers_backend_cls()
944

945
    def _normalize_arch(
946
        self,
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
        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
962

963
964
965
966
967
            # 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
968

969
        return architecture
970

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

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

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

1004
        for arch in architectures:
1005
            normalized_arch = self._normalize_arch(arch, model_config)
1006
            model_info = self._try_inspect_model_cls(normalized_arch)
1007
            if model_info is not None:
1008
                return (model_info, arch)
1009

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

1021
        return self._raise_for_unsupported(architectures)
1022

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

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

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

1058
        for arch in architectures:
1059
            normalized_arch = self._normalize_arch(arch, model_config)
1060
            model_cls = self._try_load_model_cls(normalized_arch)
1061
1062
            if model_cls is not None:
                return (model_cls, arch)
1063

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

1075
        return self._raise_for_unsupported(architectures)
1076

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

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

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

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

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

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

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

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

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

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

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

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

1173

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

_T = TypeVar("_T")


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

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

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

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

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

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


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

1221
1222
1223
1224
1225
    load_general_plugins()

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

    result = fn()
1226
1227
1228

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


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