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

_SPECULATIVE_DECODING_MODELS = {
468
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
469
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
zhiweiz's avatar
zhiweiz committed
470
    "EagleLlama4ForCausalLM": ("llama4_eagle", "EagleLlama4ForCausalLM"),
471
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
472
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
473
    "LlamaForCausalLMEagle3": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
474
    "Eagle3Qwen2_5vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
475
    "Eagle3Qwen3vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
476
477
478
479
    "EagleMistralLarge3ForCausalLM": (
        "mistral_large_3_eagle",
        "EagleMistralLarge3ForCausalLM",
    ),
480
    "EagleDeepSeekMTPModel": ("deepseek_eagle", "EagleDeepseekV3ForCausalLM"),
481
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
482
    "ErnieMTPModel": ("ernie_mtp", "ErnieMTP"),
Kyungmin Lee's avatar
Kyungmin Lee committed
483
    "ExaoneMoeMTP": ("exaone_moe_mtp", "ExaoneMoeMTP"),
zhuwenwen's avatar
zhuwenwen committed
484
    "LongCatFlashMTPModel": ("longcat_flash_mtp", "LongCatFlashMTP"),
zhuwenwen's avatar
zhuwenwen committed
485
    "Glm4MoeMTPModel": ("glm4_moe_mtp", "Glm4MoeMTP"),
486
    "Glm4MoeLiteMTPModel": ("glm4_moe_lite_mtp", "Glm4MoeLiteMTP"),
487
    "MedusaModel": ("medusa", "Medusa"),
488
    "OpenPanguMTPModel": ("openpangu_mtp", "OpenPanguMTP"),
489
    "Qwen3NextMTP": ("qwen3_next_mtp", "Qwen3NextMTP"),
csy0225's avatar
csy0225 committed
490
    "Step3p5MTP": ("step3p5_mtp", "Step3p5MTP"),
Rayyyyy's avatar
Rayyyyy committed
491
492
    "Qwen3_5MTP": ("qwen3_5_mtp", "Qwen3_5MTP"),
    "Qwen3_5MoeMTP": ("qwen3_5_mtp", "Qwen3_5MoeMTP"),
493
494
495
    # Temporarily disabled.
    # # TODO(woosuk): Re-enable this once the MLP Speculator is supported in V1.
    # "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
496
}
497

498
_TRANSFORMERS_SUPPORTED_MODELS = {
499
500
501
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
502
503
504
505
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
506
507
508
}

_TRANSFORMERS_BACKEND_MODELS = {
509
    # Text generation models
510
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
    "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
529
    "TransformersForSequenceClassification": (
530
        "transformers",
531
        "TransformersForSequenceClassification",
532
    ),
533
    "TransformersMoEForSequenceClassification": (
534
        "transformers",
535
        "TransformersMoEForSequenceClassification",
536
    ),
537
538
539
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
540
    ),
541
}
542

543
_VLLM_MODELS = {
544
    **_TEXT_GENERATION_MODELS,
545
    **_EMBEDDING_MODELS,
546
    **_CROSS_ENCODER_MODELS,
547
    **_MULTIMODAL_MODELS,
548
    **_SPECULATIVE_DECODING_MODELS,
549
550
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
551
552
}

553
554
555
556
# 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.
557
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
558

559
_PREVIOUSLY_SUPPORTED_MODELS = {
560
    "MotifForCausalLM": "0.10.2",
561
    "Phi3SmallForCausalLM": "0.9.2",
562
    "Phi4FlashForCausalLM": "0.10.2",
563
    "Phi4MultimodalForCausalLM": "0.12.0",
564
565
566
567
568
569
570
571
572
    # 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",
}
573

574

575
576
@dataclass(frozen=True)
class _ModelInfo:
577
    architecture: str
578
    is_text_generation_model: bool
579
    is_pooling_model: bool
580
    attn_type: AttnTypeStr
581
582
    default_seq_pooling_type: SequencePoolingType
    default_tok_pooling_type: TokenPoolingType
583
    supports_cross_encoding: bool
584
    supports_multimodal: bool
585
    supports_multimodal_raw_input_only: bool
Patrick von Platen's avatar
Patrick von Platen committed
586
    requires_raw_input_tokens: bool
587
    supports_multimodal_encoder_tp_data: bool
588
    supports_pp: bool
589
590
    has_inner_state: bool
    is_attention_free: bool
591
    is_hybrid: bool
592
    has_noops: bool
593
    supports_mamba_prefix_caching: bool
594
    supports_transcription: bool
595
    supports_transcription_only: bool
596
597

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


628
629
630
631
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
632

633
    @abstractmethod
634
    def load_model_cls(self) -> type[nn.Module]:
635
        raise NotImplementedError
636
637


638
639
640
641
642
643
644
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
645
    model_cls: type[nn.Module]
