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

_EMBEDDING_MODELS = {
207
    # [Text-only]
208
    "BertModel": ("bert", "BertEmbeddingModel"),
209
    "BertSpladeSparseEmbeddingModel": ("bert", "BertSpladeSparseEmbeddingModel"),
210
    "HF_ColBERT": ("colbert", "ColBERTModel"),
211
212
    "ColBERTModernBertModel": ("colbert", "ColBERTModernBertModel"),
    "ColBERTJinaRobertaModel": ("colbert", "ColBERTJinaRobertaModel"),
213
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
214
    "Gemma2Model": ("gemma2", "Gemma2ForCausalLM"),
215
    "Gemma3TextModel": ("gemma3", "Gemma3Model"),
216
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
217
    "GPT2ForSequenceClassification": ("gpt2", "GPT2ForSequenceClassification"),
218
    "GritLM": ("gritlm", "GritLM"),
219
220
    "GteModel": ("bert_with_rope", "SnowflakeGteNewModel"),
    "GteNewModel": ("bert_with_rope", "GteNewModel"),
221
    "InternLM2ForRewardModel": ("internlm2", "InternLM2ForRewardModel"),
222
    "JambaForSequenceClassification": ("jamba", "JambaForSequenceClassification"),  # noqa: E501
223
    "LlamaBidirectionalModel": ("llama", "LlamaBidirectionalModel"),
224
    "LlamaModel": ("llama", "LlamaForCausalLM"),
225
226
    **{
        # Multiple models share the same architecture, so we include them all
227
228
        k: (mod, arch)
        for k, (mod, arch) in _TEXT_GENERATION_MODELS.items()
229
230
        if arch == "LlamaForCausalLM"
    },
231
    "MistralModel": ("llama", "LlamaForCausalLM"),
232
    "ModernBertModel": ("modernbert", "ModernBertModel"),
233
    "NomicBertModel": ("bert_with_rope", "NomicBertModel"),
234
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
235
    "Qwen2Model": ("qwen2", "Qwen2ForCausalLM"),
236
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
237
    "Qwen2ForRewardModel": ("qwen2_rm", "Qwen2ForRewardModel"),
238
    "Qwen2ForProcessRewardModel": ("qwen2_rm", "Qwen2ForProcessRewardModel"),
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
    "BgeM3EmbeddingModel": ("roberta", "BgeM3EmbeddingModel"),
249
    # [Multimodal]
250
    "CLIPModel": ("clip", "CLIPEmbeddingModel"),
251
    "ColModernVBertForRetrieval": ("colmodernvbert", "ColModernVBertForRetrieval"),
252
253
254
    "LlavaNextForConditionalGeneration": (
        "llava_next",
        "LlavaNextForConditionalGeneration",
255
    ),
256
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
257
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
258
259
    "ColQwen3": ("colqwen3", "ColQwen3Model"),
    "OpsColQwen3Model": ("colqwen3", "ColQwen3Model"),
260
    "Qwen3VLNemotronEmbedModel": ("colqwen3", "ColQwen3Model"),
261
    "SiglipModel": ("siglip", "SiglipEmbeddingModel"),
262
263
    # Technically Terratorch models work on images, both in
    # input and output. I am adding it here because it piggy-backs on embedding
264
    # models for the time being.
265
266
    "PrithviGeoSpatialMAE": ("terratorch", "Terratorch"),
    "Terratorch": ("terratorch", "Terratorch"),
267
268
}

269
270
_CROSS_ENCODER_MODELS = {
    "BertForSequenceClassification": ("bert", "BertForSequenceClassification"),
271
    "BertForTokenClassification": ("bert", "BertForTokenClassification"),
272
273
274
275
    "GteNewForSequenceClassification": (
        "bert_with_rope",
        "GteNewForSequenceClassification",
    ),
276
277
278
279
280
    "JinaVLForRanking": ("jina_vl", "JinaVLForSequenceClassification"),
    "LlamaBidirectionalForSequenceClassification": (
        "llama",
        "LlamaBidirectionalForSequenceClassification",
    ),
281
282
283
284
    "ModernBertForSequenceClassification": (
        "modernbert",
        "ModernBertForSequenceClassification",
    ),
285
286
287
288
    "ModernBertForTokenClassification": (
        "modernbert",
        "ModernBertForTokenClassification",
    ),
289
290
291
292
293
    "RobertaForSequenceClassification": ("roberta", "RobertaForSequenceClassification"),
    "XLMRobertaForSequenceClassification": (
        "roberta",
        "RobertaForSequenceClassification",
    ),
294
295
}

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

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

541
_TRANSFORMERS_SUPPORTED_MODELS = {
542
543
544
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
545
546
547
548
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
549
550
551
}

