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

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

import torch.nn as nn
23
import transformers
24

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

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


46
47
48
49
50
from .interfaces import (
    has_inner_state,
    has_noops,
    is_attention_free,
    is_hybrid,
Patrick von Platen's avatar
Patrick von Platen committed
51
    requires_raw_input_tokens,
52
    supports_mamba_prefix_caching,
53
54
55
56
57
58
59
    supports_multimodal,
    supports_multimodal_encoder_tp_data,
    supports_multimodal_raw_input_only,
    supports_pp,
    supports_transcription,
)
from .interfaces_base import (
60
    get_attn_type,
61
62
    get_default_seq_pooling_type,
    get_default_tok_pooling_type,
63
    get_score_type,
64
65
66
    is_pooling_model,
    is_text_generation_model,
)
67
68
69

logger = init_logger(__name__)

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

_EMBEDDING_MODELS = {
215
    # [Text-only]
216
    "BertModel": ("bert", "BertEmbeddingModel"),
217
    "BertSpladeSparseEmbeddingModel": ("bert", "BertSpladeSparseEmbeddingModel"),
218
    "ErnieModel": ("ernie", "ErnieEmbeddingModel"),
219
    "BgeM3EmbeddingModel": ("roberta", "BgeM3EmbeddingModel"),
220
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
221
    "Gemma2Model": ("gemma2", "Gemma2ForCausalLM"),
222
    "Gemma3TextModel": ("gemma3", "Gemma3Model"),
223
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
224
    "GritLM": ("gritlm", "GritLM"),
225
226
    "GteModel": ("bert_with_rope", "SnowflakeGteNewModel"),
    "GteNewModel": ("bert_with_rope", "GteNewModel"),
227
    "LlamaBidirectionalModel": ("llama", "LlamaBidirectionalModel"),
228
    "LlamaModel": ("llama", "LlamaForCausalLM"),
229
230
    **{
        # Multiple models share the same architecture, so we include them all
231
232
        k: (mod, arch)
        for k, (mod, arch) in _TEXT_GENERATION_MODELS.items()
233
234
        if arch == "LlamaForCausalLM"
    },
235
    "MistralModel": ("llama", "LlamaForCausalLM"),
236
    "ModernBertModel": ("modernbert", "ModernBertModel"),
237
    "NomicBertModel": ("bert_with_rope", "NomicBertModel"),
238
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
239
    "Qwen2Model": ("qwen2", "Qwen2ForCausalLM"),
240
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
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
    # [Multimodal]
251
    "CLIPModel": ("clip", "CLIPEmbeddingModel"),
252
    "ColPaliForRetrieval": ("colpali", "ColPaliModel"),
253
    "LlamaNemotronVLModel": ("nemotron_vl", "LlamaNemotronVLForEmbedding"),
254
255
256
    "LlavaNextForConditionalGeneration": (
        "llava_next",
        "LlavaNextForConditionalGeneration",
257
    ),
258
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
259
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),
260
    "SiglipModel": ("siglip", "SiglipEmbeddingModel"),
261
262
    # Technically Terratorch models work on images, both in
    # input and output. I am adding it here because it piggy-backs on embedding
263
    # models for the time being.
264
265
    "PrithviGeoSpatialMAE": ("terratorch", "Terratorch"),
    "Terratorch": ("terratorch", "Terratorch"),
266
267
}

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

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

_TOKEN_CLASSIFICATION_MODELS = {
290
    "BertForTokenClassification": ("bert", "BertForTokenClassification"),
291
    "ErnieForTokenClassification": ("ernie", "ErnieForTokenClassification"),
292
293
294
295
    "ModernBertForTokenClassification": (
        "modernbert",
        "ModernBertForTokenClassification",
    ),
296
297
298
299
    "Qwen3ASRForcedAlignerForTokenClassification": (
        "qwen3_asr_forced_aligner",
        "Qwen3ASRForcedAlignerForTokenClassification",
    ),
300
301
302
303
304
}