646
647

    @staticmethod
648
    def from_model_cls(model_cls: type[nn.Module]):
649
650
651
652
653
654
655
656
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

657
    def load_model_cls(self) -> type[nn.Module]:
658
659
660
661
662
663
664
665
        return self.model_cls


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

667
668
669
    module_name: str
    class_name: str

670
671
672
673
674
675
676
677
    @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"

678
    def _load_modelinfo_from_cache(self, module_hash: str) -> _ModelInfo | None:
679
680
        try:
            try:
681
                modelinfo_path = self._get_cache_dir() / self._get_cache_filename()
682
683
684
                with open(modelinfo_path, encoding="utf-8") as file:
                    mi_dict = json.load(file)
            except FileNotFoundError:
685
                logger.debug(
686
                    "Cached model info file for class %s.%s not found",
687
688
689
                    self.module_name,
                    self.class_name,
                )
690
691
692
                return None

            if mi_dict["hash"] != module_hash:
693
                logger.debug(
694
                    "Cached model info file for class %s.%s is stale",
695
696
697
                    self.module_name,
                    self.class_name,
                )
698
699
700
701
702
                return None

            # file not changed, use cached _ModelInfo properties
            return _ModelInfo(**mi_dict["modelinfo"])
        except Exception:
703
            logger.debug(
704
                "Cached model info for class %s.%s error. ",
705
706
707
                self.module_name,
                self.class_name,
            )
708
709
            return None

710
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
711
712
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
713

714
715
716
717
718
719
720
721
        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()
722
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
723
724
725
726
727
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

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

732
733
        if model_path.exists():
            with open(model_path, "rb") as f:
734
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
735
736
737

            mi = self._load_modelinfo_from_cache(module_hash)
            if mi is not None:
738
                logger.debug(
739
                    "Loaded model info for class %s.%s from cache",
740
741
742
                    self.module_name,
                    self.class_name,
                )
743
744
                return mi
            else:
745
                logger.debug(
746
                    "Cache model info for class %s.%s miss. Loading model instead.",
747
748
749
                    self.module_name,
                    self.class_name,
                )
750
751
752

        # Performed in another process to avoid initializing CUDA
        mi = _run_in_subprocess(
753
754
755
756
757
            lambda: _ModelInfo.from_model_cls(self.load_model_cls())
        )
        logger.debug(
            "Loaded model info for class %s.%s", self.module_name, self.class_name
        )
758
759

        # save cache file
760
761
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
762
763

        return mi
764

765
    def load_model_cls(self) -> type[nn.Module]:
766
767
768
769
770
771
772
773
        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,
774
) -> type[nn.Module] | None:
775
    from vllm.platforms import current_platform
776

777
    current_platform.verify_model_arch(model_arch)
778
779
780
    try:
        return model.load_model_cls()
    except Exception:
781
        logger.exception("Error in loading model architecture '%s'", model_arch)
782
        return None
783
784


785
786
787
788
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
789
) -> _ModelInfo | None:
790
791
792
    try:
        return model.inspect_model_cls()
    except Exception:
793
        logger.exception("Error in inspecting model architecture '%s'", model_arch)
794
        return None
795
796


797
798
799
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
800
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
801

802
    def get_supported_archs(self) -> Set[str]:
803
        return self.models.keys()
804

805
806
807
    def register_model(
        self,
        model_arch: str,
808
        model_cls: type[nn.Module] | str,
809
    ) -> None:
