registry.py 50.6 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_late_interaction,
53
    supports_mamba_prefix_caching,
54
55
56
57
58
59
60
    supports_multimodal,
    supports_multimodal_encoder_tp_data,
    supports_multimodal_raw_input_only,
    supports_pp,
    supports_transcription,
)
from .interfaces_base import (
61
    get_attn_type,
62
63
    get_default_seq_pooling_type,
    get_default_tok_pooling_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
    "InternLMForCausalLM": ("llama", "LlamaForCausalLM"),
    "InternLM2ForCausalLM": ("internlm2", "InternLM2ForCausalLM"),
137
    "InternLM2VEForCausalLM": ("internlm2_ve", "InternLM2VEForCausalLM"),
138
    "InternLM3ForCausalLM": ("llama", "LlamaForCausalLM"),
139
140
    "IQuestCoderForCausalLM": ("llama", "LlamaForCausalLM"),
    "IQuestLoopCoderForCausalLM": ("iquest_loopcoder", "IQuestLoopCoderForCausalLM"),
141
    "JAISLMHeadModel": ("jais", "JAISLMHeadModel"),
142
    "Jais2ForCausalLM": ("jais2", "Jais2ForCausalLM"),
143
    "JambaForCausalLM": ("jamba", "JambaForCausalLM"),
144
    "KimiLinearForCausalLM": ("kimi_linear", "KimiLinearForCausalLM"),  # noqa: E501
145
    "Lfm2ForCausalLM": ("lfm2", "Lfm2ForCausalLM"),
Paul Pak's avatar
Paul Pak committed
146
    "Lfm2MoeForCausalLM": ("lfm2_moe", "Lfm2MoeForCausalLM"),
147
    "LlamaForCausalLM": ("llama", "LlamaForCausalLM"),
148
    "Llama4ForCausalLM": ("llama4", "Llama4ForCausalLM"),
149
150
    # For decapoda-research/llama-*
    "LLaMAForCausalLM": ("llama", "LlamaForCausalLM"),
XuruiYang's avatar
XuruiYang committed
151
    "LongcatFlashForCausalLM": ("longcat_flash", "LongcatFlashForCausalLM"),
152
    "MambaForCausalLM": ("mamba", "MambaForCausalLM"),
153
    "Mamba2ForCausalLM": ("mamba2", "Mamba2ForCausalLM"),
154
155
    "MiniCPMForCausalLM": ("minicpm", "MiniCPMForCausalLM"),
    "MiniCPM3ForCausalLM": ("minicpm3", "MiniCPM3ForCausalLM"),
156
157
158
    "MiniMaxForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxText01ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
    "MiniMaxM1ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
159
    "MiniMaxM2ForCausalLM": ("minimax_m2", "MiniMaxM2ForCausalLM"),
160
    "MistralForCausalLM": ("mistral", "MistralForCausalLM"),
161
    "MistralLarge3ForCausalLM": ("mistral_large_3", "MistralLarge3ForCausalLM"),
162
163
164
165
    "MixtralForCausalLM": ("mixtral", "MixtralForCausalLM"),
    # transformers's mpt class has lower case
    "MptForCausalLM": ("mpt", "MPTForCausalLM"),
    "MPTForCausalLM": ("mpt", "MPTForCausalLM"),
166
    "MiMoForCausalLM": ("mimo", "MiMoForCausalLM"),
167
    "MiMoV2FlashForCausalLM": ("mimo_v2_flash", "MiMoV2FlashForCausalLM"),
168
    "NemotronForCausalLM": ("nemotron", "NemotronForCausalLM"),
Luis Vega's avatar
Luis Vega committed
169
    "NemotronHForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
170
    "NemotronHPuzzleForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
171
    "OlmoForCausalLM": ("olmo", "OlmoForCausalLM"),
172
    "Olmo2ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
173
    "Olmo3ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
174
175
176
    "OlmoeForCausalLM": ("olmoe", "OlmoeForCausalLM"),
    "OPTForCausalLM": ("opt", "OPTForCausalLM"),
    "OrionForCausalLM": ("orion", "OrionForCausalLM"),
177
    "OuroForCausalLM": ("ouro", "OuroForCausalLM"),
178
    "PanguEmbeddedForCausalLM": ("openpangu", "PanguEmbeddedForCausalLM"),
179
    "PanguProMoEV2ForCausalLM": ("openpangu", "PanguProMoEV2ForCausalLM"),
180
    "PanguUltraMoEForCausalLM": ("openpangu", "PanguUltraMoEForCausalLM"),
181
182
183
184
    "PersimmonForCausalLM": ("persimmon", "PersimmonForCausalLM"),
    "PhiForCausalLM": ("phi", "PhiForCausalLM"),
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
    "PhiMoEForCausalLM": ("phimoe", "PhiMoEForCausalLM"),
Shinichi Hemmi's avatar
Shinichi Hemmi committed
185
    "Plamo2ForCausalLM": ("plamo2", "Plamo2ForCausalLM"),
186
    "Plamo3ForCausalLM": ("plamo3", "Plamo3ForCausalLM"),
187
    "QWenLMHeadModel": ("qwen", "QWenLMHeadModel"),
188
189
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
    "Qwen2MoeForCausalLM": ("qwen2_moe", "Qwen2MoeForCausalLM"),
190
191
    "Qwen3ForCausalLM": ("qwen3", "Qwen3ForCausalLM"),
    "Qwen3MoeForCausalLM": ("qwen3_moe", "Qwen3MoeForCausalLM"),
192
    "RWForCausalLM": ("falcon", "FalconForCausalLM"),
193
    "SeedOssForCausalLM": ("seed_oss", "SeedOssForCausalLM"),
Li Xie's avatar
Li Xie committed
194
    "Step1ForCausalLM": ("step1", "Step1ForCausalLM"),
Song's avatar
Song committed
195
    "Step3TextForCausalLM": ("step3_text", "Step3TextForCausalLM"),
csy0225's avatar
csy0225 committed
196
    "Step3p5ForCausalLM": ("step3p5", "Step3p5ForCausalLM"),
197
198
199
200
    "StableLMEpochForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "StableLmForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "Starcoder2ForCausalLM": ("starcoder2", "Starcoder2ForCausalLM"),
    "SolarForCausalLM": ("solar", "SolarForCausalLM"),
201
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
202
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
203
    "TeleFLMForCausalLM": ("teleflm", "TeleFLMForCausalLM"),
204
    "XverseForCausalLM": ("llama", "LlamaForCausalLM"),
205
    "Zamba2ForCausalLM": ("zamba2", "Zamba2ForCausalLM"),
206
207
208
}

_EMBEDDING_MODELS = {
209
    # [Text-only]
210
    "BertModel": ("bert", "BertEmbeddingModel"),
211
    "BertSpladeSparseEmbeddingModel": ("bert", "BertSpladeSparseEmbeddingModel"),
212
    "HF_ColBERT": ("colbert", "ColBERTModel"),
213
214
    "ColBERTModernBertModel": ("colbert", "ColBERTModernBertModel"),
    "ColBERTJinaRobertaModel": ("colbert", "ColBERTJinaRobertaModel"),
215
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
216
    "Gemma2Model": ("gemma2", "Gemma2ForCausalLM"),
217
    "Gemma3TextModel": ("gemma3", "Gemma3Model"),
218
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
219
    "GPT2ForSequenceClassification": ("gpt2", "GPT2ForSequenceClassification"),
220
    "GritLM": ("gritlm", "GritLM"),
221
222
    "GteModel": ("bert_with_rope", "SnowflakeGteNewModel"),
    "GteNewModel": ("bert_with_rope", "GteNewModel"),
223
    "InternLM2ForRewardModel": ("internlm2", "InternLM2ForRewardModel"),
224
    "JambaForSequenceClassification": ("jamba", "JambaForSequenceClassification"),  # noqa: E501
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
    "Qwen2ForRewardModel": ("qwen2_rm", "Qwen2ForRewardModel"),
240
    "Qwen2ForProcessRewardModel": ("qwen2_rm", "Qwen2ForProcessRewardModel"),
241
242
    "RobertaForMaskedLM": ("roberta", "RobertaEmbeddingModel"),
    "RobertaModel": ("roberta", "RobertaEmbeddingModel"),
243
    "TeleChatForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
244
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
chengchengpei's avatar
chengchengpei committed
245
246
247
248
    "VoyageQwen3BidirectionalEmbedModel": (
        "voyage",
        "VoyageQwen3BidirectionalEmbedModel",
    ),
249
    "XLMRobertaModel": ("roberta", "RobertaEmbeddingModel"),
250
    "BgeM3EmbeddingModel": ("roberta", "BgeM3EmbeddingModel"),
251
    # [Multimodal]
252
    "CLIPModel": ("clip", "CLIPEmbeddingModel"),
253
    "ColModernVBertForRetrieval": ("colmodernvbert", "ColModernVBertForRetrieval"),
254
255
256
    "LlavaNextForConditionalGeneration": (
        "llava_next",
        "LlavaNextForConditionalGeneration",
257
    ),
258
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
259
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
260
261
    "ColQwen3": ("colqwen3", "ColQwen3Model"),
    "OpsColQwen3Model": ("colqwen3", "ColQwen3Model"),
262
    "Qwen3VLNemotronEmbedModel": ("colqwen3", "ColQwen3Model"),
263
    "SiglipModel": ("siglip", "SiglipEmbeddingModel"),
264
265
266
267
    "LlamaNemotronVLModel": (
        "nemotron_vl",
        "LlamaNemotronVLForEmbedding",
    ),
268
269
    # Technically Terratorch models work on images, both in
    # input and output. I am adding it here because it piggy-backs on embedding
270
    # models for the time being.
271
272
    "PrithviGeoSpatialMAE": ("terratorch", "Terratorch"),
    "Terratorch": ("terratorch", "Terratorch"),
273
274
}

275
276
_CROSS_ENCODER_MODELS = {
    "BertForSequenceClassification": ("bert", "BertForSequenceClassification"),
277
    "BertForTokenClassification": ("bert", "BertForTokenClassification"),
278
279
280
281
    "GteNewForSequenceClassification": (
        "bert_with_rope",
        "GteNewForSequenceClassification",
    ),
282
283
284
285
286
    "JinaVLForRanking": ("jina_vl", "JinaVLForSequenceClassification"),
    "LlamaBidirectionalForSequenceClassification": (
        "llama",
        "LlamaBidirectionalForSequenceClassification",
    ),
287
288
289
290
    "ModernBertForSequenceClassification": (
        "modernbert",
        "ModernBertForSequenceClassification",
    ),
291
292
293
294
    "ModernBertForTokenClassification": (
        "modernbert",
        "ModernBertForTokenClassification",
    ),
295
296
297
298
299
    "RobertaForSequenceClassification": ("roberta", "RobertaForSequenceClassification"),
    "XLMRobertaForSequenceClassification": (
        "roberta",
        "RobertaForSequenceClassification",
    ),
300
301
}

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

_SPECULATIVE_DECODING_MODELS = {
515
    "ExtractHiddenStatesModel": ("extract_hidden_states", "ExtractHiddenStatesModel"),
516
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
517
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
zhiweiz's avatar
zhiweiz committed
518
    "EagleLlama4ForCausalLM": ("llama4_eagle", "EagleLlama4ForCausalLM"),
519
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
520
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
521
    "LlamaForCausalLMEagle3": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
522
    "Eagle3Qwen2_5vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
523
    "Eagle3Qwen3vlForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
524
525
526
527
    "EagleMistralLarge3ForCausalLM": (
        "mistral_large_3_eagle",
        "EagleMistralLarge3ForCausalLM",
    ),
528
    "EagleDeepSeekMTPModel": ("deepseek_eagle", "EagleDeepseekV3ForCausalLM"),
529
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
530
    "ErnieMTPModel": ("ernie_mtp", "ErnieMTP"),
Kyungmin Lee's avatar
Kyungmin Lee committed
531
    "ExaoneMoeMTP": ("exaone_moe_mtp", "ExaoneMoeMTP"),
532
    "NemotronHMTPModel": ("nemotron_h_mtp", "NemotronHMTP"),
XuruiYang's avatar
XuruiYang committed
533
    "LongCatFlashMTPModel": ("longcat_flash_mtp", "LongCatFlashMTP"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
534
    "Glm4MoeMTPModel": ("glm4_moe_mtp", "Glm4MoeMTP"),
535
    "Glm4MoeLiteMTPModel": ("glm4_moe_lite_mtp", "Glm4MoeLiteMTP"),
536
    "GlmOcrMTPModel": ("glm_ocr_mtp", "GlmOcrMTP"),
537
    "MedusaModel": ("medusa", "Medusa"),
538
    "OpenPanguMTPModel": ("openpangu_mtp", "OpenPanguMTP"),
539
    "Qwen3NextMTP": ("qwen3_next_mtp", "Qwen3NextMTP"),
csy0225's avatar
csy0225 committed
540
    "Step3p5MTP": ("step3p5_mtp", "Step3p5MTP"),
541
542
    "Qwen3_5MTP": ("qwen3_5_mtp", "Qwen3_5MTP"),
    "Qwen3_5MoeMTP": ("qwen3_5_mtp", "Qwen3_5MoeMTP"),
543
544
545
    # Temporarily disabled.
    # # TODO(woosuk): Re-enable this once the MLP Speculator is supported in V1.
    # "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
546
}
547

548
_TRANSFORMERS_SUPPORTED_MODELS = {
549
550
551
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
552
553
554
555
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
556
557
558
}

_TRANSFORMERS_BACKEND_MODELS = {
559
    # Text generation models
560
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
    "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
579
    "TransformersForSequenceClassification": (
580
        "transformers",
581
        "TransformersForSequenceClassification",
582
    ),
583
    "TransformersMoEForSequenceClassification": (
584
        "transformers",
585
        "TransformersMoEForSequenceClassification",
586
    ),
587
588
589
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
590
    ),
591
}
592

593
_VLLM_MODELS = {
594
    **_TEXT_GENERATION_MODELS,
595
    **_EMBEDDING_MODELS,
596
    **_CROSS_ENCODER_MODELS,
597
    **_MULTIMODAL_MODELS,
598
    **_SPECULATIVE_DECODING_MODELS,
599
600
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
601
602
}

603
604
605
606
# 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.
607
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
608

609
_PREVIOUSLY_SUPPORTED_MODELS = {
610
    "MotifForCausalLM": "0.10.2",
611
    "Phi3SmallForCausalLM": "0.9.2",
612
    "Phi4FlashForCausalLM": "0.10.2",
613
    "Phi4MultimodalForCausalLM": "0.12.0",
614
615
616
617
618
619
620
621
622
    # 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",
}
623

624

625
626
@dataclass(frozen=True)
class _ModelInfo:
627
    architecture: str
628
    is_text_generation_model: bool
629
    is_pooling_model: bool
630
    attn_type: AttnTypeStr
631
632
    default_seq_pooling_type: SequencePoolingType
    default_tok_pooling_type: TokenPoolingType
633
    supports_cross_encoding: bool
634
    supports_late_interaction: bool
635
    supports_multimodal: bool
636
    supports_multimodal_raw_input_only: bool
Patrick von Platen's avatar
Patrick von Platen committed
637
    requires_raw_input_tokens: bool
638
    supports_multimodal_encoder_tp_data: bool
639
    supports_pp: bool
640
641
    has_inner_state: bool
    is_attention_free: bool
642
    is_hybrid: bool
643
    has_noops: bool
644
    supports_mamba_prefix_caching: bool
645
    supports_transcription: bool
646
    supports_transcription_only: bool
647
648

    @staticmethod
649
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
650
        return _ModelInfo(
651
            architecture=model.__name__,
652
            is_text_generation_model=is_text_generation_model(model),
653
            is_pooling_model=is_pooling_model(model),
654
655
            default_seq_pooling_type=get_default_seq_pooling_type(model),
            default_tok_pooling_type=get_default_tok_pooling_type(model),
656
            attn_type=get_attn_type(model),
657
            supports_cross_encoding=supports_cross_encoding(model),
658
            supports_late_interaction=supports_late_interaction(model),
659
            supports_multimodal=supports_multimodal(model),
660
661
662
            supports_multimodal_raw_input_only=supports_multimodal_raw_input_only(
                model
            ),
Patrick von Platen's avatar
Patrick von Platen committed
663
            requires_raw_input_tokens=requires_raw_input_tokens(model),
664
665
666
            supports_multimodal_encoder_tp_data=supports_multimodal_encoder_tp_data(
                model
            ),
667
            supports_pp=supports_pp(model),
668
669
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
670
            is_hybrid=is_hybrid(model),
671
            supports_mamba_prefix_caching=supports_mamba_prefix_caching(model),
672
            supports_transcription=supports_transcription(model),
673
674
675
            supports_transcription_only=(
                supports_transcription(model) and model.supports_transcription_only
            ),
676
            has_noops=has_noops(model),
677
        )
678
679


680
681
682
683
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
684

685
    @abstractmethod
686
    def load_model_cls(self) -> type[nn.Module]:
687
        raise NotImplementedError
688
689


690
691
692
693
694
695
696
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
697
    model_cls: type[nn.Module]
698
699

    @staticmethod
700
    def from_model_cls(model_cls: type[nn.Module]):
701
702
703
704
705
706
707
708
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

709
    def load_model_cls(self) -> type[nn.Module]:
710
711
712
713
714
715
716
717
        return self.model_cls


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

719
720
721
    module_name: str
    class_name: str

722
723
724
725
726
727
728
729
    @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"

730
    def _load_modelinfo_from_cache(self, module_hash: str) -> _ModelInfo | None:
731
732
        try:
            try:
733
                modelinfo_path = self._get_cache_dir() / self._get_cache_filename()
734
735
736
                with open(modelinfo_path, encoding="utf-8") as file:
                    mi_dict = json.load(file)
            except FileNotFoundError:
737
                logger.debug(
738
                    "Cached model info file for class %s.%s not found",
739
740
741
                    self.module_name,
                    self.class_name,
                )
742
743
744
                return None

            if mi_dict["hash"] != module_hash:
745
                logger.debug(
746
                    "Cached model info file for class %s.%s is stale",
747
748
749
                    self.module_name,
                    self.class_name,
                )
750
751
752
753
754
                return None

            # file not changed, use cached _ModelInfo properties
            return _ModelInfo(**mi_dict["modelinfo"])
        except Exception:
755
            logger.debug(
756
                "Cached model info for class %s.%s error. ",
757
758
759
                self.module_name,
                self.class_name,
            )
760
761
            return None

762
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
763
764
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
765

766
767
768
769
770
771
772
773
        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()
774
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
775
776
777
778
779
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

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

784
785
        if model_path.exists():
            with open(model_path, "rb") as f:
786
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
787
788
789

            mi = self._load_modelinfo_from_cache(module_hash)
            if mi is not None:
790
                logger.debug(
791
                    "Loaded model info for class %s.%s from cache",
792
793
794
                    self.module_name,
                    self.class_name,
                )
795
796
                return mi
            else:
797
                logger.debug(
798
                    "Cache model info for class %s.%s miss. Loading model instead.",
799
800
801
                    self.module_name,
                    self.class_name,
                )
802
803
804

        # Performed in another process to avoid initializing CUDA
        mi = _run_in_subprocess(
805
806
807
808
809
            lambda: _ModelInfo.from_model_cls(self.load_model_cls())
        )
        logger.debug(
            "Loaded model info for class %s.%s", self.module_name, self.class_name
        )
810
811

        # save cache file
812
813
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
814
815

        return mi
816

817
    def load_model_cls(self) -> type[nn.Module]:
818
819
820
821
822
823
824
825
        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,