_SEQUENCE_CLASSIFICATION_MODELS = {
    "BertForSequenceClassification": ("bert", "BertForSequenceClassification"),
    "GPT2ForSequenceClassification": ("gpt2", "GPT2ForSequenceClassification"),
305
    "ErnieForSequenceClassification": ("ernie", "ErnieForSequenceClassification"),
306
307
308
309
    "GteNewForSequenceClassification": (
        "bert_with_rope",
        "GteNewForSequenceClassification",
    ),
310
    "JambaForSequenceClassification": ("jamba", "JambaForSequenceClassification"),
311
312
313
    "LlamaBidirectionalForSequenceClassification": (
        "llama",
        "LlamaBidirectionalForSequenceClassification",
314
    ),
315
316
317
318
319
320
321
322
323
    "ModernBertForSequenceClassification": (
        "modernbert",
        "ModernBertForSequenceClassification",
    ),
    "RobertaForSequenceClassification": ("roberta", "RobertaForSequenceClassification"),
    "XLMRobertaForSequenceClassification": (
        "roberta",
        "RobertaForSequenceClassification",
    ),
324
325
326
327
328
329
    # [Multimodal]
    "JinaVLForRanking": ("jina_vl", "JinaVLForSequenceClassification"),
    "LlamaNemotronVLForSequenceClassification": (
        "nemotron_vl",
        "LlamaNemotronVLForSequenceClassification",
    ),
330
331
}

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

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

584
_TRANSFORMERS_SUPPORTED_MODELS = {
585
586
587
    # Text generation models
    "SmolLM3ForCausalLM": ("transformers", "TransformersForCausalLM"),
    # Multimodal models
588
589
590
591
    "Emu3ForConditionalGeneration": (
        "transformers",
        "TransformersMultiModalForCausalLM",
    ),
592
593
594
}

_TRANSFORMERS_BACKEND_MODELS = {
595
    # Text generation models
596
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
    "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
615
    "TransformersForSequenceClassification": (
616
        "transformers",
617
        "TransformersForSequenceClassification",
618
    ),
619
    "TransformersMoEForSequenceClassification": (
620
        "transformers",
621
        "TransformersMoEForSequenceClassification",
622
    ),
623
624
625
    "TransformersMultiModalForSequenceClassification": (
        "transformers",
        "TransformersMultiModalForSequenceClassification",
626
    ),
627
}
628

629
_VLLM_MODELS = {
630
    **_TEXT_GENERATION_MODELS,
631
    **_EMBEDDING_MODELS,
632
633
634
635
    **_LATE_INTERACTION_MODELS,
    **_REWARD_MODELS,
    **_TOKEN_CLASSIFICATION_MODELS,
    **_SEQUENCE_CLASSIFICATION_MODELS,
636
    **_MULTIMODAL_MODELS,
637
    **_SPECULATIVE_DECODING_MODELS,
638
639
    **_TRANSFORMERS_SUPPORTED_MODELS,
    **_TRANSFORMERS_BACKEND_MODELS,
640
641
}

642
643
644
645
# 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.
646
_SUBPROCESS_COMMAND = [sys.executable, "-m", "vllm.model_executor.models.registry"]
647

648
_PREVIOUSLY_SUPPORTED_MODELS = {
649
    "MotifForCausalLM": "0.10.2",
650
    "Phi3SmallForCausalLM": "0.9.2",
651
    "Phi4FlashForCausalLM": "0.10.2",
652
    "Phi4MultimodalForCausalLM": "0.12.0",
653
654
655
656
657
    # encoder-decoder models except whisper
    # have been removed for V0 deprecation.
    "DonutForConditionalGeneration": "0.10.2",
    "MllamaForConditionalGeneration": "0.10.2",
}
658

659
660
661
662
663
664
665
_OOT_SUPPORTED_MODELS = {
    "BartModel": "https://github.com/vllm-project/bart-plugin",
    "BartForConditionalGeneration": "https://github.com/vllm-project/bart-plugin",
    "Florence2ForConditionalGeneration": "https://github.com/vllm-project/bart-plugin",
    "MBartForConditionalGeneration": "https://github.com/vllm-project/bart-plugin",
}

666

667
668
@dataclass(frozen=True)
class _ModelInfo:
669
    architecture: str
670
    is_text_generation_model: bool
671
    is_pooling_model: bool
672
    attn_type: AttnTypeStr
673
674
    default_seq_pooling_type: SequencePoolingType
    default_tok_pooling_type: TokenPoolingType
675
    score_type: ScoreType
676
    supports_multimodal: bool
677
    supports_multimodal_raw_input_only: bool
Patrick von Platen's avatar
Patrick von Platen committed
678
    requires_raw_input_tokens: bool
679
    supports_multimodal_encoder_tp_data: bool
680
    supports_pp: bool
681
682
    has_inner_state: bool
    is_attention_free: bool
