registry.py 51.1 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3
4
5
6
"""
Whenever you add an architecture to this page, please also update
`tests/models/registry.py` with example HuggingFace models for it.
"""
7

8
import importlib
9
import json
10
import os
11
import pickle
12
13
import subprocess
import sys
14
import tempfile
15
from abc import ABC, abstractmethod
16
from collections.abc import Callable, Set
17
from dataclasses import asdict, dataclass, field
18
from functools import lru_cache
19
from pathlib import Path
20
from typing import TYPE_CHECKING, Any, TypeVar
21
22

import torch.nn as nn
23
import transformers
24

25
from vllm import envs
26
27
28
29
30
from vllm.config import (
    ModelConfig,
    iter_architecture_defaults,
    try_match_architecture_defaults,
)
31
from vllm.logger import init_logger
32
from vllm.logging_utils import logtime
33
from vllm.tasks import ScoreType
34
from vllm.transformers_utils.dynamic_module import try_get_class_from_dynamic_module
35
from vllm.utils.hashing import safe_hash
36

37
38
if TYPE_CHECKING:
    from vllm.config.model import AttnTypeStr
39
    from vllm.config.pooler import SequencePoolingType, TokenPoolingType
40
41
else:
    AttnTypeStr = Any
42
43
    SequencePoolingType = Any
    TokenPoolingType = Any
44
45


46
47
48
49
50
from .interfaces import (
    has_inner_state,
    has_noops,
    is_attention_free,
    is_hybrid,
Patrick von Platen's avatar
Patrick von Platen committed
51
    requires_raw_input_tokens,
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
    get_score_type,
64
65
66
    is_pooling_model,
    is_text_generation_model,
)
67
68
69

logger = init_logger(__name__)

