Skip to content

Commit 89dc0bc

Browse files
author
reidliu41
committed
[Misc] add chatbox integration
Signed-off-by: reidliu41 <reid201711@gmail.com>
1 parent 3d13ca0 commit 89dc0bc

File tree

4 files changed

+37
-0
lines changed

4 files changed

+37
-0
lines changed
107 KB
Loading
Loading
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
(deployment-chatbox)=
2+
3+
# Chatbox
4+
5+
[Chatbox](https://github.com/chatboxai/chatbox) is a desktop client for LLMs, available on Windows, Mac, Linux.
6+
7+
It allows you to deploy a large language model (LLM) server with vLLM as the backend, which exposes OpenAI-compatible endpoints.
8+
9+
## Prerequisites
10+
11+
- Setup vLLM environment
12+
13+
## Deploy
14+
15+
- Start the vLLM server with the supported chat completion model, e.g.
16+
17+
```console
18+
vllm serve qwen/Qwen1.5-0.5B-Chat
19+
```
20+
21+
- Download and install [Chatbox desktop](https://chatboxai.app/en#download).
22+
23+
- On the bottom left of settings, Add Custom Provider
24+
- API Mode: `OpenAI API Compatible`
25+
- Name: vllm
26+
- API Host: `http://{vllm server host}:{vllm server port}/v1`
27+
- API Path: `/chat/completions`
28+
- Model: `qwen/Qwen1.5-0.5B-Chat`
29+
30+
:::{image} /assets/deployment/chatbox-settings.png
31+
:::
32+
33+
- Go to `Just chat`, and start to chat:
34+
35+
:::{image} /assets/deployment/chatbox-chat.png
36+
:::

docs/source/deployment/frameworks/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
anything-llm
77
bentoml
88
cerebrium
9+
chatbox
910
dstack
1011
helm
1112
lws

0 commit comments

Comments
 (0)