registry.py 28.4 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
import importlib
8
import os
9
import pickle
10
11
import subprocess
import sys
12
import tempfile
13
from abc import ABC, abstractmethod
14
from collections.abc import Set
15
from dataclasses import asdict, dataclass, field
16
from functools import lru_cache
17
from typing import Callable, Optional, TypeVar, Union
18
19
20
21
22

import torch.nn as nn

from vllm.logger import init_logger

23
24
25
26
from .interfaces import (has_inner_state, has_noops, is_attention_free,
                         is_hybrid, supports_cross_encoding,
                         supports_multimodal, supports_pp,
                         supports_transcription, supports_v0_only)
27
from .interfaces_base import is_text_generation_model
28
29
30

logger = init_logger(__name__)

31
# yapf: disable
32
33
_TEXT_GENERATION_MODELS = {
    # [Decoder-only]
34
35
    "AquilaModel": ("llama", "LlamaForCausalLM"),
    "AquilaForCausalLM": ("llama", "LlamaForCausalLM"),  # AquilaChat2
Raghav Ravishankar's avatar
Raghav Ravishankar committed
36
    "ArceeForCausalLM": ("arcee", "ArceeForCausalLM"),
37
    "ArcticForCausalLM": ("arctic", "ArcticForCausalLM"),
38
    "MiniMaxForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
39
    "MiniMaxText01ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
40
    "MiniMaxM1ForCausalLM": ("minimax_text_01", "MiniMaxText01ForCausalLM"),
41
42
43
44
    # baichuan-7b, upper case 'C' in the class name
    "BaiChuanForCausalLM": ("baichuan", "BaiChuanForCausalLM"),
    # baichuan-13b, lower case 'c' in the class name
    "BaichuanForCausalLM": ("baichuan", "BaichuanForCausalLM"),
45
    "BailingMoeForCausalLM": ("bailing_moe", "BailingMoeForCausalLM"),
Yu Chin Fabian Lim's avatar
Yu Chin Fabian Lim committed
46
    "BambaForCausalLM": ("bamba", "BambaForCausalLM"),
47
    "BloomForCausalLM": ("bloom", "BloomForCausalLM"),
48
    "ChatGLMModel": ("chatglm", "ChatGLMForCausalLM"),
49
    "ChatGLMForConditionalGeneration": ("chatglm", "ChatGLMForCausalLM"),
50
    "CohereForCausalLM": ("commandr", "CohereForCausalLM"),
51
    "Cohere2ForCausalLM": ("commandr", "CohereForCausalLM"),
52
    "DbrxForCausalLM": ("dbrx", "DbrxForCausalLM"),
53
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
54
55
    "DeepseekForCausalLM": ("deepseek", "DeepseekForCausalLM"),
    "DeepseekV2ForCausalLM": ("deepseek_v2", "DeepseekV2ForCausalLM"),
56
    "DeepseekV3ForCausalLM": ("deepseek_v2", "DeepseekV3ForCausalLM"),
57
    "Dots1ForCausalLM": ("dots1", "Dots1ForCausalLM"),
58
59
    "Ernie4_5_ForCausalLM": ("ernie45", "Ernie4_5_ForCausalLM"),
    "Ernie4_5_MoeForCausalLM": ("ernie45_moe", "Ernie4_5_MoeForCausalLM"),
60
    "ExaoneForCausalLM": ("exaone", "ExaoneForCausalLM"),
61
    "Exaone4ForCausalLM": ("exaone4", "Exaone4ForCausalLM"),
62
    "FalconForCausalLM": ("falcon", "FalconForCausalLM"),
63
    "Fairseq2LlamaForCausalLM": ("fairseq2_llama", "Fairseq2LlamaForCausalLM"),
64
65
    "GemmaForCausalLM": ("gemma", "GemmaForCausalLM"),
    "Gemma2ForCausalLM": ("gemma2", "Gemma2ForCausalLM"),
66
    "Gemma3ForCausalLM": ("gemma3", "Gemma3ForCausalLM"),
Robert Shaw's avatar
Robert Shaw committed
67
68
    #TODO(ywang96): Support multimodal gemma3n
    "Gemma3nForConditionalGeneration": ("gemma3n", "Gemma3nForConditionalGeneration"),    # noqa: E501
69
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
70
    "Glm4ForCausalLM": ("glm4", "Glm4ForCausalLM"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
71
    "Glm4MoeForCausalLM": ("glm4_moe", "Glm4MoeForCausalLM"),
72
73
74
75
76
77
    "GPT2LMHeadModel": ("gpt2", "GPT2LMHeadModel"),
    "GPTBigCodeForCausalLM": ("gpt_bigcode", "GPTBigCodeForCausalLM"),
    "GPTJForCausalLM": ("gpt_j", "GPTJForCausalLM"),
    "GPTNeoXForCausalLM": ("gpt_neox", "GPTNeoXForCausalLM"),
    "GraniteForCausalLM": ("granite", "GraniteForCausalLM"),
    "GraniteMoeForCausalLM": ("granitemoe", "GraniteMoeForCausalLM"),
78
    "GraniteMoeHybridForCausalLM": ("granitemoehybrid", "GraniteMoeHybridForCausalLM"),   # noqa: E501
79
    "GraniteMoeSharedForCausalLM": ("granitemoeshared", "GraniteMoeSharedForCausalLM"),   # noqa: E501
80
    "GritLM": ("gritlm", "GritLM"),
Michael Goin's avatar
Michael Goin committed
81
    "Grok1ModelForCausalLM": ("grok1", "Grok1ForCausalLM"),
82
    "HunYuanMoEV1ForCausalLM": ("hunyuan_v1_moe", "HunYuanMoEV1ForCausalLM"),
83
84
    "InternLMForCausalLM": ("llama", "LlamaForCausalLM"),
    "InternLM2ForCausalLM": ("internlm2", "InternLM2ForCausalLM"),
85
    "InternLM2VEForCausalLM": ("internlm2_ve", "InternLM2VEForCausalLM"),
86
    "InternLM3ForCausalLM": ("llama", "LlamaForCausalLM"),
87
88
89
90
91
    "JAISLMHeadModel": ("jais", "JAISLMHeadModel"),
    "JambaForCausalLM": ("jamba", "JambaForCausalLM"),
    "LlamaForCausalLM": ("llama", "LlamaForCausalLM"),
    # For decapoda-research/llama-*
    "LLaMAForCausalLM": ("llama", "LlamaForCausalLM"),
92
    "MambaForCausalLM": ("mamba", "MambaForCausalLM"),
93
    "FalconMambaForCausalLM": ("mamba", "MambaForCausalLM"),
Dhia Eddine Rhaiem's avatar
Dhia Eddine Rhaiem committed
94
    "FalconH1ForCausalLM":("falcon_h1", "FalconH1ForCausalLM"),
95
    "Mamba2ForCausalLM": ("mamba2", "Mamba2ForCausalLM"),
96
97
    "MiniCPMForCausalLM": ("minicpm", "MiniCPMForCausalLM"),
    "MiniCPM3ForCausalLM": ("minicpm3", "MiniCPM3ForCausalLM"),
98
99
100
101
102
103
    "MistralForCausalLM": ("llama", "LlamaForCausalLM"),
    "MixtralForCausalLM": ("mixtral", "MixtralForCausalLM"),
    "QuantMixtralForCausalLM": ("mixtral_quant", "MixtralForCausalLM"),
    # transformers's mpt class has lower case
    "MptForCausalLM": ("mpt", "MPTForCausalLM"),
    "MPTForCausalLM": ("mpt", "MPTForCausalLM"),
104
    "MiMoForCausalLM": ("mimo", "MiMoForCausalLM"),
105
    "NemotronForCausalLM": ("nemotron", "NemotronForCausalLM"),
Luis Vega's avatar
Luis Vega committed
106
    "NemotronHForCausalLM": ("nemotron_h", "NemotronHForCausalLM"),
107
    "OlmoForCausalLM": ("olmo", "OlmoForCausalLM"),
108
    "Olmo2ForCausalLM": ("olmo2", "Olmo2ForCausalLM"),
109
110
111
112
113
114
115
    "OlmoeForCausalLM": ("olmoe", "OlmoeForCausalLM"),
    "OPTForCausalLM": ("opt", "OPTForCausalLM"),
    "OrionForCausalLM": ("orion", "OrionForCausalLM"),
    "PersimmonForCausalLM": ("persimmon", "PersimmonForCausalLM"),
    "PhiForCausalLM": ("phi", "PhiForCausalLM"),
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
    "PhiMoEForCausalLM": ("phimoe", "PhiMoEForCausalLM"),
116
    "Phi4FlashForCausalLM": ("phi4flash", "Phi4FlashForCausalLM"),
Shinichi Hemmi's avatar
Shinichi Hemmi committed
117
    "Plamo2ForCausalLM": ("plamo2", "Plamo2ForCausalLM"),
118
    "QWenLMHeadModel": ("qwen", "QWenLMHeadModel"),
119
120
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
    "Qwen2MoeForCausalLM": ("qwen2_moe", "Qwen2MoeForCausalLM"),
121
122
    "Qwen3ForCausalLM": ("qwen3", "Qwen3ForCausalLM"),
    "Qwen3MoeForCausalLM": ("qwen3_moe", "Qwen3MoeForCausalLM"),
123
124
125
126
127
    "RWForCausalLM": ("falcon", "FalconForCausalLM"),
    "StableLMEpochForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "StableLmForCausalLM": ("stablelm", "StablelmForCausalLM"),
    "Starcoder2ForCausalLM": ("starcoder2", "Starcoder2ForCausalLM"),
    "SolarForCausalLM": ("solar", "SolarForCausalLM"),
128
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
129
    "TeleFLMForCausalLM": ("teleflm", "TeleFLMForCausalLM"),
130
    "XverseForCausalLM": ("llama", "LlamaForCausalLM"),
131
    "Zamba2ForCausalLM": ("zamba2", "Zamba2ForCausalLM"),
132
133
134
    # [Encoder-decoder]
    "BartModel": ("bart", "BartForConditionalGeneration"),
    "BartForConditionalGeneration": ("bart", "BartForConditionalGeneration"),
135
136
137
}

_EMBEDDING_MODELS = {
138
    # [Text-only]
139
    "BertModel": ("bert", "BertEmbeddingModel"),
140
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
141
    "Gemma2Model": ("gemma2", "Gemma2ForCausalLM"),
142
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
143
    "GPT2ForSequenceClassification": ("gpt2", "GPT2ForSequenceClassification"),
144
    "GritLM": ("gritlm", "GritLM"),
145
146
    "GteModel": ("bert_with_rope", "SnowflakeGteNewModel"),
    "GteNewModel": ("bert_with_rope", "GteNewModel"),
147
    "InternLM2ForRewardModel": ("internlm2", "InternLM2ForRewardModel"),
148
    "JambaForSequenceClassification": ("jamba", "JambaForSequenceClassification"),  # noqa: E501
149
    "LlamaModel": ("llama", "LlamaForCausalLM"),
150
151
152
153
154
    **{
        # Multiple models share the same architecture, so we include them all
        k: (mod, arch) for k, (mod, arch) in _TEXT_GENERATION_MODELS.items()
        if arch == "LlamaForCausalLM"
    },
155
    "MistralModel": ("llama", "LlamaForCausalLM"),
156
    "ModernBertModel": ("modernbert", "ModernBertModel"),
157
    "NomicBertModel": ("bert_with_rope", "NomicBertModel"),
158
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
159
    "Qwen2Model": ("qwen2", "Qwen2ForCausalLM"),
160
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
161
    "Qwen2ForRewardModel": ("qwen2_rm", "Qwen2ForRewardModel"),
162
    "Qwen2ForProcessRewardModel": ("qwen2_rm", "Qwen2ForProcessRewardModel"),
163
164
    "RobertaForMaskedLM": ("roberta", "RobertaEmbeddingModel"),
    "RobertaModel": ("roberta", "RobertaEmbeddingModel"),
165
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
166
    "XLMRobertaModel": ("roberta", "RobertaEmbeddingModel"),
167
    # [Multimodal]
Cyrus Leung's avatar
Cyrus Leung committed
168
    "LlavaNextForConditionalGeneration": ("llava_next", "LlavaNextForConditionalGeneration"),  # noqa: E501
169
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
170
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
171
172
173
174
    # Technically PrithviGeoSpatialMAE is a model that works on images, both in
    # input and output. I am adding it here because it piggy-backs on embedding
    # models for the time being.
    "PrithviGeoSpatialMAE": ("prithvi_geospatial_mae", "PrithviGeoSpatialMAE"),
175
176
}

177
178
179
180
181
182
_CROSS_ENCODER_MODELS = {
    "BertForSequenceClassification": ("bert", "BertForSequenceClassification"),
    "RobertaForSequenceClassification": ("roberta",
                                         "RobertaForSequenceClassification"),
    "XLMRobertaForSequenceClassification": ("roberta",
                                            "RobertaForSequenceClassification"),
xsank's avatar
xsank committed
183
184
    "ModernBertForSequenceClassification": ("modernbert",
                                            "ModernBertForSequenceClassification"),
185
    # [Auto-converted (see adapters.py)]
186
    "JinaVLForRanking": ("jina_vl", "JinaVLForSequenceClassification"), # noqa: E501,
187
188
}

189
_MULTIMODAL_MODELS = {
190
    # [Decoder-only]
191
    "AriaForConditionalGeneration": ("aria", "AriaForConditionalGeneration"),
Jennifer Zhao's avatar
Jennifer Zhao committed
192
    "AyaVisionForConditionalGeneration": ("aya_vision", "AyaVisionForConditionalGeneration"),  # noqa: E501
193
194
    "Blip2ForConditionalGeneration": ("blip2", "Blip2ForConditionalGeneration"),
    "ChameleonForConditionalGeneration": ("chameleon", "ChameleonForConditionalGeneration"),  # noqa: E501
195
    "DeepseekVLV2ForCausalLM": ("deepseek_vl2", "DeepseekVLV2ForCausalLM"),
196
    "FuyuForCausalLM": ("fuyu", "FuyuForCausalLM"),
197
    "Gemma3ForConditionalGeneration": ("gemma3_mm", "Gemma3ForConditionalGeneration"),  # noqa: E501
198
    "GLM4VForCausalLM": ("glm4v", "GLM4VForCausalLM"),
199
    "Glm4vForConditionalGeneration": ("glm4_1v", "Glm4vForConditionalGeneration"),  # noqa: E501
200
    "GraniteSpeechForConditionalGeneration": ("granite_speech", "GraniteSpeechForConditionalGeneration"),  # noqa: E501
201
    "H2OVLChatModel": ("h2ovl", "H2OVLChatModel"),
202
    "InternVLChatModel": ("internvl", "InternVLChatModel"),
203
    "Idefics3ForConditionalGeneration":("idefics3","Idefics3ForConditionalGeneration"),
204
    "SmolVLMForConditionalGeneration": ("smolvlm","SmolVLMForConditionalGeneration"),  # noqa: E501
205
    "KeyeForConditionalGeneration": ("keye", "KeyeForConditionalGeneration"),
206
    "KimiVLForConditionalGeneration": ("kimi_vl", "KimiVLForConditionalGeneration"),  # noqa: E501
207
    "Llama_Nemotron_Nano_VL": ("nemotron_vl", "LlamaNemotronVLChatModel"),
208
209
210
211
    "LlavaForConditionalGeneration": ("llava", "LlavaForConditionalGeneration"),
    "LlavaNextForConditionalGeneration": ("llava_next", "LlavaNextForConditionalGeneration"),  # noqa: E501
    "LlavaNextVideoForConditionalGeneration": ("llava_next_video", "LlavaNextVideoForConditionalGeneration"),  # noqa: E501
    "LlavaOnevisionForConditionalGeneration": ("llava_onevision", "LlavaOnevisionForConditionalGeneration"),  # noqa: E501
212
    "MantisForConditionalGeneration": ("llava", "MantisForConditionalGeneration"),  # noqa: E501
213
    "MiniMaxVL01ForConditionalGeneration": ("minimax_vl_01", "MiniMaxVL01ForConditionalGeneration"),  # noqa: E501
214
    "MiniCPMO": ("minicpmo", "MiniCPMO"),
215
    "MiniCPMV": ("minicpmv", "MiniCPMV"),
216
    "Mistral3ForConditionalGeneration": ("mistral3", "Mistral3ForConditionalGeneration"),  # noqa: E501
217
    "MolmoForCausalLM": ("molmo", "MolmoForCausalLM"),
218
    "NVLM_D": ("nvlm_d", "NVLM_D_Model"),
219
    "Ovis": ("ovis", "Ovis"),
220
    "PaliGemmaForConditionalGeneration": ("paligemma", "PaliGemmaForConditionalGeneration"),  # noqa: E501
221
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
222
    "PixtralForConditionalGeneration": ("pixtral", "PixtralForConditionalGeneration"),  # noqa: E501
223
    "QwenVLForConditionalGeneration": ("qwen_vl", "QwenVLForConditionalGeneration"),  # noqa: E501
224
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
Roger Wang's avatar
Roger Wang committed
225
    "Qwen2_5_VLForConditionalGeneration": ("qwen2_5_vl", "Qwen2_5_VLForConditionalGeneration"),  # noqa: E501
226
    "Qwen2AudioForConditionalGeneration": ("qwen2_audio", "Qwen2AudioForConditionalGeneration"),  # noqa: E501
227
    "Qwen2_5OmniModel": ("qwen2_5_omni_thinker", "Qwen2_5OmniThinkerForConditionalGeneration"),  # noqa: E501
228
    "Qwen2_5OmniForConditionalGeneration": ("qwen2_5_omni_thinker", "Qwen2_5OmniThinkerForConditionalGeneration"),  # noqa: E501
229
    "UltravoxModel": ("ultravox", "UltravoxModel"),
230
    "Phi4MMForCausalLM": ("phi4mm", "Phi4MMForCausalLM"),
汪志鹏's avatar
汪志鹏 committed
231
    "TarsierForConditionalGeneration": ("tarsier", "TarsierForConditionalGeneration"),  # noqa: E501
232
    "Tarsier2ForConditionalGeneration": ("qwen2_vl", "Tarsier2ForConditionalGeneration"),  # noqa: E501
Patrick von Platen's avatar
Patrick von Platen committed
233
    "VoxtralForConditionalGeneration": ("voxtral", "VoxtralForConditionalGeneration"),  # noqa: E501
234
    # [Encoder-decoder]
235
    "Florence2ForConditionalGeneration": ("florence2", "Florence2ForConditionalGeneration"),  # noqa: E501
236
    "MllamaForConditionalGeneration": ("mllama", "MllamaForConditionalGeneration"),  # noqa: E501
237
    "Llama4ForConditionalGeneration": ("mllama4", "Llama4ForConditionalGeneration"),  # noqa: E501
238
    "SkyworkR1VChatModel": ("skyworkr1v", "SkyworkR1VChatModel"),
239
    "WhisperForConditionalGeneration": ("whisper", "WhisperForConditionalGeneration"),  # noqa: E501
240
}
241
242

_SPECULATIVE_DECODING_MODELS = {
243
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
244
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
zhiweiz's avatar
zhiweiz committed
245
    "EagleLlama4ForCausalLM": ("llama4_eagle", "EagleLlama4ForCausalLM"),
246
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
247
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
248
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
Yuxuan Zhang's avatar
Yuxuan Zhang committed
249
    "Glm4MoeMTPModel": ("glm4_moe_mtp", "Glm4MoeMTP"),
250
    "MedusaModel": ("medusa", "Medusa"),
251
252
253
    # Temporarily disabled.
    # # TODO(woosuk): Re-enable this once the MLP Speculator is supported in V1.
    # "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
254
}
255

256
_TRANSFORMERS_MODELS = {
257
    "TransformersForMultimodalLM": ("transformers", "TransformersForMultimodalLM"), # noqa: E501
258
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
259
}
260
# yapf: enable
261

262
_VLLM_MODELS = {
263
    **_TEXT_GENERATION_MODELS,
264
    **_EMBEDDING_MODELS,
265
    **_CROSS_ENCODER_MODELS,
266
    **_MULTIMODAL_MODELS,
267
    **_SPECULATIVE_DECODING_MODELS,
268
    **_TRANSFORMERS_MODELS,
269
270
}

271
272
273
274
275
276
277
278
# 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.
_SUBPROCESS_COMMAND = [
    sys.executable, "-m", "vllm.model_executor.models.registry"
]

279

280
281
@dataclass(frozen=True)
class _ModelInfo:
282
    architecture: str
283
    is_text_generation_model: bool
284
    is_pooling_model: bool
285
    supports_cross_encoding: bool
286
287
    supports_multimodal: bool
    supports_pp: bool
288
289
    has_inner_state: bool
    is_attention_free: bool
290
    is_hybrid: bool
291
    has_noops: bool
292
    supports_transcription: bool
293
    supports_transcription_only: bool
294
    supports_v0_only: bool
295
296

    @staticmethod
297
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
298
        return _ModelInfo(
299
            architecture=model.__name__,
300
            is_text_generation_model=is_text_generation_model(model),
301
            is_pooling_model=True,  # Can convert any model into a pooling model
302
            supports_cross_encoding=supports_cross_encoding(model),
303
304
            supports_multimodal=supports_multimodal(model),
            supports_pp=supports_pp(model),
305
306
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
307
            is_hybrid=is_hybrid(model),
308
            supports_transcription=supports_transcription(model),
309
310
            supports_transcription_only=(supports_transcription(model) and
                                         model.supports_transcription_only),
311
            supports_v0_only=supports_v0_only(model),
312
            has_noops=has_noops(model),
313
        )
314
315


316
class _BaseRegisteredModel(ABC):
317

318
319
320
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
321

322
    @abstractmethod
323
    def load_model_cls(self) -> type[nn.Module]:
324
        raise NotImplementedError
325
326


327
328
329
330
331
332
333
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
334
    model_cls: type[nn.Module]
335
336

    @staticmethod
337
    def from_model_cls(model_cls: type[nn.Module]):
338
339
340
341
342
343
344
345
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

346
    def load_model_cls(self) -> type[nn.Module]:
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
        return self.model_cls


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

    # Performed in another process to avoid initializing CUDA
    def inspect_model_cls(self) -> _ModelInfo:
        return _run_in_subprocess(
            lambda: _ModelInfo.from_model_cls(self.load_model_cls()))

363
    def load_model_cls(self) -> type[nn.Module]:
364
365
366
367
368
369
370
371
        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,
372
) -> Optional[type[nn.Module]]:
373
    from vllm.platforms import current_platform