70
71
_TEXT_GENERATION_MODELS = {
    # [Decoder-only]
72
    "AfmoeForCausalLM": ("afmoe", "AfmoeForCausalLM"),
73
    "ApertusForCausalLM": ("apertus", "ApertusForCausalLM"),
74
75
    "AquilaModel": ("llama", "LlamaForCausalLM"),
    "AquilaForCausalLM": ("llama", "LlamaForCausalLM"),  # AquilaChat2
Raghav Ravishankar's avatar
Raghav Ravishankar committed
76
    "ArceeForCausalLM": ("arcee", "ArceeForCausalLM"),
77
    "ArcticForCausalLM": ("arctic", "ArcticForCausalLM"),
78
    "AXK1ForCausalLM": ("AXK1", "AXK1ForCausalLM"),
79
80
81
82
    # baichuan-7b, upper case 'C' in the class name
    "BaiChuanForCausalLM": ("baichuan", "BaiChuanForCausalLM"),
    # baichuan-13b, lower case 'c' in the class name
    "BaichuanForCausalLM": ("baichuan", "BaichuanForCausalLM"),
83
    "BailingMoeForCausalLM": ("bailing_moe", "BailingMoeForCausalLM"),
ant-yy's avatar
ant-yy committed
84
    "BailingMoeV2ForCausalLM": ("bailing_moe", "BailingMoeV2ForCausalLM"),
Jiangyun Zhu's avatar
Jiangyun Zhu committed
85
    "BailingMoeV2_5ForCausalLM": ("bailing_moe_linear", "BailingMoeV25ForCausalLM"),
Yu Chin Fabian Lim's avatar
Yu Chin Fabian Lim committed
86
    "BambaForCausalLM": ("bamba", "BambaForCausalLM"),
87
    "BloomForCausalLM": ("bloom", "BloomForCausalLM"),
88
    "ChatGLMModel": ("chatglm", "ChatGLMForCausalLM"),
89
    "ChatGLMForConditionalGeneration": ("chatglm", "ChatGLMForCausalLM"),
90
    "CohereForCausalLM": ("commandr", "CohereForCausalLM"),
91
    "Cohere2ForCausalLM": ("commandr", "CohereForCausalLM"),
92
    "CwmForCausalLM": ("llama", "LlamaForCausalLM"),
93
    "DbrxForCausalLM": ("dbrx", "DbrxForCausalLM"),
94
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
95
    "DeepseekForCausalLM": ("deepseek_v2", "DeepseekForCausalLM"),
96
    "DeepseekV2ForCausalLM": ("deepseek_v2", "DeepseekV2ForCausalLM"),
97
    "DeepseekV3ForCausalLM": ("deepseek_v2", "DeepseekV3ForCausalLM"),
98
    "DeepseekV32ForCausalLM": ("deepseek_v2", "DeepseekV3ForCausalLM"),
99
    "Dots1ForCausalLM": ("dots1", "Dots1ForCausalLM"),
100
    "Ernie4_5ForCausalLM": ("ernie45", "Ernie4_5ForCausalLM"),
101
    "Ernie4_5_MoeForCausalLM": ("ernie45_moe", "Ernie4_5_MoeForCausalLM"),
102
    "ExaoneForCausalLM": ("exaone", "ExaoneForCausalLM"),
103
    "Exaone4ForCausalLM": ("exaone4", "Exaone4ForCausalLM"),
Kyungmin Lee's avatar
Kyungmin Lee committed
104
    "ExaoneMoEForCausalLM": ("exaone_moe", "ExaoneMoeForCausalLM"),
105
    "Fairseq2LlamaForCausalLM": ("fairseq2_llama", "Fairseq2LlamaForCausalLM"),
106
107
108
    "FalconForCausalLM": ("falcon", "FalconForCausalLM"),
    "FalconMambaForCausalLM": ("mamba", "MambaForCausalLM"),
    "FalconH1ForCausalLM": ("falcon_h1", "FalconH1ForCausalLM"),
109
    "FlexOlmoForCausalLM": ("flex_olmo", "FlexOlmoForCausalLM"),
110
111
    "GemmaForCausalLM": ("gemma", "GemmaForCausalLM"),
    "Gemma2ForCausalLM": ("gemma2", "Gemma2ForCausalLM"),
112
    "Gemma3ForCausalLM": ("gemma3", "Gemma3ForCausalLM"),
Nicolò Lucchesi's avatar
Nicolò Lucchesi committed
113
    "Gemma3nForCausalLM": ("gemma3n", "Gemma3nForCausalLM"),
114
    "Qwen3NextForCausalLM": ("qwen3_next", "Qwen3NextForCausalLM"),
115
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
116
    "Glm4ForCausalLM": ("glm4", "Glm4ForCausalLM"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
117
    "Glm4MoeForCausalLM": ("glm4_moe", "Glm4MoeForCausalLM"),
118
    "Glm4MoeLiteForCausalLM": ("glm4_moe_lite", "Glm4MoeLiteForCausalLM"),
Jee Jee Li's avatar
Jee Jee Li committed
119
    "GlmMoeDsaForCausalLM": ("deepseek_v2", "GlmMoeDsaForCausalLM"),
120
    "GptOssForCausalLM": ("gpt_oss", "GptOssForCausalLM"),
121
122
123
124
125
126
    "GPT2LMHeadModel": ("gpt2", "GPT2LMHeadModel"),
    "GPTBigCodeForCausalLM": ("gpt_bigcode", "GPTBigCodeForCausalLM"),
    "GPTJForCausalLM": ("gpt_j", "GPTJForCausalLM"),
    "GPTNeoXForCausalLM": ("gpt_neox", "GPTNeoXForCausalLM"),
    "GraniteForCausalLM": ("granite", "GraniteForCausalLM"),
    "GraniteMoeForCausalLM": ("granitemoe", "GraniteMoeForCausalLM"),
127
128
    "GraniteMoeHybridForCausalLM": ("granitemoehybrid", "GraniteMoeHybridForCausalLM"),  # noqa: E501
    "GraniteMoeSharedForCausalLM": ("granitemoeshared", "GraniteMoeSharedForCausalLM"),  # noqa: E501
129
    "GritLM": ("gritlm", "GritLM"),
Bijaya Dangol's avatar
Bijaya Dangol committed
130
131
    "Grok1ModelForCausalLM": ("grok1", "GrokForCausalLM"),
    "Grok1ForCausalLM": ("grok1", "GrokForCausalLM"),
132
133
    "HunYuanMoEV1ForCausalLM": ("hunyuan_v1", "HunYuanMoEV1ForCausalLM"),
    "HunYuanDenseV1ForCausalLM": ("hunyuan_v1", "HunYuanDenseV1ForCausalLM"),
134
    "HCXVisionForCausalLM": ("hyperclovax_vision", "HCXVisionForCausalLM"),
135
136
    "HCXVisionV2ForCausalLM": ("hyperclovax_vision_v2", "HCXVisionV2ForCausalLM"),
    "HyperCLOVAXForCausalLM": ("llama", "LlamaForCausalLM"),
137
138
    "InternLMForCausalLM": ("llama", "LlamaForCausalLM"),
    "InternLM2ForCausalLM": ("internlm2", "InternLM2ForCausalLM"),
139
    "InternLM2VEForCausalLM": ("internlm2_ve", "InternLM2VEForCausalLM"),
140
    "InternLM3ForCausalLM": ("llama", "LlamaForCausalLM"),
141
142
    "IQuestCoderForCausalLM": ("llama", "LlamaForCausalLM"),
    "IQuestLoopCoderForCausalLM": ("iquest_loopcoder", "IQuestLoopCoderForCausalLM"),
143
    "JAISLMHeadModel": ("jais", "JAISLMHeadModel"),
144
    "Jais2ForCausalLM": ("jais2", "Jais2ForCausalLM"),
145
    "JambaForCausalLM": ("jamba", "JambaForCausalLM"),
146
    "KimiLinearForCausalLM": ("kimi_linear", "KimiLinearForCausalLM"),  # noqa: E501
147
    "Lfm2ForCausalLM": ("lfm2", "Lfm2ForCausalLM"),
Paul Pak's avatar
Paul Pak committed
148
    "Lfm2MoeForCausalLM": ("lfm2_moe", "Lfm2MoeForCausalLM"),
149
    "LlamaForCausalLM": ("llama", "LlamaForCausalLM"),
150
    "Llama4ForCausalLM": ("llama4", "Llama4ForCausalLM"),
151
152
    # For decapoda-research/llama-*
    "LLaMAForCausalLM": ("llama", "LlamaForCausalLM"),
XuruiYang's avatar
XuruiYang committed
153
    "LongcatFlashForCausalLM": ("longcat_flash", "LongcatFlashForCausalLM"),
154
    "MambaForCausalLM": ("mamba", "MambaForCausalLM"),
155
    "Mamba2ForCausalLM": ("mamba2", "Mamba2ForCausalLM"),
156
157
    "MiniCPMForCausalLM": ("minicpm", "MiniCPMForCausalLM"),
    "MiniCPM3ForCausalLM": ("minicpm3", "MiniCPM3ForCausalLM"),
158
159
160
    "MiniMaxForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxText01ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxM1ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
161
    "MiniMaxM2ForCausalLM": ("minimax_m2", "MiniMaxM2ForCausalLM"),
162
    "MistralForCausalLM": ("mistral", "MistralForCausalLM"),
163
    "MistralLarge3ForCausalLM": ("mistral_large_3", "MistralLarge3ForCausalLM"),
164
165
166
167
    "MixtralForCausalLM": ("mixtral", "MixtralForCausalLM"),
    # transformers's mpt class has lower case
    "MptForCausalLM": ("mpt", "MPTForCausalLM"),
    "MPTForCausalLM": ("mpt", "MPTForCausalLM"),
168
    "MiMoForCausalLM": ("mimo", "MiMoForCausalLM"),
169
    "MiMoV2FlashForCausalLM": ("mimo_v2_flash", "MiMoV2FlashForCausalLM"),
170
    "NemotronForCausalLM": ("nemotron", "NemotronForCausalLM"),
Luis Vega's avatar
Luis Vega committed
171
    "NemotronHForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
172
    "NemotronHPuzzleForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
173
    "OlmoForCausalLM": ("olmo", "OlmoForCausalLM"),
174
    "Olmo2ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
175
    "Olmo3ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
176
    "OlmoHybridForCausalLM": ("olmo_hybrid", "OlmoHybridForCausalLM"),
177
178
179
    "OlmoeForCausalLM": ("olmoe", "OlmoeForCausalLM"),
    "OPTForCausalLM": ("opt", "OPTForCausalLM"),
    "OrionForCausalLM": ("orion", "OrionForCausalLM"),
180
    "OuroForCausalLM": ("ouro", "OuroForCausalLM"),
181
    "PanguEmbeddedForCausalLM": ("openpangu", "PanguEmbeddedForCausalLM"),
182
    "PanguProMoEV2ForCausalLM": ("openpangu", "PanguProMoEV2ForCausalLM"),
183
    "PanguUltraMoEForCausalLM": ("openpangu", "PanguUltraMoEForCausalLM"),
184
185
186
187
    "PersimmonForCausalLM": ("persimmon", "PersimmonForCausalLM"),
    "PhiForCausalLM": ("phi", "PhiForCausalLM"),
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
    "PhiMoEForCausalLM": ("phimoe", "PhiMoEForCausalLM"),
Shinichi Hemmi's avatar
Shinichi Hemmi committed
188
    "Plamo2ForCausalLM": ("plamo2", "Plamo2ForCausalLM"),
189
    "Plamo3ForCausalLM": ("plamo3", "Plamo3ForCausalLM"),
190
    "QWenLMHeadModel": ("qwen", "QWenLMHeadModel"),
191
192
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
    "Qwen2MoeForCausalLM": ("qwen2_moe", "Qwen2MoeForCausalLM"),
193
194
    "Qwen3ForCausalLM": ("qwen3", "Qwen3ForCausalLM"),
    "Qwen3MoeForCausalLM": ("qwen3_moe", "Qwen3MoeForCausalLM"),
195
    "RWForCausalLM": ("falcon", "FalconForCausalLM"),
196
197
    "SarvamMoEForCausalLM": ("sarvam", "SarvamMoEForCausalLM"),
    "SarvamMLAForCausalLM": ("sarvam", "SarvamMLAForCausalLM"),
198
    "SeedOssForCausalLM": ("seed_oss", "SeedOssForCausalLM"),
Li Xie's avatar
Li Xie committed
199
    "Step1ForCausalLM": ("step1", "Step1ForCausalLM"),
Song's avatar
Song committed
200
    "Step3TextForCausalLM": ("step3_text", "Step3TextForCausalLM"),
csy0225's avatar
csy0225 committed
201
    "Step3p5ForCausalLM": ("step3p5", "Step3p5ForCausalLM"),
202
203
204
205
    "StableLMEpochForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "StableLmForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "Starcoder2ForCausalLM": ("starcoder2", "Starcoder2ForCausalLM"),
    "SolarForCausalLM": ("solar", "SolarForCausalLM"),
206
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
207
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
208
    "TeleFLMForCausalLM": ("teleflm", "TeleFLMForCausalLM"),
209
    "XverseForCausalLM": ("llama", "LlamaForCausalLM"),
210
    "Zamba2ForCausalLM": ("zamba2", "Zamba2ForCausalLM"),
211
212
213
}

_EMBEDDING_MODELS = {
214
    # [Text-only]
215
    "BertModel": ("bert", "BertEmbeddingModel"),
216
    "BertSpladeSparseEmbeddingModel": ("bert", "BertSpladeSparseEmbeddingModel"),
217
    "BgeM3EmbeddingModel": ("roberta", "BgeM3EmbeddingModel"),
218
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
219
    "Gemma2Model": ("gemma2", "Gemma2ForCausalLM"),
220
    "Gemma3TextModel": ("gemma3", "Gemma3Model"),
221
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
222
    "GritLM": ("gritlm", "GritLM"),
223
224
    "GteModel": ("bert_with_rope", "SnowflakeGteNewModel"),
    "GteNewModel": ("bert_with_rope", "GteNewModel"),
225
    "LlamaBidirectionalModel": ("llama", "LlamaBidirectionalModel"),
226
    "LlamaModel": ("llama", "LlamaForCausalLM"),
227
228
    **{
        # Multiple models share the same architecture, so we include them all
229
230
        k: (mod, arch)
        for k, (mod, arch) in _TEXT_GENERATION_MODELS.items()
231
232
        if arch == "LlamaForCausalLM"
    },
233
    "MistralModel": ("llama", "LlamaForCausalLM"),
234
    "ModernBertModel": ("modernbert", "ModernBertModel"),
235
    "NomicBertModel": ("bert_with_rope", "NomicBertModel"),
236
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
237
    "Qwen2Model": ("qwen2", "Qwen2ForCausalLM"),
238
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
239
240
    "RobertaForMaskedLM": ("roberta", "RobertaEmbeddingModel"),
    "RobertaModel": ("roberta", "RobertaEmbeddingModel"),
241
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
242
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
chengchengpei's avatar
chengchengpei committed
243
244
245
246
    "VoyageQwen3BidirectionalEmbedModel": (
        "voyage",
        "VoyageQwen3BidirectionalEmbedModel",
    ),
247
    "XLMRobertaModel": ("roberta", "RobertaEmbeddingModel"),
248
    # [Multimodal]
249
    "CLIPModel": ("clip", "CLIPEmbeddingModel"),
250
251
252
    "LlavaNextForConditionalGeneration": (
        "llava_next",
        "LlavaNextForConditionalGeneration",
253
    ),
254
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
255
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
256
    "SiglipModel": ("siglip", "SiglipEmbeddingModel"),
257
258
259
260
    "LlamaNemotronVLModel": (
        "nemotron_vl",
        "LlamaNemotronVLForEmbedding",
    ),
261
262
    # Technically Terratorch models work on images, both in
    # input and output. I am adding it here because it piggy-backs on embedding
263
    # models for the time being.
264
265
    "PrithviGeoSpatialMAE": ("terratorch", "Terratorch"),
    "Terratorch": ("terratorch", "Terratorch"),
266
267
}

268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
_LATE_INTERACTION_MODELS = {
    # [Text-only]
    "HF_ColBERT": ("colbert", "ColBERTModel"),
    "ColBERTModernBertModel": ("colbert", "ColBERTModernBertModel"),
    "ColBERTJinaRobertaModel": ("colbert", "ColBERTJinaRobertaModel"),
    # [Multimodal]
    "ColModernVBertForRetrieval": ("colmodernvbert", "ColModernVBertForRetrieval"),
    "ColQwen3": ("colqwen3", "ColQwen3Model"),
    "OpsColQwen3Model": ("colqwen3", "ColQwen3Model"),
    "Qwen3VLNemotronEmbedModel": ("colqwen3", "ColQwen3Model"),
}

_REWARD_MODELS = {
    "InternLM2ForRewardModel": ("internlm2", "InternLM2ForRewardModel"),
    "Qwen2ForRewardModel": ("qwen2_rm", "Qwen2ForRewardModel"),
    "Qwen2ForProcessRewardModel": ("qwen2_rm", "Qwen2ForProcessRewardModel"),
}

_TOKEN_CLASSIFICATION_MODELS = {
287
    "BertForTokenClassification": ("bert", "BertForTokenClassification"),
288
289
290
291
292
293
294
295
296
    "ModernBertForTokenClassification": (
        "modernbert",
        "ModernBertForTokenClassification",
    ),
}

_SEQUENCE_CLASSIFICATION_MODELS = {
    "BertForSequenceClassification": ("bert", "BertForSequenceClassification"),
    "GPT2ForSequenceClassification": ("gpt2", "GPT2ForSequenceClassification"),
297
298
299
300
    "GteNewForSequenceClassification": (
        "bert_with_rope",
        "GteNewForSequenceClassification",
    ),
301
    "JambaForSequenceClassification": ("jamba", "JambaForSequenceClassification"),  # noqa: E501
302
303
304
    "LlamaBidirectionalForSequenceClassification": (
        "llama",
        "LlamaBidirectionalForSequenceClassification",
305
    ),
306
307
308
309
310
311
312
313
314
    "ModernBertForSequenceClassification": (
        "modernbert",
        "ModernBertForSequenceClassification",
    ),
    "RobertaForSequenceClassification": ("roberta", "RobertaForSequenceClassification"),
    "XLMRobertaForSequenceClassification": (
        "roberta",
        "RobertaForSequenceClassification",
    ),
315
316
317
318
319
320
    # [Multimodal]
    "JinaVLForRanking": ("jina_vl", "JinaVLForSequenceClassification"),
    "LlamaNemotronVLForSequenceClassification": (
        "nemotron_vl",
        "LlamaNemotronVLForSequenceClassification",
    ),
321
322
}

323
_MULTIMODAL_MODELS = {
324
    # [Decoder-only]
325
    "AriaForConditionalGeneration": ("aria", "AriaForConditionalGeneration"),
326
327
328
329
    "AudioFlamingo3ForConditionalGeneration": (
        "audioflamingo3",
        "AudioFlamingo3ForConditionalGeneration",
    ),
330
331
332
333
    "MusicFlamingoForConditionalGeneration": (
        "musicflamingo",
        "MusicFlamingoForConditionalGeneration",
    ),
334
335
336
    "AyaVisionForConditionalGeneration": (
        "aya_vision",
        "AyaVisionForConditionalGeneration",
337
    ),
338
    "BagelForConditionalGeneration": ("bagel", "BagelForConditionalGeneration"),
339
    "BeeForConditionalGeneration": ("bee", "BeeForConditionalGeneration"),
340
    "Blip2ForConditionalGeneration": ("blip2", "Blip2ForConditionalGeneration"),
341
342
343
    "ChameleonForConditionalGeneration": (
        "chameleon",
        "ChameleonForConditionalGeneration",
344
    ),
345
346
347
    "Cohere2VisionForConditionalGeneration": (
        "cohere2_vision",
        "Cohere2VisionForConditionalGeneration",
348
    ),
349
    "DeepseekVLV2ForCausalLM": ("deepseek_vl2", "DeepseekVLV2ForCausalLM"),
350
    "DeepseekOCRForCausalLM": ("deepseek_ocr", "DeepseekOCRForCausalLM"),
RED's avatar
RED committed
351
    "DeepseekOCR2ForCausalLM": ("deepseek_ocr2", "DeepseekOCR2ForCausalLM"),
Roger Wang's avatar
Roger Wang committed
352
    "DotsOCRForCausalLM": ("dots_ocr", "DotsOCRForCausalLM"),
353
354
355
356
    "Eagle2_5_VLForConditionalGeneration": (
        "eagle2_5_vl",
        "Eagle2_5_VLForConditionalGeneration",
    ),
357
358
359
    "Ernie4_5_VLMoeForConditionalGeneration": (
        "ernie45_vl",
        "Ernie4_5_VLMoeForConditionalGeneration",
360
    ),
361
362
363
364
    "FireRedASR2ForConditionalGeneration": (
        "fireredasr2",
        "FireRedASR2ForConditionalGeneration",
    ),
365
    "FunASRForConditionalGeneration": ("funasr", "FunASRForConditionalGeneration"),  # noqa: E501
366
367
368
369
    "FunAudioChatForConditionalGeneration": (
        "funaudiochat",
        "FunAudioChatForConditionalGeneration",
    ),
370
    "FuyuForCausalLM": ("fuyu", "FuyuForCausalLM"),
371
    "Gemma3ForConditionalGeneration": ("gemma3_mm", "Gemma3ForConditionalGeneration"),  # noqa: E501
372
373
374
    "Gemma3nForConditionalGeneration": (
        "gemma3n_mm",
        "Gemma3nForConditionalGeneration",
375
    ),
376
    "GlmAsrForConditionalGeneration": ("glmasr", "GlmAsrForConditionalGeneration"),
377
    "GLM4VForCausalLM": ("glm4v", "GLM4VForCausalLM"),
378
379
380
    "Glm4vForConditionalGeneration": ("glm4_1v", "Glm4vForConditionalGeneration"),
    "Glm4vMoeForConditionalGeneration": ("glm4_1v", "Glm4vMoeForConditionalGeneration"),
    "GlmOcrForConditionalGeneration": ("glm_ocr", "GlmOcrForConditionalGeneration"),  # noqa: E501
381
382
383
    "GraniteSpeechForConditionalGeneration": (
        "granite_speech",
        "GraniteSpeechForConditionalGeneration",
384
    ),
385
    "H2OVLChatModel": ("h2ovl", "H2OVLChatModel"),
386
387
388
389
    "HunYuanVLForConditionalGeneration": (
        "hunyuan_vision",
        "HunYuanVLForConditionalGeneration",
    ),
ltd0924's avatar
ltd0924 committed
390
    "StepVLForConditionalGeneration": ("step_vl", "StepVLForConditionalGeneration"),
391
    "InternVLChatModel": ("internvl", "InternVLChatModel"),
392
    "NemotronH_Nano_VL_V2": ("nano_nemotron_vl", "NemotronH_Nano_VL_V2"),
Zero's avatar
Zero committed
393
394
395
396
    "OpenCUAForConditionalGeneration": (
        "opencua",
        "OpenCUAForConditionalGeneration",
    ),
397
398
399
    "InternS1ForConditionalGeneration": (
        "interns1",
        "InternS1ForConditionalGeneration",
400
    ),
401
402
403
    "InternVLForConditionalGeneration": (
        "interns1",
        "InternS1ForConditionalGeneration",
404
    ),
zxy's avatar
zxy committed
405
406
407
408
    "InternS1ProForConditionalGeneration": (
        "interns1_pro",
        "InternS1ProForConditionalGeneration",
    ),
409
410
411
412
    "Idefics3ForConditionalGeneration": (
        "idefics3",
        "Idefics3ForConditionalGeneration",
    ),
oscardev256's avatar
oscardev256 committed
413
    "IsaacForConditionalGeneration": ("isaac", "IsaacForConditionalGeneration"),
414
    "SmolVLMForConditionalGeneration": ("smolvlm", "SmolVLMForConditionalGeneration"),  # noqa: E501
415
    "KananaVForConditionalGeneration": ("kanana_v", "KananaVForConditionalGeneration"),
416
    "KeyeForConditionalGeneration": ("keye", "KeyeForConditionalGeneration"),
417
418
419
    "KeyeVL1_5ForConditionalGeneration": (
        "keye_vl1_5",
        "KeyeVL1_5ForConditionalGeneration",
420
    ),
421
    "RForConditionalGeneration": ("rvl", "RForConditionalGeneration"),
422
    "KimiVLForConditionalGeneration": ("kimi_vl", "KimiVLForConditionalGeneration"),  # noqa: E501
Roger Wang's avatar
Roger Wang committed
423
    "KimiK25ForConditionalGeneration": ("kimi_k25", "KimiK25ForConditionalGeneration"),  # noqa: E501
424
425
426
427
    "LightOnOCRForConditionalGeneration": (
        "lightonocr",
        "LightOnOCRForConditionalGeneration",
    ),
428
    "Lfm2VlForConditionalGeneration": ("lfm2_vl", "Lfm2VLForConditionalGeneration"),
429
    "Llama_Nemotron_Nano_VL": ("nemotron_vl", "LlamaNemotronVLChatModel"),
430
    "Llama4ForConditionalGeneration": ("mllama4", "Llama4ForConditionalGeneration"),  # noqa: E501
431
    "LlavaForConditionalGeneration": ("llava", "LlavaForConditionalGeneration"),
432
433
434
    "LlavaNextForConditionalGeneration": (
        "llava_next",
        "LlavaNextForConditionalGeneration",
435
    ),
436
437
438
    "LlavaNextVideoForConditionalGeneration": (
        "llava_next_video",
        "LlavaNextVideoForConditionalGeneration",
439
    ),
440
441
442
    "LlavaOnevisionForConditionalGeneration": (
        "llava_onevision",
        "LlavaOnevisionForConditionalGeneration",
443
    ),
444
    "MantisForConditionalGeneration": ("llava", "MantisForConditionalGeneration"),  # noqa: E501
445
    "MiDashengLMModel": ("midashenglm", "MiDashengLMModel"),
446
447
448
    "MiniMaxVL01ForConditionalGeneration": (
        "minimax_vl_01",
        "MiniMaxVL01ForConditionalGeneration",
449
    ),
450
    "MiniCPMO": ("minicpmo", "MiniCPMO"),
451
    "MiniCPMV": ("minicpmv", "MiniCPMV"),
452
453
454
    "Mistral3ForConditionalGeneration": (
        "mistral3",
        "Mistral3ForConditionalGeneration",
455
    ),
456
    "MolmoForCausalLM": ("molmo", "MolmoForCausalLM"),
457
    "Molmo2ForConditionalGeneration": ("molmo2", "Molmo2ForConditionalGeneration"),
458
    "NVLM_D": ("nvlm_d", "NVLM_D_Model"),
459
460
461
462
    "OpenPanguVLForConditionalGeneration": (
        "openpangu_vl",
        "OpenPanguVLForConditionalGeneration",
    ),
463
    "Ovis": ("ovis", "Ovis"),
464
    "Ovis2_5": ("ovis2_5", "Ovis2_5"),
465
466
    "Ovis2_6ForCausalLM": ("ovis2_5", "Ovis2_5"),
    "Ovis2_6_MoeForCausalLM": ("ovis2_5", "Ovis2_5"),
467
468
469
470
    "PaddleOCRVLForConditionalGeneration": (
        "paddleocr_vl",
        "PaddleOCRVLForConditionalGeneration",
    ),
471
472
473
474
    "PaliGemmaForConditionalGeneration": (
        "paligemma",
        "PaliGemmaForConditionalGeneration",
    ),
475
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
476
    "Phi4MMForCausalLM": ("phi4mm", "Phi4MMForCausalLM"),
477
    "PixtralForConditionalGeneration": ("pixtral", "PixtralForConditionalGeneration"),  # noqa: E501
478
    "QwenVLForConditionalGeneration": ("qwen_vl", "QwenVLForConditionalGeneration"),  # noqa: E501
479
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
480
481
482
    "Qwen2_5_VLForConditionalGeneration": (
        "qwen2_5_vl",
        "Qwen2_5_VLForConditionalGeneration",
483
    ),
484
485
486
    "Qwen2AudioForConditionalGeneration": (
        "qwen2_audio",
        "Qwen2AudioForConditionalGeneration",
487
    ),
488
489
490
    "Qwen2_5OmniModel": (
        "qwen2_5_omni_thinker",
        "Qwen2_5OmniThinkerForConditionalGeneration",
491
    ),
492
493
494
    "Qwen2_5OmniForConditionalGeneration": (
        "qwen2_5_omni_thinker",
        "Qwen2_5OmniThinkerForConditionalGeneration",
495
    ),
496
497
498
499
    "Qwen3OmniMoeForConditionalGeneration": (
        "qwen3_omni_moe_thinker",
        "Qwen3OmniMoeThinkerForConditionalGeneration",
    ),
Roger Wang's avatar
Roger Wang committed
500
501
502
503
    "Qwen3ASRForConditionalGeneration": (
        "qwen3_asr",
        "Qwen3ASRForConditionalGeneration",
    ),
504
505
506
507
    "Qwen3ASRRealtimeGeneration": (
        "qwen3_asr_realtime",
        "Qwen3ASRRealtimeGeneration",
    ),
508
    "Qwen3VLForConditionalGeneration": ("qwen3_vl", "Qwen3VLForConditionalGeneration"),  # noqa: E501
509
510
511
    "Qwen3VLMoeForConditionalGeneration": (
        "qwen3_vl_moe",
        "Qwen3VLMoeForConditionalGeneration",
512
    ),
513
514
515
516
517
518
519
520
    "Qwen3_5ForConditionalGeneration": (
        "qwen3_5",
        "Qwen3_5ForConditionalGeneration",
    ),
    "Qwen3_5MoeForConditionalGeneration": (
        "qwen3_5",
        "Qwen3_5MoeForConditionalGeneration",
    ),
521
    "SkyworkR1VChatModel": ("skyworkr1v", "SkyworkR1VChatModel"),
Song's avatar
Song committed
522
    "Step3VLForConditionalGeneration": ("step3_vl", "Step3VLForConditionalGeneration"),  # noqa: E501
汪志鹏's avatar
汪志鹏 committed
523
    "TarsierForConditionalGeneration": ("tarsier", "TarsierForConditionalGeneration"),  # noqa: E501
524
525
526
    "Tarsier2ForConditionalGeneration": (
        "qwen2_vl",
        "Tarsier2ForConditionalGeneration",
527
    ),
528
    "UltravoxModel": ("ultravox", "UltravoxModel"),
Patrick von Platen's avatar
Patrick von Platen committed
529
    "VoxtralForConditionalGeneration": ("voxtral", "VoxtralForConditionalGeneration"),  # noqa: E501
530
    "VoxtralRealtimeGeneration": ("voxtral_realtime", "VoxtralRealtimeGeneration"),  # noqa: E501
531
    # [Encoder-decoder]
532
533
534
535
    "NemotronParseForConditionalGeneration": (
        "nemotron_parse",
        "NemotronParseForConditionalGeneration",
    ),
536
    "WhisperForConditionalGeneration": ("whisper", "WhisperForConditionalGeneration"),  # noqa: E501
537
}
538
539

_SPECULATIVE_DECODING_MODELS = {
540
    "ExtractHiddenStatesModel": ("extract_hidden_states", "ExtractHiddenStatesModel"),
541
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
542
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
zhiweiz's avatar
zhiweiz committed
543
    "EagleLlama4ForCausalLM": ("llama4_eagle", "EagleLlama4ForCausalLM"),
544
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
545
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
546
    "LlamaForCausalLMEagle3": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
547
    "Eagle3Qwen2_5vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
548
    "Eagle3Qwen3vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
549
550
551
552
    "EagleMistralLarge3ForCausalLM": (
        "mistral_large_3_eagle",
        "EagleMistralLarge3ForCausalLM",
    ),
553
    "EagleDeepSeekMTPModel": ("deepseek_eagle", "EagleDeepseekV3ForCausalLM"),
554
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
555
    "ErnieMTPModel": ("ernie_mtp", "ErnieMTP"),
Kyungmin Lee's avatar
Kyungmin Lee committed
556
    "ExaoneMoeMTP": ("exaone_moe_mtp", "ExaoneMoeMTP"),
557
    "NemotronHMTPModel": ("nemotron_h_mtp", "NemotronHMTP"),
XuruiYang's avatar
XuruiYang committed
558
    "LongCatFlashMTPModel": ("longcat_flash_mtp", "LongCatFlashMTP"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
559
    "Glm4MoeMTPModel": ("glm4_moe_mtp", "Glm4MoeMTP"),
560
    "Glm4MoeLiteMTPModel": ("glm4_moe_lite_mtp", "Glm4MoeLiteMTP"),
561
    "GlmOcrMTPModel": ("glm_ocr_mtp", "GlmOcrMTP"),
562
    "MedusaModel": ("medusa", "Medusa"),
563
    "OpenPanguMTPModel": ("openpangu_mtp", "OpenPanguMTP"),
564
    "Qwen3NextMTP": ("qwen3_next_mtp", "Qwen3NextMTP"),
csy0225's avatar
csy0225 committed
565
    "Step3p5MTP": ("step3p5_mtp", "Step3p5MTP"),
566
567
    "Qwen3_5MTP": ("qwen3_5_mtp", "Qwen3_5MTP"),
    "Qwen3_5MoeMTP": ("qwen3_5_mtp", "Qwen3_5MoeMTP"),
568
569
570
    # Temporarily disabled.
    # # TODO(woosuk): Re-enable this once the MLP Speculator is supported in V1.
    # "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
571
}
572

573
_TRANSFORMERS_SUPPORTED_MODELS = {
574
575
576
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
577
578
579
580
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
581
582
583
}

_TRANSFORMERS_BACKEND_MODELS = {
584
    # Text generation models
585
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
    "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
604
    "TransformersForSequenceClassification": (
605
        "transformers",
606
        "TransformersForSequenceClassification",
607
    ),
608
    "TransformersMoEForSequenceClassification": (
609
        "transformers",
610
        "TransformersMoEForSequenceClassification",
611
    ),
612
613
614
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
615
    ),
616
}
617

618
_VLLM_MODELS = {
619
    **_TEXT_GENERATION_MODELS,
620
    **_EMBEDDING_MODELS,
621
622
623
624
    **_LATE_INTERACTION_MODELS,
    **_REWARD_MODELS,
    **_TOKEN_CLASSIFICATION_MODELS,
    **_SEQUENCE_CLASSIFICATION_MODELS,
625
    **_MULTIMODAL_MODELS,
626
    **_SPECULATIVE_DECODING_MODELS,
627
628
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
629
630
}

631
632
633
634
# 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.
635
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
636

637
_PREVIOUSLY_SUPPORTED_MODELS = {
638
    "MotifForCausalLM": "0.10.2",
639
    "Phi3SmallForCausalLM": "0.9.2",
640
    "Phi4FlashForCausalLM": "0.10.2",
641
    "Phi4MultimodalForCausalLM": "0.12.0",
642
643
644
645
646
647
648
649
650
    # 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",
}
651

652

653
654
@dataclass(frozen=True)
class _ModelInfo:
655
    architecture: str
656
    is_text_generation_model: bool
657
    is_pooling_model: bool
658
    attn_type: AttnTypeStr
659
660
    default_seq_pooling_type: SequencePoolingType
    default_tok_pooling_type: TokenPoolingType
661
    score_type: ScoreType
662
    supports_multimodal: bool
663
    supports_multimodal_raw_input_only: bool
Patrick von Platen's avatar
Patrick von Platen committed
664
    requires_raw_input_tokens: bool
665
    supports_multimodal_encoder_tp_data: bool
666
    supports_pp: bool
667
668
    has_inner_state: bool
    is_attention_free: bool
669
    is_hybrid: bool
670
    has_noops: bool
671
    supports_mamba_prefix_caching: bool
672
    supports_transcription: bool
673
    supports_transcription_only: bool
674
675

    @staticmethod
676
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
677
        return _ModelInfo(
678
            architecture=model.__name__,
679
            is_text_generation_model=is_text_generation_model(model),
680
            is_pooling_model=is_pooling_model(model),
681
682
            default_seq_pooling_type=get_default_seq_pooling_type(model),
            default_tok_pooling_type=get_default_tok_pooling_type(model),
683
            attn_type=get_attn_type(model),
684
            score_type=get_score_type(model),
685
            supports_multimodal=supports_multimodal(model),
686
687
688
            supports_multimodal_raw_input_only=supports_multimodal_raw_input_only(
                model
            ),
Patrick von Platen's avatar
Patrick von Platen committed
689
            requires_raw_input_tokens=requires_raw_input_tokens(model),
690
691
692
            supports_multimodal_encoder_tp_data=supports_multimodal_encoder_tp_data(
                model
            ),
693
            supports_pp=supports_pp(model),
694
695
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
696
            is_hybrid=is_hybrid(model),
697
            supports_mamba_prefix_caching=supports_mamba_prefix_caching(model),
698
            supports_transcription=supports_transcription(model),
699
700
701
            supports_transcription_only=(
                supports_transcription(model) and model.supports_transcription_only
            ),
702
            has_noops=has_noops(model),
703
        )
704
705


706
707
708
709
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
710

711
    @abstractmethod
712
    def load_model_cls(self) -> type[nn.Module]:
713
        raise NotImplementedError
714
715


716
717
718
719
720
721
722
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
723
    model_cls: type[nn.Module]
724
725

    @staticmethod
726
    def from_model_cls(model_cls: type[nn.Module]):
727
728
729
730
731
732
733
734
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

735
    def load_model_cls(self) -> type[nn.Module]:
736
737
738
739
740
741
742
743
        return self.model_cls


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

745
746
747
    module_name: str
    class_name: str

748
749
750
751
752
753
754
755
    @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"

756
    def _load_modelinfo_from_cache(self, module_hash: str) -> _ModelInfo | None:
757
758
        try:
            try:
759
                modelinfo_path = self._get_cache_dir() / self._get_cache_filename()
760
761
762
                with open(modelinfo_path, encoding="utf-8") as file:
                    mi_dict = json.load(file)
            except FileNotFoundError:
763
                logger.debug(
764
                    "Cached model info file for class %s.%s not found",
765
766
767
                    self.module_name,
                    self.class_name,
                )
768
769
770
                return None

            if mi_dict["hash"] != module_hash:
771
                logger.debug(
772
                    "Cached model info file for class %s.%s is stale",
773
774
775
                    self.module_name,
                    self.class_name,
                )
776
777
778
779
780
                return None

            # file not changed, use cached _ModelInfo properties
            return _ModelInfo(**mi_dict["modelinfo"])
        except Exception:
781
            logger.debug(
782
                "Cached model info for class %s.%s error. ",
783
784
785
                self.module_name,
                self.class_name,
            )
786
787
            return None

788
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
789
790
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
791

792
793
794
795
796
797
798
799
        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()
800
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
801
802
803
804
805
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

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

810
811
        if model_path.exists():
            with open(model_path, "rb") as f:
812
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
813
814
815

            mi = self._load_modelinfo_from_cache(module_hash)
            if mi is not None:
816
                logger.debug(
817
                    "Loaded model info for class %s.%s from cache",
818
819
820
                    self.module_name,
                    self.class_name,
                )
821
822
                return mi
            else:
823
                logger.debug(
824
                    "Cache model info for class %s.%s miss. Loading model instead.",
825
826
827
                    self.module_name,
                    self.class_name,
                )
828
829
830

        # Performed in another process to avoid initializing CUDA
        mi = _run_in_subprocess(
831
832
833
834
835
            lambda: _ModelInfo.from_model_cls(self.load_model_cls())
        )
        logger.debug(
            "Loaded model info for class %s.%s", self.module_name, self.class_name
        )
836
837

        # save cache file
838
839
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
840
841

        return mi
842

843
    def load_model_cls(self) -> type[nn.Module]:
844
845
846
847
848
849
850
851
        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,
852
) -> type[nn.Module] | None:
853
    from vllm.platforms import current_platform
