Unverified Commit 6cd40a5b authored by Cyrus Leung's avatar Cyrus Leung Committed by GitHub
Browse files

[Doc][4/N] Reorganize API Reference (#11843)


Signed-off-by: default avatarDarkLight1337 <tlleungac@connect.ust.hk>
parent aba8d6ee
......@@ -49,9 +49,6 @@ class MultiModalPlugin(ABC):
process the same data differently). This registry is in turn used by
:class:`~MultiModalRegistry` which acts at a higher level
(i.e., the modality of the data).
See also:
:ref:`adding-multimodal-plugin`
"""
def __init__(self) -> None:
......
......@@ -99,12 +99,6 @@ class MultiModalDataBuiltins(TypedDict, total=False):
MultiModalDataDict: TypeAlias = Mapping[str, ModalityData[Any]]
"""
A dictionary containing an entry for each modality type to input.
Note:
This dictionary also accepts modality keys defined outside
:class:`MultiModalDataBuiltins` as long as a customized plugin
is registered through the :class:`~vllm.multimodal.MULTIMODAL_REGISTRY`.
Read more on that :ref:`here <adding-multimodal-plugin>`.
"""
......
......@@ -125,9 +125,6 @@ class MultiModalRegistry:
def register_plugin(self, plugin: MultiModalPlugin) -> None:
"""
Register a multi-modal plugin so it can be recognized by vLLM.
See also:
:ref:`adding-multimodal-plugin`
"""
data_type_key = plugin.get_data_key()
......
......@@ -7,7 +7,7 @@ class PoolingParams(
msgspec.Struct,
omit_defaults=True, # type: ignore[call-arg]
array_like=True): # type: ignore[call-arg]
"""Pooling parameters for embeddings API.
"""API parameters for pooling models. This is currently a placeholder.
Attributes:
additional_data: Any additional data needed for pooling.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment