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

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

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

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

_SPECULATIVE_DECODING_MODELS = {
477
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
478
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
zhiweiz's avatar
zhiweiz committed
479
    "EagleLlama4ForCausalLM": ("llama4_eagle", "EagleLlama4ForCausalLM"),
480
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
481
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
482
    "LlamaForCausalLMEagle3": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
483
    "Eagle3Qwen2_5vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
484
    "Eagle3Qwen3vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
485
486
487
488
    "EagleMistralLarge3ForCausalLM": (
        "mistral_large_3_eagle",
        "EagleMistralLarge3ForCausalLM",
    ),
489
    "EagleDeepSeekMTPModel": ("deepseek_eagle", "EagleDeepseekV3ForCausalLM"),
490
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
491
    "ErnieMTPModel": ("ernie_mtp", "ErnieMTP"),
Kyungmin Lee's avatar
Kyungmin Lee committed
492
    "ExaoneMoeMTP": ("exaone_moe_mtp", "ExaoneMoeMTP"),
XuruiYang's avatar
XuruiYang committed
493
    "LongCatFlashMTPModel": ("longcat_flash_mtp", "LongCatFlashMTP"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
494
    "Glm4MoeMTPModel": ("glm4_moe_mtp", "Glm4MoeMTP"),
495
    "Glm4MoeLiteMTPModel": ("glm4_moe_lite_mtp", "Glm4MoeLiteMTP"),
496
    "GlmOcrMTPModel": ("glm_ocr_mtp", "GlmOcrMTP"),
497
    "MedusaModel": ("medusa", "Medusa"),
498
    "OpenPanguMTPModel": ("openpangu_mtp", "OpenPanguMTP"),
499
    "Qwen3NextMTP": ("qwen3_next_mtp", "Qwen3NextMTP"),
csy0225's avatar
csy0225 committed
500
    "Step3p5MTP": ("step3p5_mtp", "Step3p5MTP"),
501
502
503
    # Temporarily disabled.
    # # TODO(woosuk): Re-enable this once the MLP Speculator is supported in V1.
    # "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
504
}
505

506
_TRANSFORMERS_SUPPORTED_MODELS = {
507
508
509
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
510
511
512
513
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
514
515
516
}

_TRANSFORMERS_BACKEND_MODELS = {
517
    # Text generation models
518
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
    "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
537
    "TransformersForSequenceClassification": (
538
        "transformers",
539
        "TransformersForSequenceClassification",
540
    ),
541
    "TransformersMoEForSequenceClassification": (
542
        "transformers",
543
        "TransformersMoEForSequenceClassification",
544
    ),
545
546
547
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
548
    ),
549
}
550

551
_VLLM_MODELS = {
552
    **_TEXT_GENERATION_MODELS,
553
    **_EMBEDDING_MODELS,
554
    **_CROSS_ENCODER_MODELS,
555
    **_MULTIMODAL_MODELS,
556
    **_SPECULATIVE_DECODING_MODELS,
557
558
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
559
560
}

561
562
563
564
# 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.
565
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
566

567
_PREVIOUSLY_SUPPORTED_MODELS = {
568
    "MotifForCausalLM": "0.10.2",
569
    "Phi3SmallForCausalLM": "0.9.2",
570
    "Phi4FlashForCausalLM": "0.10.2",
571
    "Phi4MultimodalForCausalLM": "0.12.0",
572
573
574
575
576
577
578
579
580
    # 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",
}
581

582

583
584
@dataclass(frozen=True)
class _ModelInfo:
585
    architecture: str
586
    is_text_generation_model: bool
587
    is_pooling_model: bool
588
    attn_type: AttnTypeStr
589
590
    default_seq_pooling_type: SequencePoolingType
    default_tok_pooling_type: TokenPoolingType
591
    supports_cross_encoding: bool
592
    supports_multimodal: bool
593
    supports_multimodal_raw_input_only: bool
Patrick von Platen's avatar
Patrick von Platen committed
594
    requires_raw_input_tokens: bool
595
    supports_multimodal_encoder_tp_data: bool
