[Doc][4/N] Reorganize API Reference (#11843)
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
This commit is contained in:
7
docs/source/api/engine/async_llm_engine.md
Normal file
7
docs/source/api/engine/async_llm_engine.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# AsyncLLMEngine
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: vllm.AsyncLLMEngine
|
||||
:members:
|
||||
:show-inheritance:
|
||||
```
|
||||
17
docs/source/api/engine/index.md
Normal file
17
docs/source/api/engine/index.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# vLLM Engine
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: vllm.engine
|
||||
```
|
||||
|
||||
```{eval-rst}
|
||||
.. currentmodule:: vllm.engine
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Engines
|
||||
:maxdepth: 2
|
||||
|
||||
llm_engine
|
||||
async_llm_engine
|
||||
```
|
||||
7
docs/source/api/engine/llm_engine.md
Normal file
7
docs/source/api/engine/llm_engine.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# LLMEngine
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: vllm.LLMEngine
|
||||
:members:
|
||||
:show-inheritance:
|
||||
```
|
||||
73
docs/source/api/multimodal/index.md
Normal file
73
docs/source/api/multimodal/index.md
Normal file
@@ -0,0 +1,73 @@
|
||||
(multi-modality)=
|
||||
|
||||
# Multi-Modality
|
||||
|
||||
```{eval-rst}
|
||||
.. currentmodule:: vllm.multimodal
|
||||
```
|
||||
|
||||
vLLM provides experimental support for multi-modal models through the {mod}`vllm.multimodal` package.
|
||||
|
||||
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).
|
||||
|
||||
|
||||
## Module Contents
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: vllm.multimodal
|
||||
```
|
||||
|
||||
### Registry
|
||||
|
||||
```{eval-rst}
|
||||
.. autodata:: vllm.multimodal.MULTIMODAL_REGISTRY
|
||||
```
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: vllm.multimodal.MultiModalRegistry
|
||||
:members:
|
||||
:show-inheritance:
|
||||
```
|
||||
|
||||
### Base Classes
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: vllm.multimodal.base
|
||||
:members:
|
||||
:show-inheritance:
|
||||
```
|
||||
|
||||
### Input Classes
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: vllm.multimodal.inputs
|
||||
:members:
|
||||
:show-inheritance:
|
||||
```
|
||||
|
||||
### Audio Classes
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: vllm.multimodal.audio
|
||||
:members:
|
||||
:show-inheritance:
|
||||
```
|
||||
|
||||
### Image Classes
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: vllm.multimodal.image
|
||||
:members:
|
||||
:show-inheritance:
|
||||
```
|
||||
|
||||
### Video Classes
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: vllm.multimodal.video
|
||||
:members:
|
||||
:show-inheritance:
|
||||
```
|
||||
9
docs/source/api/offline_inference/index.md
Normal file
9
docs/source/api/offline_inference/index.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Offline Inference
|
||||
|
||||
```{toctree}
|
||||
:caption: Contents
|
||||
:maxdepth: 1
|
||||
|
||||
llm
|
||||
llm_inputs
|
||||
```
|
||||
7
docs/source/api/offline_inference/llm.md
Normal file
7
docs/source/api/offline_inference/llm.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# LLM Class
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: vllm.LLM
|
||||
:members:
|
||||
:show-inheritance:
|
||||
```
|
||||
19
docs/source/api/offline_inference/llm_inputs.md
Normal file
19
docs/source/api/offline_inference/llm_inputs.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# LLM Inputs
|
||||
|
||||
```{eval-rst}
|
||||
.. autodata:: vllm.inputs.PromptType
|
||||
```
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: vllm.inputs.TextPrompt
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:member-order: bysource
|
||||
```
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: vllm.inputs.TokensPrompt
|
||||
:show-inheritance:
|
||||
:members:
|
||||
:member-order: bysource
|
||||
```
|
||||
22
docs/source/api/params.md
Normal file
22
docs/source/api/params.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Optional Parameters
|
||||
|
||||
Optional parameters for vLLM APIs.
|
||||
|
||||
(sampling-params)=
|
||||
|
||||
## Sampling Parameters
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: vllm.SamplingParams
|
||||
:members:
|
||||
```
|
||||
|
||||
(pooling-params)=
|
||||
|
||||
## Pooling Parameters
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: vllm.PoolingParams
|
||||
:members:
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user