Skip to content

Commit 9a973c5

Browse files
committed
Add vllm documentation
1 parent f349dfe commit 9a973c5

File tree

1 file changed

+37
-0
lines changed
  • docs/book/component-guide/model-deployers

1 file changed

+37
-0
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
description: Deploying your LLM locally with vLLM.
3+
---
4+
5+
# vLLM
6+
7+
## When to use it?
8+
9+
## How do you deploy it?
10+
11+
The vLLM Model Deployer flavor is provided by the vLLM ZenML integration, so you need to install it on your local machine to be able to deploy your models. You can do this by running the following command:
12+
13+
```bash
14+
zenml integration install vllm -y
15+
```
16+
17+
To register the vLLM model deployer with ZenML you need to run the following command:
18+
19+
```bash
20+
zenml model-deployer register vllm_deployer --flavor=vllm
21+
```
22+
23+
The ZenML integration will provision a local vLLM deployment server as a daemon process that will continue to run in the background to serve the latest vLLM model.
24+
25+
## How do you use it?
26+
27+
#### Configuration
28+
29+
Within the `VLLMDeploymentService` you can configure:
30+
31+
* `model`: Name or path of the huggingface model to use.
32+
* `tokenizer`: Name or path of the huggingface tokenizer to use. If unspecified, model name or path will be used.
33+
* `served_model_name`: The model name(s) used in the API. If not specified, the model name will be the same as the `model` argument.
34+
* `trust_remote_code`: Trust remote code from huggingface.
35+
* `tokenizer_mode`: The tokenizer mode. Allowed choices: ['auto', 'slow', 'mistral']
36+
* `dtype`: Data type for model weights and activations. Allowed choices: ['auto', 'half', 'float16', 'bfloat16', 'float', 'float32']
37+
* `revision`: The specific model version to use. It can be a branch name, a tag name, or a commit id. If unspecified, will use the default version.

0 commit comments

Comments
 (0)