596
    supports_pp: bool
597
598
    has_inner_state: bool
    is_attention_free: bool
599
    is_hybrid: bool
600
    has_noops: bool
601
    supports_mamba_prefix_caching: bool
602
    supports_transcription: bool
603
    supports_transcription_only: bool
604
605

    @staticmethod
606
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
607
        return _ModelInfo(
608
            architecture=model.__name__,
609
            is_text_generation_model=is_text_generation_model(model),
610
            is_pooling_model=is_pooling_model(model),
611
612
            default_seq_pooling_type=get_default_seq_pooling_type(model),
            default_tok_pooling_type=get_default_tok_pooling_type(model),
613
            attn_type=get_attn_type(model),
614
            supports_cross_encoding=supports_cross_encoding(model),
615
            supports_multimodal=supports_multimodal(model),
616
617
618
            supports_multimodal_raw_input_only=supports_multimodal_raw_input_only(
                model
            ),
Patrick von Platen's avatar
Patrick von Platen committed
619
            requires_raw_input_tokens=requires_raw_input_tokens(model),
620
621
622
            supports_multimodal_encoder_tp_data=supports_multimodal_encoder_tp_data(
                model
            ),
623
            supports_pp=supports_pp(model),
624
625
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
626
            is_hybrid=is_hybrid(model),
627
            supports_mamba_prefix_caching=supports_mamba_prefix_caching(model),
628
            supports_transcription=supports_transcription(model),
629
630
631
            supports_transcription_only=(
                supports_transcription(model) and model.supports_transcription_only
            ),
632
            has_noops=has_noops(model),
633
        )
634
635


636
637
638
639
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
640

641
    @abstractmethod
642
    def load_model_cls(self) -> type[nn.Module]:
643
        raise NotImplementedError
644
645


646
647
648
649
650
651
652
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
653
    model_cls: type[nn.Module]
654
655

    @staticmethod
656
    def from_model_cls(model_cls: type[nn.Module]):
657
658
659
660
661
662
663
664
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

665
    def load_model_cls(self) -> type[nn.Module]:
666
667
668
669
670
671
672
673
        return self.model_cls


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

675
676
677
    module_name: str
    class_name: str

678
679
680
681
682
683
684
685
    @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"

686
    def _load_modelinfo_from_cache(self, module_hash: str) -> _ModelInfo | None:
687
688
        try:
            try:
689
                modelinfo_path = self._get_cache_dir() / self._get_cache_filename()
690
691
692
                with open(modelinfo_path, encoding="utf-8") as file:
                    mi_dict = json.load(file)
            except FileNotFoundError:
693
                logger.debug(
694
                    "Cached model info file for class %s.%s not found",
695
696
697
                    self.module_name,
                    self.class_name,
                )
698
699
700
                return None

            if mi_dict["hash"] != module_hash:
701
                logger.debug(
702
                    "Cached model info file for class %s.%s is stale",
703
704
705
                    self.module_name,
                    self.class_name,
                )
706
707
708
709
710
                return None

            # file not changed, use cached _ModelInfo properties
            return _ModelInfo(**mi_dict["modelinfo"])
        except Exception:
711
            logger.debug(
712
                "Cached model info for class %s.%s error. ",
713
714
715
                self.module_name,
                self.class_name,
            )
716
717
            return None

718
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
719
720
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
721

722
723
724
725
726
727
728
729
        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()
730
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
731
732
733
734
735
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

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

740
741
        if model_path.exists():
            with open(model_path, "rb") as f:
742
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
743
744
745

            mi = self._load_modelinfo_from_cache(module_hash)
            if mi is not None:
746
                logger.debug(
747
                    "Loaded model info for class %s.%s from cache",
748
749
750
                    self.module_name,
                    self.class_name,
                )
751
752
                return mi
            else:
753
                logger.debug(
754
                    "Cache model info for class %s.%s miss. Loading model instead.",
755
756
757
                    self.module_name,
                    self.class_name,
                )