_TRANSFORMERS_BACKEND_MODELS = {
552
    # Text generation models
553
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
    "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
572
    "TransformersForSequenceClassification": (
573
        "transformers",
574
        "TransformersForSequenceClassification",
575
    ),
576
    "TransformersMoEForSequenceClassification": (
577
        "transformers",
578
        "TransformersMoEForSequenceClassification",
579
    ),
580
581
582
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
583
    ),
584
}
585

586
_VLLM_MODELS = {
587
    **_TEXT_GENERATION_MODELS,
588
    **_EMBEDDING_MODELS,
589
    **_CROSS_ENCODER_MODELS,
590
    **_MULTIMODAL_MODELS,
591
    **_SPECULATIVE_DECODING_MODELS,
592
593
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
594
595
}

596
597
598
599
# 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.
600
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
601

602
_PREVIOUSLY_SUPPORTED_MODELS = {
603
    "MotifForCausalLM": "0.10.2",
604
    "Phi3SmallForCausalLM": "0.9.2",
605
    "Phi4FlashForCausalLM": "0.10.2",
606
    "Phi4MultimodalForCausalLM": "0.12.0",
607
608
609
610
611
612
613
614
615
    # 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",
}
616

617

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

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


673
674
675
676
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
677

678
    @abstractmethod
679
    def load_model_cls(self) -> type[nn.Module]:
680
        raise NotImplementedError
681
682


683
684
685
686
687
688
689
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
690
    model_cls: type[nn.Module]
691
692

    @staticmethod
693
    def from_model_cls(model_cls: type[nn.Module]):
694
695
696
697
698
699
700
701
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

702
    def load_model_cls(self) -> type[nn.Module]:
703
704
705
706
707
708
709
710
        return self.model_cls


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

712
713
714
    module_name: str
    class_name: str

715
716
717
718
719
720
721
722
    @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"

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

            if mi_dict["hash"] != module_hash:
738
                logger.debug(
739
                    "Cached model info file for class %s.%s is stale",
740
741
742
                    self.module_name,
                    self.class_name,
                )
743
744
745
746
747
                return None

            # file not changed, use cached _ModelInfo properties
            return _ModelInfo(**mi_dict["modelinfo"])
        except Exception:
748
            logger.debug(
749
                "Cached model info for class %s.%s error. ",
750
751
752
                self.module_name,
                self.class_name,
            )
753
754
            return None

755
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
756
757
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
758

759
760
761
762
763
764
765
766
        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()
767
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
768
769
770
771
772
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

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

777
778
        if model_path.exists():
            with open(model_path, "rb") as f:
779
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
780
781
782

            mi = self._load_modelinfo_from_cache(module_hash)
            if mi is not None:
783
                logger.debug(
784
                    "Loaded model info for class %s.%s from cache",
785
786
787
                    self.module_name,
                    self.class_name,
                )
788
789
                return mi
            else:
790
                logger.debug(
791
                    "Cache model info for class %s.%s miss. Loading model instead.",
792
793
794
                    self.module_name,
                    self.class_name,
                )
795
796
797

        # Performed in another process to avoid initializing CUDA
        mi = _run_in_subprocess(
798
799
800
801
802
            lambda: _ModelInfo.from_model_cls(self.load_model_cls())
        )
        logger.debug(
            "Loaded model info for class %s.%s", self.module_name, self.class_name
        )
803
804

        # save cache file
805
806
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
807
808

        return mi
809

810
    def load_model_cls(self) -> type[nn.Module]:
811
812
813
814
815
816
817
818
        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,
819
) -> type[nn.Module] | None:
820
    from vllm.platforms import current_platform
821

822
    current_platform.verify_model_arch(model_arch)
823
824
825
    try:
        return model.load_model_cls()
    except Exception:
826
        logger.exception("Error in loading model architecture '%s'", model_arch)
827
        return None
828
829


830
831
832
833
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
834
) -> _ModelInfo | None:
835
836
837
    try:
        return model.inspect_model_cls()
    except Exception:
838
        logger.exception("Error in inspecting model architecture '%s'", model_arch)
839
        return None
840
841


842
843
844
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
845
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
846

847
    def get_supported_archs(self) -> Set[str]:
848
        return self.models.keys()
849

850
851
852
    def register_model(
        self,
        model_arch: str,
853
        model_cls: type[nn.Module] | str,
854
    ) -> None:
855
856
857
        """
        Register an external model to be used in vLLM.

858
        `model_cls` can be either:
859

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

870
        if model_arch in self.models:
871
872
            logger.warning(
                "Model architecture %s is already registered, and will be "
873
874
875
876
                "overwritten by the new model class %s.",
                model_arch,
                model_cls,
            )
877
878
879
880
881
882

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

884
            model = _LazyRegisteredModel(*split_str)
885
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
886
            model = _RegisteredModel.from_model_cls(model_cls)
887
        else:
888
889
890
891
            msg = (
                "`model_cls` should be a string or PyTorch model class, "
                f"not a {type(model_arch)}"
            )
892
            raise TypeError(msg)
893

894
        self.models[model_arch] = model
895

896
    def _raise_for_unsupported(self, architectures: list[str]):
897
        all_supported_archs = self.get_supported_archs()
898

899
900
901
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
902
903
                "to be inspected. Please check the logs for more details."
            )
904

905
906
907
908
909
910
911
912
        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 "
913
914
                    "use this model architecture."
                )
915

916
917
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
918
919
            f"Supported architectures: {all_supported_archs}"
        )
920

921
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
922
923
        if model_arch not in self.models:
            return None
924

925
        return _try_load_model_cls(model_arch, self.models[model_arch])
926

927
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
928
929
        if model_arch not in self.models:
            return None
930

931
932
933
934
935
936
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
937
    ) -> str | None:
938
939
940
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

941
942
943
        auto_map: dict[str, str] = (
            getattr(model_config.hf_config, "auto_map", None) or dict()
        )
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959

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

        if not model_module.is_backend_compatible():
991
            if model_config.model_impl != "transformers":
992
                return None
993

994
995
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
996
997
                "is not compatible with vLLM."
            )
998

999
        return model_config._get_transformers_backend_cls()
1000

1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
    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
1026

1027
1028
    def inspect_model_cls(
        self,
1029
        architectures: str | list[str],
1030
        model_config: ModelConfig,
1031
    ) -> tuple[_ModelInfo, str]:
1032
1033
        if isinstance(architectures, str):
            architectures = [architectures]
1034
1035
        if not architectures:
            raise ValueError("No model architectures are specified")
1036
1037

        # Require transformers impl
1038
        if model_config.model_impl == "transformers":
1039
            arch = self._try_resolve_transformers(architectures[0], model_config)
1040
1041
1042
1043
            if arch is not None:
                model_info = self._try_inspect_model_cls(arch)
                if model_info is not None:
                    return (model_info, arch)
1044
        elif model_config.model_impl == "terratorch":
1045
1046
            model_info = self._try_inspect_model_cls("Terratorch")
            return (model_info, "Terratorch")
1047

1048
        # Fallback to transformers impl (after resolving convert_type)
1049
1050
1051
1052
1053
1054
        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)
1055
1056
1057
1058
1059
1060
1061
            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)
1062
            model_info = self._try_inspect_model_cls(normalized_arch)
1063
            if model_info is not None:
1064
                return (model_info, arch)
1065

1066
        # Fallback to transformers impl (before resolving runner_type)
1067
1068
1069
1070
1071
        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)
1072
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
        return self._raise_for_unsupported(architectures)
1078

1079
1080
    def resolve_model_cls(
        self,
1081
        architectures: str | list[str],
1082
        model_config: ModelConfig,
1083
    ) -> tuple[type[nn.Module], str]:
1084
1085
        if isinstance(architectures, str):
            architectures = [architectures]
1086
1087
        if not architectures:
            raise ValueError("No model architectures are specified")
1088
1089

        # Require transformers impl
1090
        if model_config.model_impl == "transformers":
1091
            arch = self._try_resolve_transformers(architectures[0], model_config)
1092
1093
1094
1095
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)
1096
        elif model_config.model_impl == "terratorch":
1097
1098
1099
1100
            arch = "Terratorch"
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
1101

1102
        # Fallback to transformers impl (after resolving convert_type)
1103
1104
1105
1106
1107
1108
        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)
1109
1110
1111
1112
1113
1114
1115
            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)
1116
            model_cls = self._try_load_model_cls(normalized_arch)
1117
1118
            if model_cls is not None:
                return (model_cls, arch)
1119

1120
        # Fallback to transformers impl (before resolving runner_type)
1121
1122
1123
1124
1125
        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)
1126
1127
1128
1129
1130
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1131
        return self._raise_for_unsupported(architectures)
1132

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

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

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

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

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

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

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

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

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

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

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

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

1229

1230
1231
1232
1233
1234
1235
1236
1237
1238
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()
    }
)
1239
1240
1241
1242
1243

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1244
1245
1246
1247
1248
    # 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")

1249
        # `cloudpickle` allows pickling lambda functions directly
1250
        import cloudpickle
1251

1252
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1253
1254
1255

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
1256
1257
1258
        returned = subprocess.run(
            _SUBPROCESS_COMMAND, input=input_bytes, capture_output=True
        )
1259
1260
1261
1262
1263
1264

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

1269
        with open(output_filepath, "rb") as f:
1270
1271
1272
1273
1274
1275
            return pickle.load(f)


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

1277
1278
1279
1280
1281
    load_general_plugins()

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

    result = fn()
1282
1283
1284

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1285
1286
1287


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