Skip to content

Commit 856c990

Browse files
authored
[Docs] Add Docs on Limitations of VLM Support (#5383)
1 parent c5602f0 commit 856c990

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ def setup(app):
9292
"vllm._C",
9393
"PIL",
9494
"numpy",
95+
'triton'
9596
"tqdm",
9697
"tensorizer",
9798
]

docs/source/models/vlm.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,13 @@ The following :ref:`engine arguments <engine_args>` are specific to VLMs:
1616
:prog: -m vllm.entrypoints.openai.api_server
1717
:nodefaultconst:
1818

19+
.. important::
20+
Currently, the support for vision language models on vLLM has the following limitations:
21+
22+
* Only single image input is supported per text prompt.
23+
* Dynamic ``image_input_shape`` is not supported: the input image will be resized to the static ``image_input_shape``. This means model output might not exactly match the huggingface implementation.
24+
We are continuously improving user & developer experience for VLMs. Please raise an issue on GitHub if you have any feedback or feature requests.
25+
1926
Offline Batched Inference
2027
-------------------------
2128

@@ -31,7 +38,7 @@ To initialize a VLM, the aforementioned arguments must be passed to the ``LLM``
3138
image_feature_size=576,
3239
)
3340
34-
For now, we only support a single image per text prompt. To pass an image to the model, note the following in :class:`vllm.inputs.PromptStrictInputs`:
41+
To pass an image to the model, note the following in :class:`vllm.inputs.PromptStrictInputs`:
3542

3643
* ``prompt``: The prompt should have a number of ``<image>`` tokens equal to ``image_feature_size``.
3744
* ``multi_modal_data``: This should be an instance of :class:`~vllm.multimodal.image.ImagePixelData` or :class:`~vllm.multimodal.image.ImageFeatureData`.

0 commit comments

Comments
 (0)