758
759
760

        # Performed in another process to avoid initializing CUDA
        mi = _run_in_subprocess(
761
762
763
764
765
            lambda: _ModelInfo.from_model_cls(self.load_model_cls())
        )
        logger.debug(
            "Loaded model info for class %s.%s", self.module_name, self.class_name
        )
766
767

        # save cache file
768
769
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
770
771

        return mi
772

773
    def load_model_cls(self) -> type[nn.Module]:
774
775
776
777
778
779
780
781
        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,
782
) -> type[nn.Module] | None:
783
    from vllm.platforms import current_platform
784

785
    current_platform.verify_model_arch(model_arch)
786
787
788
    try:
        return model.load_model_cls()
    except Exception:
789
        logger.exception("Error in loading model architecture '%s'", model_arch)
790
        return None
791
792


793
794
795
796
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
797
) -> _ModelInfo | None:
798
799
800
    try:
        return model.inspect_model_cls()
    except Exception:
801
        logger.exception("Error in inspecting model architecture '%s'", model_arch)
802
        return None
803
804


805
806
807
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
808
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
809

810
    def get_supported_archs(self) -> Set[str]:
811
        return self.models.keys()
812

813
814
815
    def register_model(
        self,
        model_arch: str,
816
        model_cls: type[nn.Module] | str,
817
    ) -> None:
818
819
820
        """
        Register an external model to be used in vLLM.

821
        `model_cls` can be either:
822

823
        - A [`torch.nn.Module`][] class directly referencing the model.
824
        - A string in the format `<module>:<class>` which can be used to
825
826
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
827
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
828
        """
829
830
831
832
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

833
        if model_arch in self.models:
834
835
            logger.warning(
                "Model architecture %s is already registered, and will be "
836
837
838
839
                "overwritten by the new model class %s.",
                model_arch,
                model_cls,
            )
840
841
842
843
844
845

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

847
            model = _LazyRegisteredModel(*split_str)
848
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
849
            model = _RegisteredModel.from_model_cls(model_cls)
850
        else:
851
852
853
854
            msg = (
                "`model_cls` should be a string or PyTorch model class, "
                f"not a {type(model_arch)}"
            )
855
            raise TypeError(msg)
856

857
        self.models[model_arch] = model
858

859
    def _raise_for_unsupported(self, architectures: list[str]):
860
        all_supported_archs = self.get_supported_archs()
861

862
863
864
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
865
866
                "to be inspected. Please check the logs for more details."
            )
867

868
869
870
871
872
873
874
875
        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 "
876
877
                    "use this model architecture."
                )
878

879
880
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
881
882
            f"Supported architectures: {all_supported_archs}"
        )
883

884
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
885
886
        if model_arch not in self.models:
            return None
887

888
        return _try_load_model_cls(model_arch, self.models[model_arch])
889

890
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
891
892
        if model_arch not in self.models:
            return None
893

894
895
896
897
898
899
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
900
    ) -> str | None:
901
902
903
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

904
905
906
        auto_map: dict[str, str] = (
            getattr(model_config.hf_config, "auto_map", None) or dict()
        )
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922

        # 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,
923
                        trust_remote_code=model_config.trust_remote_code,
924
925
926
927
928
929
930
931
932
933
934
935
                        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,
936
                        trust_remote_code=model_config.trust_remote_code,
937
938
939
940
941
                        warn_on_fail=True,
                    )
                    if model_module is not None:
                        break
            else:
942
                if model_config.model_impl != "transformers":
943
944
945
946
947
948
949
                    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 "
950
951
                    "'auto_map' (relevant if the model is custom)."
                )
952
953

        if not model_module.is_backend_compatible():
954
            if model_config.model_impl != "transformers":
955
                return None
956

957
958
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
959
960
                "is not compatible with vLLM."
            )
961

962
        return model_config._get_transformers_backend_cls()
963

964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
    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
989

990
991
    def inspect_model_cls(
        self,
992
        architectures: str | list[str],
993
        model_config: ModelConfig,
994
    ) -> tuple[_ModelInfo, str]:
995
996
        if isinstance(architectures, str):
            architectures = [architectures]
997
998
        if not architectures:
            raise ValueError("No model architectures are specified")