374
    current_platform.verify_model_arch(model_arch)
375
376
377
378
379
380
    try:
        return model.load_model_cls()
    except Exception:
        logger.exception("Error in loading model architecture '%s'",
                         model_arch)
        return None
381
382


383
384
385
386
387
388
389
390
391
392
393
@lru_cache(maxsize=128)
def _try_inspect_model_cls(
    model_arch: str,
    model: _BaseRegisteredModel,
) -> Optional[_ModelInfo]:
    try:
        return model.inspect_model_cls()
    except Exception:
        logger.exception("Error in inspecting model architecture '%s'",
                         model_arch)
        return None
394
395


396
397
398
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
399
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
400

401
    def get_supported_archs(self) -> Set[str]:
402
        return self.models.keys()
403

404
405
406
    def register_model(
        self,
        model_arch: str,
407
        model_cls: Union[type[nn.Module], str],
408
    ) -> None:
409
410
411
        """
        Register an external model to be used in vLLM.

412
        `model_cls` can be either:
413

414
        - A [`torch.nn.Module`][] class directly referencing the model.
415
        - A string in the format `<module>:<class>` which can be used to
416
417
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
418
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
419
        """
420
421
422
423
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

424
        if model_arch in self.models:
425
426
427
            logger.warning(
                "Model architecture %s is already registered, and will be "
                "overwritten by the new model class %s.", model_arch,
428
429
430
431
432
433
434
                model_cls)

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

436
            model = _LazyRegisteredModel(*split_str)
437
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
438
            model = _RegisteredModel.from_model_cls(model_cls)
439
440
441
442
        else:
            msg = ("`model_cls` should be a string or PyTorch model class, "
                   f"not a {type(model_arch)}")
            raise TypeError(msg)
443

444
        self.models[model_arch] = model
445

446
    def _raise_for_unsupported(self, architectures: list[str]):
447
        all_supported_archs = self.get_supported_archs()
448

449
450
451
452
453
        if any(arch in all_supported_archs for arch in architectures):
            raise ValueError(
                f"Model architectures {architectures} failed "
                "to be inspected. Please check the logs for more details.")

454
455
456
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
            f"Supported architectures: {all_supported_archs}")
457

458
    def _try_load_model_cls(self,
459
                            model_arch: str) -> Optional[type[nn.Module]]:
460
461
        if model_arch not in self.models:
            return None
462

463
        return _try_load_model_cls(model_arch, self.models[model_arch])
464

465
    def _try_inspect_model_cls(self, model_arch: str) -> Optional[_ModelInfo]:
466
467
468
469
470
471
472
473
        if model_arch in self.models:
            return _try_inspect_model_cls(model_arch, self.models[model_arch])

        if model_arch.endswith("ForSequenceClassification"):
            causal_lm_arch = model_arch.replace("ForSequenceClassification",
                                                "ForCausalLM")
            if causal_lm_arch not in self.models:
                return None