854

855
    current_platform.verify_model_arch(model_arch)
856
857
858
    try:
        return model.load_model_cls()
    except Exception:
859
        logger.exception("Error in loading model architecture '%s'", model_arch)
860
        return None
861
862


863
864
865
866
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
867
) -> _ModelInfo | None:
868
869
870
    try:
        return model.inspect_model_cls()
    except Exception:
871
        logger.exception("Error in inspecting model architecture '%s'", model_arch)
872
        return None
873
874


875
876
877
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
878
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
879

880
    def get_supported_archs(self) -> Set[str]:
881
        return self.models.keys()
882

883
884
885
    def register_model(
        self,
        model_arch: str,
886
        model_cls: type[nn.Module] | str,
887
    ) -> None:
888
889
890
        """
        Register an external model to be used in vLLM.

891
        `model_cls` can be either:
892

893
        - A [`torch.nn.Module`][] class directly referencing the model.
894
        - A string in the format `<module>:<class>` which can be used to
895
896
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
897
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
898
        """
899
900
901
902
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

903
        if model_arch in self.models:
904
905
            logger.warning(
                "Model architecture %s is already registered, and will be "
906
907
908
909
                "overwritten by the new model class %s.",
                model_arch,
                model_cls,
            )
910
911
912
913
914
915

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

