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

_EMBEDDING_MODELS = {
136
    # [Text-only]
137
    "BertModel": ("bert", "BertEmbeddingModel"),
138
    "DeciLMForCausalLM": ("nemotron_nas", "DeciLMForCausalLM"),
139
    "Gemma2Model": ("gemma2", "Gemma2ForCausalLM"),
140
    "GlmForCausalLM": ("glm", "GlmForCausalLM"),
141
    "GPT2ForSequenceClassification": ("gpt2", "GPT2ForSequenceClassification"),
142
    "GritLM": ("gritlm", "GritLM"),
143
144
    "GteModel": ("bert_with_rope", "SnowflakeGteNewModel"),
    "GteNewModel": ("bert_with_rope", "GteNewModel"),
145
    "InternLM2ForRewardModel": ("internlm2", "InternLM2ForRewardModel"),
146
    "JambaForSequenceClassification": ("jamba", "JambaForSequenceClassification"),  # noqa: E501
147
    "LlamaModel": ("llama", "LlamaForCausalLM"),
148
149
150
151
152
    **{
        # 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"
    },
153
    "MistralModel": ("llama", "LlamaForCausalLM"),
154
    "ModernBertModel": ("modernbert", "ModernBertModel"),
155
    "NomicBertModel": ("bert_with_rope", "NomicBertModel"),
156
    "Phi3ForCausalLM": ("phi3", "Phi3ForCausalLM"),
157
    "Qwen2Model": ("qwen2", "Qwen2ForCausalLM"),
158
    "Qwen2ForCausalLM": ("qwen2", "Qwen2ForCausalLM"),
159
    "Qwen2ForRewardModel": ("qwen2_rm", "Qwen2ForRewardModel"),
160
    "Qwen2ForProcessRewardModel": ("qwen2_rm", "Qwen2ForProcessRewardModel"),
161
162
    "RobertaForMaskedLM": ("roberta", "RobertaEmbeddingModel"),
    "RobertaModel": ("roberta", "RobertaEmbeddingModel"),
163
    "TeleChat2ForCausalLM": ("telechat2", "TeleChat2ForCausalLM"),
164
    "XLMRobertaModel": ("roberta", "RobertaEmbeddingModel"),
165
    # [Multimodal]
Cyrus Leung's avatar
Cyrus Leung committed
166
    "LlavaNextForConditionalGeneration": ("llava_next", "LlavaNextForConditionalGeneration"),  # noqa: E501
167
    "Phi3VForCausalLM": ("phi3v", "Phi3VForCausalLM"),
168
    "Qwen2VLForConditionalGeneration": ("qwen2_vl", "Qwen2VLForConditionalGeneration"),  # noqa: E501
169
170
171
172
    # 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"),
173
174
}

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

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

_SPECULATIVE_DECODING_MODELS = {
244
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
245
    "EAGLEModel": ("eagle", "EAGLE"),
246
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
247
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
248
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
249
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
250
251
    "MedusaModel": ("medusa", "Medusa"),
    "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
252
}
253

254
_TRANSFORMERS_MODELS = {
255
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
256
}
257
# yapf: enable
258

259
_VLLM_MODELS = {
260
    **_TEXT_GENERATION_MODELS,
261
    **_EMBEDDING_MODELS,
262
    **_CROSS_ENCODER_MODELS,
263
    **_MULTIMODAL_MODELS,
264
    **_SPECULATIVE_DECODING_MODELS,
265
    **_TRANSFORMERS_MODELS,
266
267
}

268
269
270
271
272
273
274
275
# 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"
]

276

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

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


313
class _BaseRegisteredModel(ABC):
314

315
316
317
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
318

319
    @abstractmethod
320
    def load_model_cls(self) -> type[nn.Module]:
321
        raise NotImplementedError
322
323


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

    interfaces: _ModelInfo
331
    model_cls: type[nn.Module]
332
333

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

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

343
    def load_model_cls(self) -> type[nn.Module]:
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
        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()))

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


380
381
382
383
384
385
386
387
388
389
390
@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
391
392


393
394
395
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
396
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
397

398
    def get_supported_archs(self) -> Set[str]:
399
        return self.models.keys()
400

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

409
        `model_cls` can be either:
410

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

421
        if model_arch in self.models:
422
423
424
            logger.warning(
                "Model architecture %s is already registered, and will be "
                "overwritten by the new model class %s.", model_arch,
425
426
427
428
429
430
431
                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)