826
) -> type[nn.Module] | None:
827
    from vllm.platforms import current_platform
828

829
    current_platform.verify_model_arch(model_arch)
830
831
832
    try:
        return model.load_model_cls()
    except Exception:
833
        logger.exception("Error in loading model architecture '%s'", model_arch)
834
        return None
835
836


837
838
839
840
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
841
) -> _ModelInfo | None:
842
843
844
    try:
        return model.inspect_model_cls()
    except Exception:
845
        logger.exception("Error in inspecting model architecture '%s'", model_arch)
846
        return None
847
848


849
850
851
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
852
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
853

854
    def get_supported_archs(self) -> Set[str]:
855
        return self.models.keys()
856

857
858
859
    def register_model(
        self,
        model_arch: str,
860
        model_cls: type[nn.Module] | str,
861
    ) -> None:
862
863
864
        """
        Register an external model to be used in vLLM.

865
        `model_cls` can be either:
866

867
        - A [`torch.nn.Module`][] class directly referencing the model.
868
        - A string in the format `<module>:<class>` which can be used to
869
870
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
871
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
872
        """
873
874
875
876
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

877
        if model_arch in self.models:
878
879
            logger.warning(
                "Model architecture %s is already registered, and will be "
880
881
882
883
                "overwritten by the new model class %s.",
                model_arch,
                model_cls,
            )
884
885
886
887
888
889

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

891
            model = _LazyRegisteredModel(*split_str)
892
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
893
            model = _RegisteredModel.from_model_cls(model_cls)
894
        else:
895
896
897
898
            msg = (
                "`model_cls` should be a string or PyTorch model class, "
                f"not a {type(model_arch)}"
            )
899
            raise TypeError(msg)
900

901
        self.models[model_arch] = model
902

903
    def _raise_for_unsupported(self, architectures: list[str]):
904
        all_supported_archs = self.get_supported_archs()
905

906
907
908
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
909
910
                "to be inspected. Please check the logs for more details."
            )
911

912
913
914
915
916
917
918
919
        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 "
920
921
                    "use this model architecture."
                )
922

923
924
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
925
926
            f"Supported architectures: {all_supported_archs}"
        )
927

928
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
929
930
        if model_arch not in self.models:
            return None
931

932
        return _try_load_model_cls(model_arch, self.models[model_arch])
933

934
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
935
936
        if model_arch not in self.models:
            return None
937

938
939
940
941
942
943
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
944
    ) -> str | None:
945
946
947
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

948
949
950
        auto_map: dict[str, str] = (
            getattr(model_config.hf_config, "auto_map", None) or dict()
        )
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966

        # 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,
967
                        trust_remote_code=model_config.trust_remote_code,
968
969
970
971
972
973
974
975
976
977
978
979
                        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,
980
                        trust_remote_code=model_config.trust_remote_code,
981
982
983
984
985
                        warn_on_fail=True,
                    )
                    if model_module is not None:
                        break
            else:
986
                if model_config.model_impl != "transformers":
987
988
989
990
991
992
993
                    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 "
994
995
                    "'auto_map' (relevant if the model is custom)."
                )
996
997

        if not model_module.is_backend_compatible():
998
            if model_config.model_impl != "transformers":
999
                return None
1000

1001
1002
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
1003
1004
                "is not compatible with vLLM."
            )
1005

1006
        return model_config._get_transformers_backend_cls()
1007

1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
    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
1033

1034
1035
    def inspect_model_cls(
        self,
1036
        architectures: str | list[str],
1037
        model_config: ModelConfig,
1038
    ) -> tuple[_ModelInfo, 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_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)
1051
        elif model_config.model_impl == "terratorch":
1052
1053
            model_info = self._try_inspect_model_cls("Terratorch")
            return (model_info, "Terratorch")
1054

1055
        # Fallback to transformers impl (after resolving convert_type)
1056
1057
1058
1059
1060
1061
        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)
1062
1063
1064
1065
1066
1067
1068
            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)
1069
            model_info = self._try_inspect_model_cls(normalized_arch)