917
            model = _LazyRegisteredModel(*split_str)
918
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
919
            model = _RegisteredModel.from_model_cls(model_cls)
920
        else:
921
922
923
924
            msg = (
                "`model_cls` should be a string or PyTorch model class, "
                f"not a {type(model_arch)}"
            )
925
            raise TypeError(msg)
926

927
        self.models[model_arch] = model
928

929
    def _raise_for_unsupported(self, architectures: list[str]):
930
        all_supported_archs = self.get_supported_archs()
931

932
933
934
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
935
936
                "to be inspected. Please check the logs for more details."
            )
937

938
939
940
941
942
943
944
945
        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 "
946
947
                    "use this model architecture."
                )
948

949
950
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
951
952
            f"Supported architectures: {all_supported_archs}"
        )
953

954
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
955
956
        if model_arch not in self.models:
            return None
957

958
        return _try_load_model_cls(model_arch, self.models[model_arch])
959

960
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
961
962
        if model_arch not in self.models:
            return None
963

964
965
966
967
968
969
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
970
    ) -> str | None:
971
972
973
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

974
975
976
        auto_map: dict[str, str] = (
            getattr(model_config.hf_config, "auto_map", None) or dict()
        )
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992

        # 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,
993
                        trust_remote_code=model_config.trust_remote_code,
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
                        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,