810
811
812
        """
        Register an external model to be used in vLLM.

813
        `model_cls` can be either:
814

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

825
        if model_arch in self.models:
826
827
            logger.warning(
                "Model architecture %s is already registered, and will be "
828
829
830
831
                "overwritten by the new model class %s.",
                model_arch,
                model_cls,
            )
832
833
834
835
836
837

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

839
            model = _LazyRegisteredModel(*split_str)
840
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
841
            model = _RegisteredModel.from_model_cls(model_cls)
842
        else:
843
844
845
846
            msg = (
                "`model_cls` should be a string or PyTorch model class, "
                f"not a {type(model_arch)}"
            )
847
            raise TypeError(msg)
848

849
        self.models[model_arch] = model
850

851
    def _raise_for_unsupported(self, architectures: list[str]):
852
        all_supported_archs = self.get_supported_archs()
853

854
855
856
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
857
858
                "to be inspected. Please check the logs for more details."
            )
859

860
861
862
863
864
865
866
867
        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 "
868
869
                    "use this model architecture."
                )
870

871
872
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
873
874
            f"Supported architectures: {all_supported_archs}"
        )
875

876
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
877
878
        if model_arch not in self.models:
            return None
879

880
        return _try_load_model_cls(model_arch, self.models[model_arch])
881

882
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
883
884
        if model_arch not in self.models:
            return None
885

886
887
888
889
890
891
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
892
    ) -> str | None:
893
894
895
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

896
897
898
        auto_map: dict[str, str] = (
            getattr(model_config.hf_config, "auto_map", None) or dict()
        )
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914

        # 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,
915
                        trust_remote_code=model_config.trust_remote_code,
916
917
918
919
920
921
922
923
924
925
926
927
                        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,
928
                        trust_remote_code=model_config.trust_remote_code,
929
930
931
932
933
                        warn_on_fail=True,
                    )
                    if model_module is not None:
                        break
            else:
934
                if model_config.model_impl != "transformers":
935
936
937
938
939
940
941
                    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 "
942
943
                    "'auto_map' (relevant if the model is custom)."
                )
944
945

        if not model_module.is_backend_compatible():
946
            if model_config.model_impl != "transformers":
947
                return None
948

949
950
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
951
952
                "is not compatible with vLLM."
            )
953

954
        return model_config._get_transformers_backend_cls()
955

956
    def _normalize_arch(
957
        self,
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
        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
973

974
975
976
977
978
            # 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
979

980
        return architecture
981

982
983
    def inspect_model_cls(
        self,
984
        architectures: str | list[str],
985
        model_config: ModelConfig,
986
    ) -> tuple[_ModelInfo, str]:
987
988
        if isinstance(architectures, str):
            architectures = [architectures]
989
990
        if not architectures:
            raise ValueError("No model architectures are specified")
991
992

        # Require transformers impl
993
        if model_config.model_impl == "transformers":
994
            arch = self._try_resolve_transformers(architectures[0], model_config)
995
996
997
998
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)
999
        elif model_config.model_impl == "terratorch":
1000
1001
            model_info = self._try_inspect_model_cls("Terratorch")
            return (model_info, "Terratorch")
1002

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

1015
        for arch in architectures:
1016
            normalized_arch = self._normalize_arch(arch, model_config)
1017
            model_info = self._try_inspect_model_cls(normalized_arch)
1018
            if model_info is not None:
1019
                return (model_info, arch)
1020

1021
        # Fallback to transformers impl (before resolving runner_type)
1022
1023
1024
1025
1026
        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)
1027
1028
1029
1030
1031
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)

1032
        return self._raise_for_unsupported(architectures)
1033

1034
1035
    def resolve_model_cls(
        self,
1036
        architectures: str | list[str],
1037
        model_config: ModelConfig,
1038
    ) -> tuple[type[nn.Module], str]:
1039
1040
        if isinstance(architectures, str):
            architectures = [architectures]
1041
1042
        if not architectures:
            raise ValueError("No model architectures are specified")
1043
1044

        # Require transformers impl
1045
        if model_config.model_impl == "transformers":
1046
            arch = self._try_resolve_transformers(architectures[0], model_config)
1047
1048
1049
1050
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)
1051
        elif model_config.model_impl == "terratorch":
1052
1053
1054
1055
            arch = "Terratorch"
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
1056

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

1069
        for arch in architectures:
1070
            normalized_arch = self._normalize_arch(arch, model_config)
1071
            model_cls = self._try_load_model_cls(normalized_arch)
1072
1073
            if model_cls is not None:
                return (model_cls, arch)
1074

1075
        # Fallback to transformers impl (before resolving runner_type)
1076
1077
1078
1079
1080
        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)
1081
1082
1083
1084
1085
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1086
        return self._raise_for_unsupported(architectures)
1087

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

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

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

1112
1113
    def is_multimodal_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_multimodal
1119

1120
    def is_multimodal_raw_input_only_model(
1121
        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_raw_input_only
1127

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

1136
1137
    def model_has_inner_state(
        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.has_inner_state
1143

1144
1145
    def is_attention_free_model(
        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.is_attention_free
1151

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

1160
1161
    def is_noops_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.has_noops

1168
1169
    def is_transcription_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.supports_transcription

1176
1177
    def is_transcription_only_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_only

1184

1185
1186
1187
1188
1189
1190
1191
1192
1193
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()
    }
)
1194
1195
1196
1197
1198

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1199
1200
1201
1202
1203
    # 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")

1204
        # `cloudpickle` allows pickling lambda functions directly
1205
        import cloudpickle
1206

1207
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1208
1209
1210

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
1211
1212
1213
        returned = subprocess.run(
            _SUBPROCESS_COMMAND, input=input_bytes, capture_output=True
        )
1214
1215
1216
1217
1218
1219

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

1224
        with open(output_filepath, "rb") as f:
1225
1226
1227
1228
1229
1230
            return pickle.load(f)


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

1232
1233
1234
1235
1236
    load_general_plugins()

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

    result = fn()
1237
1238
1239

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1240
1241
1242


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