1070
            if model_info is not None:
1071
                return (model_info, arch)
1072

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

1084
        return self._raise_for_unsupported(architectures)
1085

1086
1087
    def resolve_model_cls(
        self,
1088
        architectures: str | list[str],
1089
        model_config: ModelConfig,
1090
    ) -> tuple[type[nn.Module], str]:
1091
1092
        if isinstance(architectures, str):
            architectures = [architectures]
1093
1094
        if not architectures:
            raise ValueError("No model architectures are specified")
1095
1096

        # Require transformers impl
1097
        if model_config.model_impl == "transformers":
1098
            arch = self._try_resolve_transformers(architectures[0], model_config)
1099
1100
1101
1102
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)
1103
        elif model_config.model_impl == "terratorch":
1104
1105
1106
1107
            arch = "Terratorch"
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
1108

1109
        # Fallback to transformers impl (after resolving convert_type)
1110
1111
1112
1113
1114
1115
        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)
1116
1117
1118
1119
1120
1121
1122
            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)
1123
            model_cls = self._try_load_model_cls(normalized_arch)
1124
1125
            if model_cls is not None:
                return (model_cls, arch)
1126

1127
        # Fallback to transformers impl (before resolving runner_type)
1128
1129
1130
1131
1132
        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)
1133
1134
1135
1136
1137
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1138
        return self._raise_for_unsupported(architectures)
1139

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

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

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

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

1172
    def is_multimodal_raw_input_only_model(
1173
        self,
1174
        architectures: str | list[str],
1175
        model_config: ModelConfig,
1176
    ) -> bool:
1177
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1178
        return model_cls.supports_multimodal_raw_input_only
1179

1180
1181
    def is_pp_supported_model(
        self,
1182
        architectures: str | list[str],
1183
        model_config: ModelConfig,
1184
    ) -> bool:
1185
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1186
        return model_cls.supports_pp
1187

1188
1189
    def model_has_inner_state(
        self,
1190
        architectures: str | list[str],
1191
        model_config: ModelConfig,
1192
    ) -> bool:
1193
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1194
        return model_cls.has_inner_state
1195

1196
1197
    def is_attention_free_model(
        self,
1198
        architectures: str | list[str],
1199
        model_config: ModelConfig,
1200
    ) -> bool:
1201
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1202
        return model_cls.is_attention_free
1203

1204
1205
    def is_hybrid_model(
        self,
1206
        architectures: str | list[str],
1207
        model_config: ModelConfig,
1208
    ) -> bool:
1209
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1210
1211
        return model_cls.is_hybrid

1212
1213
    def is_noops_model(
        self,
1214
        architectures: str | list[str],
1215
        model_config: ModelConfig,
1216
    ) -> bool:
1217
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1218
1219
        return model_cls.has_noops

1220
1221
    def is_transcription_model(
        self,
1222
        architectures: str | list[str],
1223
        model_config: ModelConfig,
1224
    ) -> bool:
1225
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1226
1227
        return model_cls.supports_transcription

1228
1229
    def is_transcription_only_model(
        self,
1230
        architectures: str | list[str],
1231
        model_config: ModelConfig,
1232
    ) -> bool:
1233
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1234
1235
        return model_cls.supports_transcription_only

1236

1237
1238
1239
1240
1241
1242
1243
1244
1245
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()
    }
)
1246
1247
1248
1249
1250

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1251
1252
1253
1254
1255
    # 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")

1256
        # `cloudpickle` allows pickling lambda functions directly
1257
        import cloudpickle
1258

1259
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1260
1261
1262

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
1263
1264
1265
        returned = subprocess.run(
            _SUBPROCESS_COMMAND, input=input_bytes, capture_output=True
        )
1266
1267
1268
1269
1270
1271

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

1276
        with open(output_filepath, "rb") as f:
1277
1278
1279
1280
1281
1282
            return pickle.load(f)


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

1284
1285
1286
1287
1288
    load_general_plugins()

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

    result = fn()
1289
1290
1291

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1292
1293
1294


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