474

475
476
477
478
479
480
481
482
483
484
485
            info = _try_inspect_model_cls(causal_lm_arch,
                                          self.models[causal_lm_arch])

            info = _ModelInfo(**dict(
                asdict(info), **{
                    "architecture": model_arch,
                    "supports_cross_encoding": True
                }))
            return info

        return None
486

487
488
    def _normalize_archs(
        self,
489
490
        architectures: Union[str, list[str]],
    ) -> list[str]:
491
492
493
494
495
        if isinstance(architectures, str):
            architectures = [architectures]
        if not architectures:
            logger.warning("No model architectures are specified")

496
497
498
499
        # filter out support architectures
        normalized_arch = list(
            filter(lambda model: model in self.models, architectures))

500
501
502
503
504
505
506
507
508
        # try automatic conversion in adapters.py
        for arch in architectures:
            if not arch.endswith("ForSequenceClassification"):
                continue
            causal_lm_arch = arch.replace("ForSequenceClassification",
                                          "ForCausalLM")
            if causal_lm_arch in self.models:
                normalized_arch.append(arch)

509
510
511
512
513
514
515
516
        # NOTE(Isotr0py): Be careful of architectures' order!
        # Make sure Transformers backend architecture is at the end of the
        # list, otherwise pooling models automatic conversion will fail!
        for arch in normalized_arch:
            if arch.startswith("TransformersFor"):
                normalized_arch.remove(arch)
                normalized_arch.append(arch)