683
    is_hybrid: bool
684
    has_noops: bool
685
    supports_mamba_prefix_caching: bool
686
    supports_transcription: bool
687
    supports_transcription_only: bool
688
689

    @staticmethod
690
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
691
        return _ModelInfo(
692
            architecture=model.__name__,
693
            is_text_generation_model=is_text_generation_model(model),
694
            is_pooling_model=is_pooling_model(model),
695
696
            default_seq_pooling_type=get_default_seq_pooling_type(model),
            default_tok_pooling_type=get_default_tok_pooling_type(model),
697
            attn_type=get_attn_type(model),
698
            score_type=get_score_type(model),
699
            supports_multimodal=supports_multimodal(model),
700
701
702
            supports_multimodal_raw_input_only=supports_multimodal_raw_input_only(
                model
            ),
Patrick von Platen's avatar
Patrick von Platen committed
703
            requires_raw_input_tokens=requires_raw_input_tokens(model),
704
705
706
            supports_multimodal_encoder_tp_data=supports_multimodal_encoder_tp_data(
                model
            ),
707
            supports_pp=supports_pp(model),
708
709
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
710
            is_hybrid=is_hybrid(model),
711
            supports_mamba_prefix_caching=supports_mamba_prefix_caching(model),
712
            supports_transcription=supports_transcription(model),
713
714
715
            supports_transcription_only=(
                supports_transcription(model) and model.supports_transcription_only
            ),
716
            has_noops=has_noops(model),
717
        )
718
719


720
721
722
723
class _BaseRegisteredModel(ABC):
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
724

725
    @abstractmethod
726
    def load_model_cls(self) -> type[nn.Module]:
727
        raise NotImplementedError
728
729


730
731
732
733
734
735
736
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
737
    model_cls: type[nn.Module]
738
739

    @staticmethod
740
    def from_model_cls(model_cls: type[nn.Module]):
741
742
743
744
745
746
747
748
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

749
    def load_model_cls(self) -> type[nn.Module]:
750
751
752
753
754
755
756
757
        return self.model_cls


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

759
760
761
    module_name: str
    class_name: str

762
763
764
765
766
767
768
769
    @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"

770
    def _load_modelinfo_from_cache(self, module_hash: str) -> _ModelInfo | None:
771
772
        try:
            try:
773
                modelinfo_path = self._get_cache_dir() / self._get_cache_filename()
774
775
776
                with open(modelinfo_path, encoding="utf-8") as file:
                    mi_dict = json.load(file)
            except FileNotFoundError:
777
                logger.debug(
778
                    "Cached model info file for class %s.%s not found",
779
780
781
                    self.module_name,
                    self.class_name,
                )
782
783
784
                return None

            if mi_dict["hash"] != module_hash:
785
                logger.debug(
786
                    "Cached model info file for class %s.%s is stale",
787
788
789
                    self.module_name,
                    self.class_name,
                )
790
791
792
793
794
                return None

            # file not changed, use cached _ModelInfo properties
            return _ModelInfo(**mi_dict["modelinfo"])
        except Exception:
795
            logger.debug(
796
                "Cached model info for class %s.%s error. ",
797
798
799
                self.module_name,
                self.class_name,
            )
800
801
            return None

802
    def _save_modelinfo_to_cache(self, mi: _ModelInfo, module_hash: str) -> None:
803
804
        """save dictionary json file to cache"""
        from vllm.model_executor.model_loader.weight_utils import atomic_writer
805

806
807
808
809
810
811
812
813
        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()
814
            with atomic_writer(modelinfo_path, encoding="utf-8") as f:
815
816
817
818
819
                json.dump(modelinfo_dict, f, indent=2)
        except Exception:
            logger.exception("Error saving model info cache.")

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

824
825
        if model_path.exists():
            with open(model_path, "rb") as f:
826
                module_hash = safe_hash(f.read(), usedforsecurity=False).hexdigest()
827
828
829

            mi = self._load_modelinfo_from_cache(module_hash)
            if mi is not None:
830
                logger.debug(
831
                    "Loaded model info for class %s.%s from cache",
832
833
834
                    self.module_name,
                    self.class_name,
                )
835
836
                return mi
            else:
837
                logger.debug(
838
                    "Cache model info for class %s.%s miss. Loading model instead.",
839
840
841
                    self.module_name,
                    self.class_name,
                )
