Skip to content

Commit 3285db5

Browse files
hmellormawong-amd
authored andcommitted
Make right sidebar more readable in "Supported Models" (vllm-project#17723)
Signed-off-by: Harry Mellor <[email protected]>
1 parent 30329dc commit 3285db5

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

docs/source/models/supported_models.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,9 @@ print(output)
239239

240240
See [this page](#generative-models) for more information on how to use generative models.
241241

242-
#### Text Generation (`--task generate`)
242+
#### Text Generation
243+
244+
Specified using `--task generate`.
243245

244246
:::{list-table}
245247
:widths: 25 25 50 5 5
@@ -605,7 +607,9 @@ Since some model architectures support both generative and pooling tasks,
605607
you should explicitly specify the task type to ensure that the model is used in pooling mode instead of generative mode.
606608
:::
607609

608-
#### Text Embedding (`--task embed`)
610+
#### Text Embedding
611+
612+
Specified using `--task embed`.
609613

610614
:::{list-table}
611615
:widths: 25 25 50 5 5
@@ -670,7 +674,9 @@ If your model is not in the above list, we will try to automatically convert the
670674
{func}`~vllm.model_executor.models.adapters.as_embedding_model`. By default, the embeddings
671675
of the whole prompt are extracted from the normalized hidden state corresponding to the last token.
672676

673-
#### Reward Modeling (`--task reward`)
677+
#### Reward Modeling
678+
679+
Specified using `--task reward`.
674680

675681
:::{list-table}
676682
:widths: 25 25 50 5 5
@@ -711,7 +717,9 @@ For process-supervised reward models such as `peiyi9979/math-shepherd-mistral-7b
711717
e.g.: `--override-pooler-config '{"pooling_type": "STEP", "step_tag_id": 123, "returned_token_ids": [456, 789]}'`.
712718
:::
713719

714-
#### Classification (`--task classify`)
720+
#### Classification
721+
722+
Specified using `--task classify`.
715723

716724
:::{list-table}
717725
:widths: 25 25 50 5 5
@@ -737,7 +745,9 @@ e.g.: `--override-pooler-config '{"pooling_type": "STEP", "step_tag_id": 123, "r
737745
If your model is not in the above list, we will try to automatically convert the model using
738746
{func}`~vllm.model_executor.models.adapters.as_classification_model`. By default, the class probabilities are extracted from the softmaxed hidden state corresponding to the last token.
739747

740-
#### Sentence Pair Scoring (`--task score`)
748+
#### Sentence Pair Scoring
749+
750+
Specified using `--task score`.
741751

742752
:::{list-table}
743753
:widths: 25 25 50 5 5
@@ -824,7 +834,9 @@ vLLM currently only supports adding LoRA to the language backbone of multimodal
824834

825835
See [this page](#generative-models) for more information on how to use generative models.
826836

827-
#### Text Generation (`--task generate`)
837+
#### Text Generation
838+
839+
Specified using `--task generate`.
828840

829841
:::{list-table}
830842
:widths: 25 25 15 20 5 5 5
@@ -1200,7 +1212,9 @@ Since some model architectures support both generative and pooling tasks,
12001212
you should explicitly specify the task type to ensure that the model is used in pooling mode instead of generative mode.
12011213
:::
12021214

1203-
#### Text Embedding (`--task embed`)
1215+
#### Text Embedding
1216+
1217+
Specified using `--task embed`.
12041218

12051219
Any text generation model can be converted into an embedding model by passing `--task embed`.
12061220

@@ -1240,7 +1254,9 @@ The following table lists those that are tested in vLLM.
12401254
* ✅︎
12411255
:::
12421256

1243-
#### Transcription (`--task transcription`)
1257+
#### Transcription
1258+
1259+
Specified using `--task transcription`.
12441260

12451261
Speech2Text models trained specifically for Automatic Speech Recognition.
12461262

0 commit comments

Comments
 (0)