Skip to content

Commit d4a6be7

Browse files
committed
Revert
Signed-off-by: Rafael Vasquez <[email protected]>
1 parent b92d981 commit d4a6be7

22 files changed

+129
-249
lines changed

.github/workflows/doc-lint.yml

Lines changed: 0 additions & 23 deletions
This file was deleted.

.github/workflows/sphinx-lint.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Lint documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- "docs/**"
9+
pull_request:
10+
branches:
11+
- main
12+
paths:
13+
- "docs/**"
14+
15+
jobs:
16+
sphinx-lint:
17+
runs-on: ubuntu-latest
18+
strategy:
19+
matrix:
20+
python-version: ["3.12"]
21+
steps:
22+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
23+
- name: Set up Python ${{ matrix.python-version }}
24+
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
25+
with:
26+
python-version: ${{ matrix.python-version }}
27+
- name: Install dependencies
28+
run: |
29+
python -m pip install --upgrade pip
30+
pip install -r requirements-lint.txt
31+
- name: Linting docs
32+
run: tools/sphinx-lint.sh
33+
markdown-lint:
34+
runs-on: ubuntu-latest
35+
steps:
36+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
37+
- uses: DavidAnson/markdownlint-cli2-action@v19
38+
with:
39+
globs: "docs/**/*.md"

.markdownlint-cli2.yaml

Lines changed: 0 additions & 24 deletions
This file was deleted.

docs/source/api/inference_params.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/source/api/model/adapters.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/source/api/model/index.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/source/api/model/interfaces.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/source/api/model/interfaces_base.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/source/api/multimodal/index.md

Lines changed: 53 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,72 @@
22

33
# Multi-Modality
44

5+
```{eval-rst}
6+
.. currentmodule:: vllm.multimodal
7+
```
8+
59
vLLM provides experimental support for multi-modal models through the {mod}`vllm.multimodal` package.
610

711
Multi-modal inputs can be passed alongside text and token prompts to [supported models](#supported-mm-models)
812
via the `multi_modal_data` field in {class}`vllm.inputs.PromptType`.
913

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

16+
1217
## Module Contents
1318

19+
```{eval-rst}
20+
.. automodule:: vllm.multimodal
21+
```
22+
23+
### Registry
24+
1425
```{eval-rst}
1526
.. autodata:: vllm.multimodal.MULTIMODAL_REGISTRY
1627
```
1728

18-
## Submodules
29+
```{eval-rst}
30+
.. autoclass:: vllm.multimodal.MultiModalRegistry
31+
:members:
32+
:show-inheritance:
33+
```
34+
35+
### Base Classes
36+
37+
```{eval-rst}
38+
.. automodule:: vllm.multimodal.base
39+
:members:
40+
:show-inheritance:
41+
```
1942

20-
```{toctree}
21-
:maxdepth: 1
43+
### Input Classes
2244

23-
inputs
24-
parse
25-
processing
26-
profiling
27-
registry
45+
```{eval-rst}
46+
.. automodule:: vllm.multimodal.inputs
47+
:members:
48+
:show-inheritance:
49+
```
50+
51+
### Audio Classes
52+
53+
```{eval-rst}
54+
.. automodule:: vllm.multimodal.audio
55+
:members:
56+
:show-inheritance:
57+
```
58+
59+
### Image Classes
60+
61+
```{eval-rst}
62+
.. automodule:: vllm.multimodal.image
63+
:members:
64+
:show-inheritance:
65+
```
66+
67+
### Video Classes
68+
69+
```{eval-rst}
70+
.. automodule:: vllm.multimodal.video
71+
:members:
72+
:show-inheritance:
2873
```

docs/source/api/multimodal/inputs.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

docs/source/api/multimodal/parse.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/source/api/multimodal/processing.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/source/api/multimodal/profiling.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/source/api/multimodal/registry.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/source/api/params.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ Optional parameters for vLLM APIs.
1919
.. autoclass:: vllm.PoolingParams
2020
:members:
2121
```
22+

docs/source/design/multiprocessing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This document describes how vLLM deals with these challenges.
2121

2222
## Multiprocessing Methods
2323

24-
[Python multiprocessing methods](https://docs.python.org/3/library/multiprocessing.html#contexts-and-start-methods) include:
24+
[Python multiprocessing methods](https://docs.python.org/3/library/multiprocessing.html.md#contexts-and-start-methods) include:
2525

2626
- `spawn` - spawn a new Python process. This will be the default as of Python
2727
3.14.

docs/source/getting_started/quickstart.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,10 @@ This guide will help you quickly get started with vLLM to perform:
1515
## Installation
1616

1717
If you are using NVIDIA GPUs, you can install vLLM using [pip](https://pypi.org/project/vllm/) directly.
18-
19-
It's recommended to use [uv](https://docs.astral.sh/uv/), a very fast Python environment manager, to create and manage Python environments. Please follow the [documentation](https://docs.astral.sh/uv/#getting-started) to install `uv`. After installing `uv`, you can create a new Python environment and install vLLM using the following commands:
20-
21-
```console
22-
$ uv venv myenv --python 3.12 --seed
23-
$ source myenv/bin/activate
24-
$ uv pip install vllm
25-
```
26-
27-
You can also use [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html) to create and manage Python environments.
18+
It's recommended to use [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html) to create and manage Python environments.
2819

2920
```console
30-
$ conda create -n myenv python=3.12 -y
21+
$ conda create -n myenv python=3.10 -y
3122
$ conda activate myenv
3223
$ pip install vllm
3324
```

docs/source/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,8 @@ community/sponsors
139139
140140
api/offline_inference/index
141141
api/engine/index
142-
api/inference_params
143142
api/multimodal/index
144-
api/model/index
143+
api/params
145144
```
146145

147146
% Design Documents: Details about vLLM internals

0 commit comments

Comments
 (0)