842
843
844

        # Performed in another process to avoid initializing CUDA
        mi = _run_in_subprocess(
845
846
847
848
849
            lambda: _ModelInfo.from_model_cls(self.load_model_cls())
        )
        logger.debug(
            "Loaded model info for class %s.%s", self.module_name, self.class_name
        )
850
851

        # save cache file
852
853
        if module_hash is not None:
            self._save_modelinfo_to_cache(mi, module_hash)
854
855

        return mi
856

857
    def load_model_cls(self) -> type[nn.Module]:
858
859
860
861
862
863
864
865
        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,
866
) -> type[nn.Module] | None:
867
    from vllm.platforms import current_platform
868

869
    current_platform.verify_model_arch(model_arch)
870
871
872
    try:
        return model.load_model_cls()
    except Exception:
873
        logger.exception("Error in loading model architecture '%s'", model_arch)
874
        return None
875
876


877
878
879
880
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
881
) -> _ModelInfo | None:
882
883
884
    try:
        return model.inspect_model_cls()
    except Exception:
885
        logger.exception("Error in inspecting model architecture '%s'", model_arch)
886
        return None
887
888


889
890
891
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
892
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
893

894
    def get_supported_archs(self) -> Set[str]:
895
        return self.models.keys()
896

897
898
899
    def register_model(
        self,
        model_arch: str,
900
        model_cls: type[nn.Module] | str,
901
    ) -> None:
902
903
904
        """
        Register an external model to be used in vLLM.

905
        `model_cls` can be either:
906

907
        - A [`torch.nn.Module`][] class directly referencing the model.
908
        - A string in the format `<module>:<class>` which can be used to
909
910
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
911
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
912
        """
913
914
915
916
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

917
        if model_arch in self.models:
918
919
            logger.warning(
                "Model architecture %s is already registered, and will be "
920
921
922
923
                "overwritten by the new model class %s.",
                model_arch,
                model_cls,
            )
924
925
926
927
928
929

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

931
            model = _LazyRegisteredModel(*split_str)
932
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
933
            model = _RegisteredModel.from_model_cls(model_cls)
934
        else:
935
936
937
938
            msg = (
                "`model_cls` should be a string or PyTorch model class, "
                f"not a {type(model_arch)}"
            )
939
            raise TypeError(msg)
940

941
        self.models[model_arch] = model
942

943
    def _raise_for_unsupported(self, architectures: list[str]):
944
        all_supported_archs = self.get_supported_archs()
945

946
947
948
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
949
950
                "to be inspected. Please check the logs for more details."
            )
951

952
953
954
955
956
957
958
959
        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 "
960
961
                    "use this model architecture."
                )
962
963
964
965
966
967
968
969
            if arch in _OOT_SUPPORTED_MODELS:
                plugin_url = _OOT_SUPPORTED_MODELS[arch]

                raise ValueError(
                    f"Model architecture {arch} is not supported in-tree anymore. "
                    f"Please install the plugin at {plugin_url} if you want to "
                    "use this model architecture."
                )
970

971
972
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
973
974
            f"Supported architectures: {all_supported_archs}"
        )
975

976
    def _try_load_model_cls(self, model_arch: str) -> type[nn.Module] | None:
977
978
        if model_arch not in self.models:
            return None
979

980
        return _try_load_model_cls(model_arch, self.models[model_arch])
981

982
    def _try_inspect_model_cls(self, model_arch: str) -> _ModelInfo | None:
983
984
        if model_arch not in self.models:
            return None
985

986
987
988
989
990
991
        return _try_inspect_model_cls(model_arch, self.models[model_arch])

    def _try_resolve_transformers(
        self,
        architecture: str,
        model_config: ModelConfig,
992
    ) -> str | None:
993
994
995
        if architecture in _TRANSFORMERS_BACKEND_MODELS:
            return architecture

996
997
998
        auto_map: dict[str, str] = (
            getattr(model_config.hf_config, "auto_map", None) or dict()
        )
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014

        # 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,
1015
                        trust_remote_code=model_config.trust_remote_code,
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
                        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,
1028
                        trust_remote_code=model_config.trust_remote_code,
1029
1030
1031
1032
1033
                        warn_on_fail=True,
                    )
                    if model_module is not None:
                        break
            else:
1034
                if model_config.model_impl != "transformers":
1035
1036
1037
1038
1039
1040
1041
                    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 "
1042
1043
                    "'auto_map' (relevant if the model is custom)."
                )
