Skip to content

vllm.transformers_utils.chat_templates.registry

CHAT_TEMPLATES_DIR module-attribute 

CHAT_TEMPLATES_DIR = parent

ChatTemplatePath module-attribute 

ChatTemplatePath: TypeAlias = (
    Path | Callable[[str], Path | None]
)

_MODEL_TYPE_TO_CHAT_TEMPLATE_FALLBACK module-attribute 

_MODEL_TYPE_TO_CHAT_TEMPLATE_FALLBACK: dict[
    str, ChatTemplatePath
] = {
    "blip-2": CHAT_TEMPLATES_DIR / "template_blip2.jinja",
    "chameleon": CHAT_TEMPLATES_DIR
    / "template_basic.jinja",
    "clip": CHAT_TEMPLATES_DIR / "template_basic.jinja",
    "deepseek_ocr": CHAT_TEMPLATES_DIR
    / "template_deepseek_ocr.jinja",
    "deepseek_vl_v2": CHAT_TEMPLATES_DIR
    / "template_deepseek_vl2.jinja",
    "fuyu": CHAT_TEMPLATES_DIR / "template_fuyu.jinja",
    "minicpmv": _get_minicpmv_chat_template_fallback,
    "paligemma": CHAT_TEMPLATES_DIR
    / "template_basic.jinja",
    "qwen": _get_qwen_chat_template_fallback,
    "siglip": CHAT_TEMPLATES_DIR / "template_basic.jinja",
}

logger module-attribute 

logger = init_logger(__file__)

_get_minicpmv_chat_template_fallback 

_get_minicpmv_chat_template_fallback(
    tokenizer_name_or_path: str,
) -> Path | None
Source code in vllm/transformers_utils/chat_templates/registry.py 
23
24
25
26
27
28
29
def _get_minicpmv_chat_template_fallback(tokenizer_name_or_path: str) -> Path | None:
    # MiniCPM-V-4.5 version uses a dedicated template
    if "4.5" in tokenizer_name_or_path or "4_5" in tokenizer_name_or_path:
        return CHAT_TEMPLATES_DIR / "template_minicpmv45.jinja"

    # Other versions use chatml template
    return CHAT_TEMPLATES_DIR / "template_chatml.jinja"

_get_qwen_chat_template_fallback 

_get_qwen_chat_template_fallback(
    tokenizer_name_or_path: str,
) -> Path | None
Source code in vllm/transformers_utils/chat_templates/registry.py 
16
17
18
19
20
def _get_qwen_chat_template_fallback(tokenizer_name_or_path: str) -> Path | None:
    if tokenizer_name_or_path.endswith("-Chat"):
        return CHAT_TEMPLATES_DIR / "template_chatml.jinja"

    return CHAT_TEMPLATES_DIR / "template_basic.jinja"

get_chat_template_fallback_path 

get_chat_template_fallback_path(
    model_type: str, tokenizer_name_or_path: str
) -> Path | None
Source code in vllm/transformers_utils/chat_templates/registry.py 
61
62
63
64
65
66
67
68
69
70
71
72
def get_chat_template_fallback_path(
    model_type: str,
    tokenizer_name_or_path: str,
) -> Path | None:
    chat_template = _MODEL_TYPE_TO_CHAT_TEMPLATE_FALLBACK.get(model_type)
    if callable(chat_template):
        chat_template = chat_template(tokenizer_name_or_path)

    if chat_template is None:
        return None

    return chat_template

register_chat_template_fallback_path 

register_chat_template_fallback_path(
    model_type: str, chat_template: ChatTemplatePath
) -> None
Source code in vllm/transformers_utils/chat_templates/registry.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
def register_chat_template_fallback_path(
    model_type: str,
    chat_template: ChatTemplatePath,
) -> None:
    if model_type in _MODEL_TYPE_TO_CHAT_TEMPLATE_FALLBACK:
        logger.warning(
            "Model type %s already has a chat template registered. "
            "It will be overwritten by the new chat template %s.",
            model_type,
            chat_template,
        )

    _MODEL_TYPE_TO_CHAT_TEMPLATE_FALLBACK[model_type] = chat_template