517
        return normalized_arch
518

519
520
    def inspect_model_cls(
        self,
521
522
        architectures: Union[str, list[str]],
    ) -> tuple[_ModelInfo, str]:
523
        architectures = self._normalize_archs(architectures)
524

525
526
527
        for arch in architectures:
            model_info = self._try_inspect_model_cls(arch)
            if model_info is not None:
528
                return (model_info, arch)
529

530
        return self._raise_for_unsupported(architectures)
531

532
533
    def resolve_model_cls(
        self,
534
535
        architectures: Union[str, list[str]],
    ) -> tuple[type[nn.Module], str]:
536
        architectures = self._normalize_archs(architectures)
537

538
539
540
541
        for arch in architectures:
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
542

543
        return self._raise_for_unsupported(architectures)
544

545
546
    def is_text_generation_model(
        self,
547
        architectures: Union[str, list[str]],
548
    ) -> bool:
549
550
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_text_generation_model
551

552
    def is_pooling_model(
553
        self,
554
        architectures: Union[str, list[str]],
555
    ) -> bool:
556
        model_cls, _ = self.inspect_model_cls(architectures)
557
        return model_cls.is_pooling_model
558

559
560
    def is_cross_encoder_model(
        self,
561
        architectures: Union[str, list[str]],
562
    ) -> bool:
563
564
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_cross_encoding
565

566
567
    def is_multimodal_model(
        self,
568
        architectures: Union[str, list[str]],
569
    ) -> bool:
570
571
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_multimodal
572
573
574

    def is_pp_supported_model(
        self,
575
        architectures: Union[str, list[str]],
576
    ) -> bool:
577
578
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_pp
579

580
581
    def model_has_inner_state(
        self,
582
        architectures: Union[str, list[str]],
583
584
585
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.has_inner_state
586

587
588
    def is_attention_free_model(
        self,
589
        architectures: Union[str, list[str]],
590
591
592
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_attention_free
593

594
595
    def is_hybrid_model(
        self,
596
        architectures: Union[str, list[str]],
597
598
599
600
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_hybrid

601
602
    def is_noops_model(
        self,
603
        architectures: Union[str, list[str]],
604
605
606
607
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.has_noops

608
609
    def is_transcription_model(
        self,
610
        architectures: Union[str, list[str]],
611
612
613
614
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_transcription

615
616
617
618
619
620
621
    def is_transcription_only_model(
        self,
        architectures: Union[str, list[str]],
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_transcription_only

622
623
    def is_v1_compatible(
        self,
624
        architectures: Union[str, list[str]],
625
626
627
628
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return not model_cls.supports_v0_only

629
630

ModelRegistry = _ModelRegistry({
631
632
    model_arch:
    _LazyRegisteredModel(
633
634
635
636
637
638
639
640
641
642
        module_name=f"vllm.model_executor.models.{mod_relname}",
        class_name=cls_name,
    )
    for model_arch, (mod_relname, cls_name) in _VLLM_MODELS.items()
})

_T = TypeVar("_T")


def _run_in_subprocess(fn: Callable[[], _T]) -> _T:
643
644
645
646
647
    # 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")

648
        # `cloudpickle` allows pickling lambda functions directly
649
        import cloudpickle
650
        input_bytes = cloudpickle.dumps((fn, output_filepath))
651
652
653

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
654
655
656
        returned = subprocess.run(_SUBPROCESS_COMMAND,
                                  input=input_bytes,
                                  capture_output=True)
657
658
659
660
661
662
663
664
665

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

666
        with open(output_filepath, "rb") as f:
667
668
669
670
671
672
673
674
675
676
677
            return pickle.load(f)


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

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

    result = fn()
678
679
680

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
681
682
683


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