1044
1045

        if not model_module.is_backend_compatible():
1046
            if model_config.model_impl != "transformers":
1047
                return None
1048

1049
1050
            raise ValueError(
                f"The Transformers implementation of {architecture!r} "
1051
1052
                "is not compatible with vLLM."
            )
1053

1054
        return model_config._get_transformers_backend_cls()
1055

1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
    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
1081

1082
1083
    def inspect_model_cls(
        self,
1084
        architectures: str | list[str],
1085
        model_config: ModelConfig,
1086
    ) -> tuple[_ModelInfo, str]:
1087
1088
        if isinstance(architectures, str):
            architectures = [architectures]
1089
1090
        if not architectures:
            raise ValueError("No model architectures are specified")
1091
1092

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

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

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

1132
        return self._raise_for_unsupported(architectures)
1133

1134
1135
    def resolve_model_cls(
        self,
1136
        architectures: str | list[str],
1137
        model_config: ModelConfig,
1138
    ) -> tuple[type[nn.Module], str]:
1139
1140
        if isinstance(architectures, str):
            architectures = [architectures]
1141
1142
        if not architectures:
            raise ValueError("No model architectures are specified")
1143
1144

        # Require transformers impl
1145
        if model_config.model_impl == "transformers":
1146
            arch = self._try_resolve_transformers(architectures[0], model_config)
1147
1148
1149
1150
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)
1151
        elif model_config.model_impl == "terratorch":
1152
1153
1154
1155
            arch = "Terratorch"
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
1156

1157
        # Fallback to transformers impl (after resolving convert_type)
1158
1159
1160
1161
1162
1163
        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)
1164
1165
1166
1167
1168
1169
1170
            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)
1171
            model_cls = self._try_load_model_cls(normalized_arch)
1172
1173
            if model_cls is not None:
                return (model_cls, arch)
1174

1175
        # Fallback to transformers impl (before resolving runner_type)
1176
1177
1178
1179
1180
        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)
1181
1182
1183
1184
1185
            if arch is not None:
                model_cls = self._try_load_model_cls(arch)
                if model_cls is not None:
                    return (model_cls, arch)

1186
        return self._raise_for_unsupported(architectures)
1187

1188
1189
    def is_text_generation_model(
        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.is_text_generation_model
1195

1196
    def is_pooling_model(
1197
        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_pooling_model
1203
1204
1205

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

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

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

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

1236
1237
    def is_attention_free_model(
        self,
1238
        architectures: str | list[str],
1239
        model_config: ModelConfig,
1240
    ) -> bool:
1241
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1242
        return model_cls.is_attention_free
1243

1244
1245
    def is_hybrid_model(
        self,
1246
        architectures: str | list[str],
1247
        model_config: ModelConfig,
1248
    ) -> bool:
1249
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1250
1251
        return model_cls.is_hybrid

1252
1253
    def is_noops_model(
        self,
1254
        architectures: str | list[str],
1255
        model_config: ModelConfig,
1256
    ) -> bool:
1257
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1258
1259
        return model_cls.has_noops

1260
1261
    def is_transcription_model(
        self,
1262
        architectures: str | list[str],
1263
        model_config: ModelConfig,
1264
    ) -> bool:
1265
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1266
1267
        return model_cls.supports_transcription

1268
1269
    def is_transcription_only_model(
        self,
1270
        architectures: str | list[str],
1271
        model_config: ModelConfig,
1272
    ) -> bool:
1273
        model_cls, _ = self.inspect_model_cls(architectures, model_config)
1274
1275
        return model_cls.supports_transcription_only

1276

1277
1278
1279
1280
1281
1282
1283
1284
1285
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()
    }
)
1286
1287
1288
1289
1290

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
1291
1292
1293
1294
1295
    # 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")

1296
        # `cloudpickle` allows pickling lambda functions directly
1297
        import cloudpickle
1298

1299
        input_bytes = cloudpickle.dumps((fn, output_filepath))
1300
1301
1302

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
1303
1304
1305
        returned = subprocess.run(
            _SUBPROCESS_COMMAND, input=input_bytes, capture_output=True
        )
1306
1307
1308
1309
1310
1311

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

1316
        with open(output_filepath, "rb") as f:
1317
1318
1319
1320
1321
1322
            return pickle.load(f)


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

1324
1325
1326
1327
1328
    load_general_plugins()

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

    result = fn()
1329
1330
1331

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
1332
1333
1334


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