registry.py 25.7 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
import cloudpickle
20
21
22
23
import torch.nn as nn

from vllm.logger import init_logger

24
25
26
27
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)
28
from .interfaces_base import is_text_generation_model
29
30
31

logger = init_logger(__name__)

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

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

172
173
174
175
176
177
_CROSS_ENCODER_MODELS = {
    "BertForSequenceClassification": ("bert", "BertForSequenceClassification"),
    "RobertaForSequenceClassification": ("roberta",
                                         "RobertaForSequenceClassification"),
    "XLMRobertaForSequenceClassification": ("roberta",
                                            "RobertaForSequenceClassification"),
xsank's avatar
xsank committed
178
179
    "ModernBertForSequenceClassification": ("modernbert",
                                            "ModernBertForSequenceClassification"),
180
    "Qwen3ForSequenceClassification": ("qwen3", "Qwen3ForSequenceClassification"), # noqa: E501
181
182
}

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

_SPECULATIVE_DECODING_MODELS = {
233
    "MiMoMTPModel": ("mimo_mtp", "MiMoMTP"),
234
    "EAGLEModel": ("eagle", "EAGLE"),
235
    "EagleLlamaForCausalLM": ("llama_eagle", "EagleLlamaForCausalLM"),
236
    "EagleMiniCPMForCausalLM": ("minicpm_eagle", "EagleMiniCPMForCausalLM"),
237
    "Eagle3LlamaForCausalLM": ("llama_eagle3", "Eagle3LlamaForCausalLM"),
238
    "DeepSeekMTPModel": ("deepseek_mtp", "DeepSeekMTP"),
239
240
    "MedusaModel": ("medusa", "Medusa"),
    "MLPSpeculatorPreTrainedModel": ("mlp_speculator", "MLPSpeculator"),
241
}
242

243
_TRANSFORMERS_MODELS = {
244
    "TransformersForCausalLM": ("transformers", "TransformersForCausalLM"),
245
}
246
# yapf: enable
247

248
_VLLM_MODELS = {
249
    **_TEXT_GENERATION_MODELS,
250
    **_EMBEDDING_MODELS,
251
    **_CROSS_ENCODER_MODELS,
252
    **_MULTIMODAL_MODELS,
253
    **_SPECULATIVE_DECODING_MODELS,
254
    **_TRANSFORMERS_MODELS,
255
256
}

257
258
259
260
261
262
263
264
# 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"
]

265

266
267
@dataclass(frozen=True)
class _ModelInfo:
268
    architecture: str
269
    is_text_generation_model: bool
270
    is_pooling_model: bool
271
    supports_cross_encoding: bool
272
273
    supports_multimodal: bool
    supports_pp: bool
274
275
    has_inner_state: bool
    is_attention_free: bool
276
    is_hybrid: bool
277
    has_noops: bool
278
    supports_transcription: bool
279
    supports_v0_only: bool
280
281

    @staticmethod
282
    def from_model_cls(model: type[nn.Module]) -> "_ModelInfo":
283
        return _ModelInfo(
284
            architecture=model.__name__,
285
            is_text_generation_model=is_text_generation_model(model),
286
            is_pooling_model=True,  # Can convert any model into a pooling model
287
            supports_cross_encoding=supports_cross_encoding(model),
288
289
            supports_multimodal=supports_multimodal(model),
            supports_pp=supports_pp(model),
290
291
            has_inner_state=has_inner_state(model),
            is_attention_free=is_attention_free(model),
292
            is_hybrid=is_hybrid(model),
293
294
            supports_transcription=supports_transcription(model),
            supports_v0_only=supports_v0_only(model),
295
            has_noops=has_noops(model),
296
        )
297
298


299
class _BaseRegisteredModel(ABC):
300

301
302
303
    @abstractmethod
    def inspect_model_cls(self) -> _ModelInfo:
        raise NotImplementedError
304

305
    @abstractmethod
306
    def load_model_cls(self) -> type[nn.Module]:
307
        raise NotImplementedError
308
309


310
311
312
313
314
315
316
@dataclass(frozen=True)
class _RegisteredModel(_BaseRegisteredModel):
    """
    Represents a model that has already been imported in the main process.
    """

    interfaces: _ModelInfo
317
    model_cls: type[nn.Module]
318
319

    @staticmethod
320
    def from_model_cls(model_cls: type[nn.Module]):
321
322
323
324
325
326
327
328
        return _RegisteredModel(
            interfaces=_ModelInfo.from_model_cls(model_cls),
            model_cls=model_cls,
        )

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

329
    def load_model_cls(self) -> type[nn.Module]:
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
        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()))

346
    def load_model_cls(self) -> type[nn.Module]:
347
348
349
350
351
352
353
354
        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,
355
) -> Optional[type[nn.Module]]:
356
    from vllm.platforms import current_platform
357
    current_platform.verify_model_arch(model_arch)
358
359
360
361
362
363
    try:
        return model.load_model_cls()
    except Exception:
        logger.exception("Error in loading model architecture '%s'",
                         model_arch)
        return None
364
365


366
367
368
369
370
371
372
373
374
375
376
@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
377
378


379
380
381
@dataclass
class _ModelRegistry:
    # Keyed by model_arch
382
    models: dict[str, _BaseRegisteredModel] = field(default_factory=dict)
383

384
    def get_supported_archs(self) -> Set[str]:
385
        return self.models.keys()
386

387
388
389
    def register_model(
        self,
        model_arch: str,
390
        model_cls: Union[type[nn.Module], str],
391
    ) -> None:
392
393
394
        """
        Register an external model to be used in vLLM.

395
        `model_cls` can be either:
396

397
        - A [`torch.nn.Module`][] class directly referencing the model.
398
        - A string in the format `<module>:<class>` which can be used to
399
400
          lazily import the model. This is useful to avoid initializing CUDA
          when importing the model and thus the related error
401
          `RuntimeError: Cannot re-initialize CUDA in forked subprocess`.
402
        """
403
404
405
406
        if not isinstance(model_arch, str):
            msg = f"`model_arch` should be a string, not a {type(model_arch)}"
            raise TypeError(msg)

407
        if model_arch in self.models:
408
409
410
            logger.warning(
                "Model architecture %s is already registered, and will be "
                "overwritten by the new model class %s.", model_arch,
411
412
413
414
415
416
417
                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)
418

419
            model = _LazyRegisteredModel(*split_str)
420
        elif isinstance(model_cls, type) and issubclass(model_cls, nn.Module):
421
            model = _RegisteredModel.from_model_cls(model_cls)
422
423
424
425
        else:
            msg = ("`model_cls` should be a string or PyTorch model class, "
                   f"not a {type(model_arch)}")
            raise TypeError(msg)
426

427
        self.models[model_arch] = model
428

429
    def _raise_for_unsupported(self, architectures: list[str]):
430
        all_supported_archs = self.get_supported_archs()
431

432
433
434
435
436
        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.")

437
438
439
        raise ValueError(
            f"Model architectures {architectures} are not supported for now. "
            f"Supported architectures: {all_supported_archs}")
440

441
    def _try_load_model_cls(self,
442
                            model_arch: str) -> Optional[type[nn.Module]]:
443
444
        if model_arch not in self.models:
            return None
445

446
        return _try_load_model_cls(model_arch, self.models[model_arch])
447

448
449
450
    def _try_inspect_model_cls(self, model_arch: str) -> Optional[_ModelInfo]:
        if model_arch not in self.models:
            return None
451

452
        return _try_inspect_model_cls(model_arch, self.models[model_arch])
453

454
455
    def _normalize_archs(
        self,
456
457
        architectures: Union[str, list[str]],
    ) -> list[str]:
458
459
460
461
462
        if isinstance(architectures, str):
            architectures = [architectures]
        if not architectures:
            logger.warning("No model architectures are specified")

463
464
465
466
        # filter out support architectures
        normalized_arch = list(
            filter(lambda model: model in self.models, architectures))

467
        # make sure Transformers backend is put at the last as a fallback
468
        if len(normalized_arch) != len(architectures):
469
            normalized_arch.append("TransformersForCausalLM")
470
        return normalized_arch
471

472
473
    def inspect_model_cls(
        self,
474
475
        architectures: Union[str, list[str]],
    ) -> tuple[_ModelInfo, str]:
476
        architectures = self._normalize_archs(architectures)
477

478
479
480
        for arch in architectures:
            model_info = self._try_inspect_model_cls(arch)
            if model_info is not None:
481
                return (model_info, arch)
482

483
        return self._raise_for_unsupported(architectures)
484

485
486
    def resolve_model_cls(
        self,
487
488
        architectures: Union[str, list[str]],
    ) -> tuple[type[nn.Module], str]:
489
        architectures = self._normalize_archs(architectures)
490

491
492
493
494
        for arch in architectures:
            model_cls = self._try_load_model_cls(arch)
            if model_cls is not None:
                return (model_cls, arch)
495

496
        return self._raise_for_unsupported(architectures)
497

498
499
    def is_text_generation_model(
        self,
500
        architectures: Union[str, list[str]],
501
    ) -> bool:
502
503
        model_cls, _ = self.inspect_model_cls(architectures)
        return model_cls.is_text_generation_model
504

505
    def is_pooling_model(
506
        self,
507
        architectures: Union[str, list[str]],
508
    ) -> bool:
509
        model_cls, _ = self.inspect_model_cls(architectures)
510
        return model_cls.is_pooling_model
511

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

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

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

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

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

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

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

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

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

575
576

ModelRegistry = _ModelRegistry({
577
578
    model_arch:
    _LazyRegisteredModel(
579
580
581
582
583
584
585
586
587
588
        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:
589
590
591
592
593
    # 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")

594
        # `cloudpickle` allows pickling lambda functions directly
595
        input_bytes = cloudpickle.dumps((fn, output_filepath))
596
597
598

        # cannot use `sys.executable __file__` here because the script
        # contains relative imports
599
600
601
        returned = subprocess.run(_SUBPROCESS_COMMAND,
                                  input=input_bytes,
                                  capture_output=True)
602
603
604
605
606
607
608
609
610

        # 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

611
        with open(output_filepath, "rb") as f:
612
613
614
615
616
617
618
619
620
621
622
            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()
623
624
625

    with open(output_file, "wb") as f:
        f.write(pickle.dumps(result))
626
627
628


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