vllm/multimodal/__init__.py

# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
from .base import MultiModalPlaceholderMap
from .hasher import MultiModalHashDict, MultiModalHasher
from .inputs import (BatchedTensorInputs, ModalityData, MultiModalDataBuiltins,
                     MultiModalDataDict, MultiModalKwargs,
                     MultiModalPlaceholderDict, NestedTensors)
from .registry import MultiModalRegistry

MULTIMODAL_REGISTRY = MultiModalRegistry()
"""
The global [`MultiModalRegistry`][vllm.multimodal.registry.MultiModalRegistry]
is used by model runners to dispatch data processing according to the target
model.

Info:
    [mm_processing](../../../design/mm_processing.html)
"""

__all__ = [
    "BatchedTensorInputs",
    "ModalityData",
    "MultiModalDataBuiltins",
    "MultiModalDataDict",
    "MultiModalHashDict",
    "MultiModalHasher",
    "MultiModalKwargs",
    "MultiModalPlaceholderDict",
    "MultiModalPlaceholderMap",
    "NestedTensors",
    "MULTIMODAL_REGISTRY",
    "MultiModalRegistry",
]
[Misc] Add SPDX-License-Identifier headers to python source files (#12628) - Add SPDX license headers to python source files - Check for SPDX headers using pre-commit commit 9d7ef44c3cfb72ca4c32e1c677d99259d10d4745 Author: Russell Bryant <rbryant@redhat.com> Date: Fri Jan 31 14:18:24 2025 -0500 Add SPDX license headers to python source files This commit adds SPDX license headers to python source files as recommended to the project by the Linux Foundation. These headers provide a concise way that is both human and machine readable for communicating license information for each source file. It helps avoid any ambiguity about the license of the code and can also be easily used by tools to help manage license compliance. The Linux Foundation runs license scans against the codebase to help ensure we are in compliance with the licenses of the code we use, including dependencies. Having these headers in place helps that tool do its job. More information can be found on the SPDX site: - https://spdx.dev/learn/handling-license-info/ Signed-off-by: Russell Bryant <rbryant@redhat.com> commit 5a1cf1cb3b80759131c73f6a9dddebccac039dea Author: Russell Bryant <rbryant@redhat.com> Date: Fri Jan 31 14:36:32 2025 -0500 Check for SPDX headers using pre-commit Signed-off-by: Russell Bryant <rbryant@redhat.com> --------- Signed-off-by: Russell Bryant <rbryant@redhat.com> 2025-02-02 14:58:18 -05:00			`# SPDX-License-Identifier: Apache-2.0`
[Misc] Add SPDX-FileCopyrightText (#19100) Signed-off-by: simon-mo <simon.mo@hey.com> 2025-06-03 11:20:17 -07:00			`# SPDX-FileCopyrightText: Copyright contributors to the vLLM project`
[Core] Remove legacy input mapper/processor from V0 (#15686) Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk> 2025-04-28 15:38:48 +08:00			`from .base import MultiModalPlaceholderMap`
[V1] Extend beyond image modality and support mixed-modality inference with Llava-OneVision (#11685) Signed-off-by: Roger Wang <ywang@roblox.com> Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk> Co-authored-by: DarkLight1337 <tlleungac@connect.ust.hk> 2025-01-06 11:58:16 -08:00			`from .hasher import MultiModalHashDict, MultiModalHasher`
[VLM] Abstract out multi-modal data parsing in merged processor (#11620) Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk> 2024-12-30 23:01:35 +08:00			`from .inputs import (BatchedTensorInputs, ModalityData, MultiModalDataBuiltins,`
			`MultiModalDataDict, MultiModalKwargs,`
			`MultiModalPlaceholderDict, NestedTensors)`
[Core] Registry for processing model inputs (#5214) Co-authored-by: ywang96 <ywang@roblox.com> 2024-06-28 20:09:56 +08:00			`from .registry import MultiModalRegistry`

			`MULTIMODAL_REGISTRY = MultiModalRegistry()`
			`"""`
[Doc] Convert Sphinx directives ( `{class}`, `{meth}`, `{attr}`, ...) to MkDocs format for better documentation linking (#18663) Signed-off-by: Zerohertz <ohg3417@gmail.com> 2025-05-27 17:44:20 +09:00			The global [`MultiModalRegistry`][vllm.multimodal.registry.MultiModalRegistry]
			`is used by model runners to dispatch data processing according to the target`
			`model.`
[Core] Registry for processing model inputs (#5214) Co-authored-by: ywang96 <ywang@roblox.com> 2024-06-28 20:09:56 +08:00
Migrate docs from Sphinx to MkDocs (#18145) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> 2025-05-23 11:09:53 +02:00			`Info:`
[Doc] Convert Sphinx directives ( `{class}`, `{meth}`, `{attr}`, ...) to MkDocs format for better documentation linking (#18663) Signed-off-by: Zerohertz <ohg3417@gmail.com> 2025-05-27 17:44:20 +09:00			`[mm_processing](../../../design/mm_processing.html)`
[Core] Registry for processing model inputs (#5214) Co-authored-by: ywang96 <ywang@roblox.com> 2024-06-28 20:09:56 +08:00			`"""`
[Core] Support image processor (#4197) 2024-06-03 13:56:41 +08:00
			`__all__ = [`
[Bugfix] Fix broadcasting logic for `multi_modal_kwargs` (#6836) 2024-07-31 10:38:45 +08:00			`"BatchedTensorInputs",`
[VLM] Abstract out multi-modal data parsing in merged processor (#11620) Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk> 2024-12-30 23:01:35 +08:00			`"ModalityData",`
[Doc] Guide for adding multi-modal plugins (#6205) 2024-07-10 14:55:34 +08:00			`"MultiModalDataBuiltins",`
[Core] Dynamic image size support for VLMs (#5276) Signed-off-by: Xiaowei Jiang <xwjiang2010@gmail.com> Co-authored-by: Xiaowei Jiang <xwjiang2010@gmail.com> Co-authored-by: ywang96 <ywang@roblox.com> Co-authored-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com> Co-authored-by: Roger Wang <136131678+ywang96@users.noreply.github.com> 2024-07-03 11:34:00 +08:00			`"MultiModalDataDict",`
[V1] Extend beyond image modality and support mixed-modality inference with Llava-OneVision (#11685) Signed-off-by: Roger Wang <ywang@roblox.com> Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk> Co-authored-by: DarkLight1337 <tlleungac@connect.ust.hk> 2025-01-06 11:58:16 -08:00			`"MultiModalHashDict",`
			`"MultiModalHasher",`
[0/N] Rename `MultiModalInputs` to `MultiModalKwargs` (#10040) Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk> 2024-11-09 11:31:02 +08:00			`"MultiModalKwargs",`
[Core][VLM] Add precise multi-modal placeholder tracking (#8346) Signed-off-by: Peter Salas <peter@fixie.ai> 2024-11-01 16:21:10 -07:00			`"MultiModalPlaceholderDict",`
			`"MultiModalPlaceholderMap",`
[Model] Adding support for MiniCPM-V (#4087) 2024-07-25 11:59:30 +08:00			`"NestedTensors",`
[VLM] Remove `image_input_type` from VLM config (#5852) Signed-off-by: Xiaowei Jiang <xwjiang2010@gmail.com> Co-authored-by: Cyrus Leung <cyrus.tl.leung@gmail.com> Co-authored-by: Roger Wang <ywang@roblox.com> 2024-07-02 00:57:09 -07:00			`"MULTIMODAL_REGISTRY",`
			`"MultiModalRegistry",`
[Core] Support image processor (#4197) 2024-06-03 13:56:41 +08:00			`]`