999
1000

        # Require transformers impl
1001
        if model_config.model_impl == "transformers":
1002
            arch = self._try_resolve_transformers(architectures[0], model_config)
1003
1004
1005
1006
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)
1007
        elif model_config.model_impl == "terratorch":
1008
1009
            model_info = self._try_inspect_model_cls("Terratorch")
            return (model_info, "Terratorch")
1010

1011
        # Fallback to transformers impl (after resolving convert_type)
1012
1013
1014
1015
1016
1017
        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)
1018
1019
1020
1021
1022
1023
1024
            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)
1025
            model_info = self._try_inspect_model_cls(normalized_arch)
1026
            if model_info is not None:
1027
                return (model_info, arch)
1028

1029
        # Fallback to transformers impl (before resolving runner_type)
1030
1031
1032
1033
1034
        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)
1035
1036
1037
1038
1039
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)

1040
        return self._raise_for_unsupported(architectures)
1041

1042
1043
    def resolve_model_cls(
        self,
1044
        architectures: str | list[str],
1045
        model_config: ModelConfig,
1046
    ) -> tuple[type[nn.Module], str]:
1047
1048
        if isinstance(architectures, str):
            architectures = [architectures]
1049
1050
        if not architectures:
            raise ValueError("No model architectures are specified")
1051
1052

        # Require transformers impl
1053
        if model_config.model_impl == "transformers":
1054
            arch = self._try_resolve_transformers(architectures[0], model_config)
1055
1056
1057
1058
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)
1059
        elif model_config.model_impl == "terratorch":
1060
1061
1062
1063
            arch = "Terratorch"
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
1064

1065
        # Fallback to transformers impl (after resolving convert_type)
1066
1067
1068
1069
1070
1071
        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)
1072
1073
1074
1075
1076
1077
1078
            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)
1079
            model_cls = self._try_load_model_cls(normalized_arch)
1080
1081
            if model_cls is not None:
                return (model_cls, arch)
1082

1083
        # Fallback to transformers impl (before resolving runner_type)
1084
1085
1086
1087
1088
        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)
1089
1090
1091
1092
1093
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1094
        return self._raise_for_unsupported(architectures)
1095

1096
1097
    def is_text_generation_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.is_text_generation_model
1103

1104
    def is_pooling_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.is_pooling_model
1111

1112
1113
    def is_cross_encoder_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_cross_encoding
1119

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

1128
    def is_multimodal_raw_input_only_model(
1129
        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.supports_multimodal_raw_input_only
1135

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

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

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

1160
1161
    def is_hybrid_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.is_hybrid

1168
1169
    def is_noops_model(
        self,
1170
        architectures: str | list[str],
1171
        model_config: ModelConfig,
1172
    ) -> bool:
1173
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1174
1175
        return model_cls.has_noops

1176
1177
    def is_transcription_model(
        self,
1178
        architectures: str | list[str],
1179
        model_config: ModelConfig,
1180
    ) -> bool:
1181
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1182
1183
        return model_cls.supports_transcription

1184
1185
    def is_transcription_only_model(
        self,
1186
        architectures: str | list[str],
1187
        model_config: ModelConfig,
1188
    ) -> bool:
1189
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1190
1191
        return model_cls.supports_transcription_only

1192

1193
1194
1195
1196
1197
1198
1199
1200
1201
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()
    }
)
1202
1203
1204
1205
1206

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1207
1208
1209
1210
1211
    # 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")

1212
        # `cloudpickle` allows pickling lambda functions directly
1213
        import cloudpickle
1214

1215
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1216
1217
1218

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
1219
1220
1221
        returned = subprocess.run(
            _SUBPROCESS_COMMAND, input=input_bytes, capture_output=True
        )
1222
1223
1224
1225
1226
1227

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

1232
        with open(output_filepath, "rb") as f:
1233
1234
1235
1236
1237
1238
            return pickle.load(f)


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

1240
1241
1242
1243
1244
    load_general_plugins()

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

    result = fn()
1245
1246
1247

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1248
1249
1250


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