Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] [1/N] Initial guide for merged multi-modal processor #11925

Merged
merged 2 commits into from
Jan 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/requirements-docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sphinx-book-theme==1.0.1
sphinx-copybutton==0.5.2
myst-parser==3.0.1
sphinx-argparse==0.4.0
sphinx-design==0.6.1
sphinx-togglebutton==0.3.2
msgspec
cloudpickle
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/multimodal/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ vLLM provides experimental support for multi-modal models through the {mod}`vllm
Multi-modal inputs can be passed alongside text and token prompts to [supported models](#supported-mm-models)
via the `multi_modal_data` field in {class}`vllm.inputs.PromptType`.

Looking to add your own multi-modal model? Please follow the instructions listed [here](#enabling-multimodal-inputs).
Looking to add your own multi-modal model? Please follow the instructions listed [here](#supports-multimodal).

## Module Contents

Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/multimodal/inputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## User-facing inputs

```{eval-rst}
.. autodata:: vllm.multimodal.MultiModalDataDict
.. autodata:: vllm.multimodal.inputs.MultiModalDataDict
```

## Internal data structures
Expand Down
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
"sphinx.ext.autosummary",
"myst_parser",
"sphinxarg.ext",
"sphinx_design",
"sphinx_togglebutton",
]
myst_enable_extensions = [
Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributing/model/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Adding a New Model

This section provides more information on how to integrate a [HuggingFace Transformers](https://github.com/huggingface/transformers) model into vLLM.
This section provides more information on how to integrate a [PyTorch](https://pytorch.org/) model into vLLM.

```{toctree}
:caption: Contents
Expand Down
Loading
Loading