1006
                        trust_remote_code=model_config.trust_remote_code,
1007
1008
1009
1010
1011
                        warn_on_fail=True,
                    )
                    if model_module is not None:
                        break
            else:
1012
                if model_config.model_impl != "transformers":
1013
1014
1015
1016
1017
1018
1019
                    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 "
1020
1021
                    "'auto_map' (relevant if the model is custom)."
                )
1022
1023

        if not model_module.is_backend_compatible():
1024
            if model_config.model_impl != "transformers":
1025
                return None
1026

1027
1028
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
1029
1030
                "is not compatible with vLLM."
            )
1031

1032
        return model_config._get_transformers_backend_cls()
1033

1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
    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
1059

1060
1061
    def inspect_model_cls(
        self,
1062
        architectures: str | list[str],
1063
        model_config: ModelConfig,
1064
    ) -> tuple[_ModelInfo, str]:
1065
1066
        if isinstance(architectures, str):
            architectures = [architectures]
1067
1068
        if not architectures:
            raise ValueError("No model architectures are specified")
1069
1070

        # Require transformers impl
1071
        if model_config.model_impl == "transformers":
1072
            arch = self._try_resolve_transformers(architectures[0], model_config)
1073
1074
1075
1076
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)
1077
        elif model_config.model_impl == "terratorch":
1078
1079
            model_info = self._try_inspect_model_cls("Terratorch")
            return (model_info, "Terratorch")
1080

1081
        # Fallback to transformers impl (after resolving convert_type)
1082
1083
1084
1085
1086
1087
        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)
1088
1089
1090
1091
1092
1093
1094
            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)
1095
            model_info = self._try_inspect_model_cls(normalized_arch)
1096
            if model_info is not None:
1097
                return (model_info, arch)
1098

1099
        # Fallback to transformers impl (before resolving runner_type)
1100
1101
1102
1103
1104
        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)
1105
1106
1107
1108
1109
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)

1110
        return self._raise_for_unsupported(architectures)
1111

1112
1113
    def resolve_model_cls(
        self,
1114
        architectures: str | list[str],
1115
        model_config: ModelConfig,
1116
    ) -> tuple[type[nn.Module], str]:
1117
1118
        if isinstance(architectures, str):
            architectures = [architectures]
1119
1120
        if not architectures:
            raise ValueError("No model architectures are specified")
1121
1122

        # Require transformers impl
1123
        if model_config.model_impl == "transformers":
1124
            arch = self._try_resolve_transformers(architectures[0], model_config)
1125
1126
1127
1128
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)
1129
        elif model_config.model_impl == "terratorch":