432

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

441
        self.models[model_arch] = model
442

443
    def _raise_for_unsupported(self, architectures: list[str]):
444
        all_supported_archs = self.get_supported_archs()
445

446
447
448
449
450
        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.")

451
452
453
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
            f"Supported architectures: {all_supported_archs}")
454

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

460
        return _try_load_model_cls(model_arch, self.models[model_arch])
461

462
463
464
    def _try_inspect_model_cls(self, model_arch: str) -> Optional[_ModelInfo]:
        if model_arch not in self.models:
            return None
465

466
        return _try_inspect_model_cls(model_arch, self.models[model_arch])
467

468
469
    def _normalize_archs(
        self,
470
471
        architectures: Union[str, list[str]],
    ) -> list[str]:
472
473
474
475
476
        if isinstance(architectures, str):
            architectures = [architectures]
        if not architectures:
            logger.warning("No model architectures are specified")

477
478
479
480
        # filter out support architectures
        normalized_arch = list(
            filter(lambda model: model in self.models, architectures))

481
        # make sure Transformers backend is put at the last as a fallback
482
        if len(normalized_arch) != len(architectures):
483
            normalized_arch.append("TransformersForCausalLM")
484
        return normalized_arch
485

486
487
    def inspect_model_cls(
        self,
488
489
        architectures: Union[str, list[str]],
    ) -> tuple[_ModelInfo, str]:
490
        architectures = self._normalize_archs(architectures)
491

492
493
494
        for arch in architectures:
            model_info = self._try_inspect_model_cls(arch)
            if model_info is not None:
495
                return (model_info, arch)
496

497
        return self._raise_for_unsupported(architectures)
498

499
500
    def resolve_model_cls(
        self,
501
502
        architectures: Union[str, list[str]],
    ) -> tuple[type[nn.Module], str]:
503
        architectures = self._normalize_archs(architectures)
504

505
506
507
508
        for arch in architectures:
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
509

510
        return self._raise_for_unsupported(architectures)
511

512
513
    def is_text_generation_model(
        self,
514
        architectures: Union[str, list[str]],
515
    ) -> bool:
516
517
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_text_generation_model
518

519
    def is_pooling_model(
520
        self,
521
        architectures: Union[str, list[str]],
522
    ) -> bool:
523
        model_cls, _ = self.inspect_model_cls(architectures)
524
        return model_cls.is_pooling_model
525

526
527
    def is_cross_encoder_model(
        self,
528
        architectures: Union[str, list[str]],
529
    ) -> bool:
530
531
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_cross_encoding
532

533
534
    def is_multimodal_model(
        self,
535
        architectures: Union[str, list[str]],
536
    ) -> bool:
537
538
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_multimodal
539
540
541

    def is_pp_supported_model(
        self,
542
        architectures: Union[str, list[str]],
543
    ) -> bool:
544
545
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.supports_pp
546

547
548
    def model_has_inner_state(
        self,
549
        architectures: Union[str, list[str]],
550
551
552
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.has_inner_state
553

554
555
    def is_attention_free_model(
        self,
556
        architectures: Union[str, list[str]],
557
558
559
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_attention_free
560

561
562
    def is_hybrid_model(
        self,
563
        architectures: Union[str, list[str]],
564
565
566
567
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_hybrid

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

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

582
583
584
585
586
587
588
    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

589
590
    def is_v1_compatible(
        self,
591
        architectures: Union[str, list[str]],
592
593
594
595
    ) -> bool:
        model_cls, _ = self.inspect_model_cls(architectures)
        return not model_cls.supports_v0_only

596
597

ModelRegistry = _ModelRegistry({
598
599
    model_arch:
    _LazyRegisteredModel(
600
601
602
603
604
605
606
607
608
609
        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:
610
611
612
613
614
    # 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")

615
        # `cloudpickle` allows pickling lambda functions directly
616
        import cloudpickle
617
        input_bytes = cloudpickle.dumps((fn, output_filepath))
618
619
620

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
621
622
623
        returned = subprocess.run(_SUBPROCESS_COMMAND,
                                  input=input_bytes,
                                  capture_output=True)
624
625
626
627
628
629
630
631
632

        # 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

633
        with open(output_filepath, "rb") as f:
634
635
636
637
638
639
640
641
642
643
644
            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()
645
646
647

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
648
649
650


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