1130
1131
1132
1133
            arch = "Terratorch"
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
1134

1135
        # Fallback to transformers impl (after resolving convert_type)
1136
1137
1138
1139
1140
1141
        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)
1142
1143
1144
1145
1146
1147
1148
            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)
1149
            model_cls = self._try_load_model_cls(normalized_arch)
1150
1151
            if model_cls is not None:
                return (model_cls, arch)
1152

1153
        # Fallback to transformers impl (before resolving runner_type)
1154
1155
1156
1157
1158
        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)
1159
1160
1161
1162
1163
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1164
        return self._raise_for_unsupported(architectures)
1165

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

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

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

1190
    def is_multimodal_raw_input_only_model(
1191
        self,
1192
        architectures: str | list[str],
1193
        model_config: ModelConfig,
1194
    ) -> bool:
1195
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1196
        return model_cls.supports_multimodal_raw_input_only
1197

1198
1199
    def is_pp_supported_model(
        self,
1200
        architectures: str | list[str],
1201
        model_config: ModelConfig,
1202
    ) -> bool:
1203
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1204
        return model_cls.supports_pp
1205

1206
1207
    def model_has_inner_state(
        self,
1208
        architectures: str | list[str],
1209
        model_config: ModelConfig,
1210
    ) -> bool:
1211
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1212
        return model_cls.has_inner_state
1213

1214
1215
    def is_attention_free_model(
        self,
1216
        architectures: str | list[str],
1217
        model_config: ModelConfig,
1218
    ) -> bool:
1219
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1220
        return model_cls.is_attention_free
1221

1222
1223
    def is_hybrid_model(
        self,
1224
        architectures: str | list[str],
1225
        model_config: ModelConfig,
1226
    ) -> bool:
1227
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1228
1229
        return model_cls.is_hybrid

1230
1231
    def is_noops_model(
        self,
1232
        architectures: str | list[str],
1233
        model_config: ModelConfig,
1234
    ) -> bool:
1235
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1236
1237
        return model_cls.has_noops

1238
1239
    def is_transcription_model(
        self,
1240
        architectures: str | list[str],
1241
        model_config: ModelConfig,
1242
    ) -> bool:
1243
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1244
1245
        return model_cls.supports_transcription

1246
1247
    def is_transcription_only_model(
        self,
1248
        architectures: str | list[str],
1249
        model_config: ModelConfig,
1250
    ) -> bool:
1251
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1252
1253
        return model_cls.supports_transcription_only

1254

1255
1256
1257
1258
1259
1260
1261
1262
1263
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()
    }
)
1264
1265
1266
1267
1268

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1269
1270
1271
1272
1273
    # 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")

1274
        # `cloudpickle` allows pickling lambda functions directly
1275
        import cloudpickle
1276

1277
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1278
1279
1280

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
1281
1282
1283
        returned = subprocess.run(
            _SUBPROCESS_COMMAND, input=input_bytes, capture_output=True
        )
1284
1285
1286
1287
1288
1289

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

1294
        with open(output_filepath, "rb") as f:
1295
1296
1297
1298
1299
1300
            return pickle.load(f)


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

1302
1303
1304
1305
1306
    load_general_plugins()

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

    result = fn()
1307
1308
1309

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1310
1311
1312


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