FastChat
An open platform for training, serving, and evaluating large language models. Release repo for Vicuna and Chatbot Arena.
Install / Use
/learn @lm-sys/FastChatREADME
FastChat
FastChat is an open platform for training, serving, and evaluating large language model based chatbots.
- FastChat powers Chatbot Arena (lmarena.ai), serving over 10 million chat requests for 70+ LLMs.
- Chatbot Arena has collected over 1.5M human votes from side-by-side LLM battles to compile an online LLM Elo leaderboard.
FastChat's core features include:
- The training and evaluation code for state-of-the-art models (e.g., Vicuna, MT-Bench).
- A distributed multi-model serving system with web UI and OpenAI-compatible RESTful APIs.
News
- [2024/03] 🔥 We released Chatbot Arena technical report.
- [2023/09] We released LMSYS-Chat-1M, a large-scale real-world LLM conversation dataset. Read the report.
- [2023/08] We released Vicuna v1.5 based on Llama 2 with 4K and 16K context lengths. Download weights.
- [2023/07] We released Chatbot Arena Conversations, a dataset containing 33k conversations with human preferences. Download it here.
- [2023/08] We released LongChat v1.5 based on Llama 2 with 32K context lengths. Download weights.
- [2023/06] We introduced MT-bench, a challenging multi-turn question set for evaluating chatbots. Check out the blog post.
- [2023/06] We introduced LongChat, our long-context chatbots and evaluation tools. Check out the blog post.
- [2023/05] We introduced Chatbot Arena for battles among LLMs. Check out the blog post.
- [2023/03] We released Vicuna: An Open-Source Chatbot Impressing GPT-4 with 90% ChatGPT Quality. Check out the blog post.
<a href="https://lmarena.ai"><img src="assets/demo_narrow.gif" width="70%"></a>
Contents
- Install
- Model Weights
- Inference with Command Line Interface
- Serving with Web GUI
- API
- Evaluation
- Fine-tuning
- Citation
Install
Method 1: With pip
pip3 install "fschat[model_worker,webui]"
Method 2: From source
- Clone this repository and navigate to the FastChat folder
git clone https://github.com/lm-sys/FastChat.git
cd FastChat
If you are running on Mac:
brew install rust cmake
- Install Package
pip3 install --upgrade pip # enable PEP 660 support
pip3 install -e ".[model_worker,webui]"
Model Weights
Vicuna Weights
Vicuna is based on Llama 2 and should be used under Llama's model license.
You can use the commands below to start chatting. It will automatically download the weights from Hugging Face repos.
Downloaded weights are stored in a .cache folder in the user's home folder (e.g., ~/.cache/huggingface/hub/<model_name>).
See more command options and how to handle out-of-memory in the "Inference with Command Line Interface" section below.
NOTE: transformers>=4.31 is required for 16K versions.
| Size | Chat Command | Hugging Face Repo |
| --- | --- | --- |
| 7B | python3 -m fastchat.serve.cli --model-path lmsys/vicuna-7b-v1.5 | lmsys/vicuna-7b-v1.5 |
| 7B-16k | python3 -m fastchat.serve.cli --model-path lmsys/vicuna-7b-v1.5-16k | lmsys/vicuna-7b-v1.5-16k |
| 13B | python3 -m fastchat.serve.cli --model-path lmsys/vicuna-13b-v1.5 | lmsys/vicuna-13b-v1.5 |
| 13B-16k | python3 -m fastchat.serve.cli --model-path lmsys/vicuna-13b-v1.5-16k | lmsys/vicuna-13b-v1.5-16k |
| 33B | python3 -m fastchat.serve.cli --model-path lmsys/vicuna-33b-v1.3 | lmsys/vicuna-33b-v1.3 |
Old weights: see docs/vicuna_weights_version.md for all versions of weights and their differences.
Other Models
Besides Vicuna, we also released two additional models: LongChat and FastChat-T5. You can use the commands below to chat with them. They will automatically download the weights from Hugging Face repos.
| Model | Chat Command | Hugging Face Repo |
| --- | --- | --- |
| LongChat-7B | python3 -m fastchat.serve.cli --model-path lmsys/longchat-7b-32k-v1.5 | lmsys/longchat-7b-32k |
| FastChat-T5-3B | python3 -m fastchat.serve.cli --model-path lmsys/fastchat-t5-3b-v1.0 | lmsys/fastchat-t5-3b-v1.0 |
Inference with Command Line Interface
<a href="https://lmarena.ai"><img src="assets/screenshot_cli.png" width="70%"></a>
(Experimental Feature: You can specify --style rich to enable rich text output and better text streaming quality for some non-ASCII content. This may not work properly on certain terminals.)
Supported Models
FastChat supports a wide range of models, including LLama 2, Vicuna, Alpaca, Baize, ChatGLM, Dolly, Falcon, FastChat-T5, GPT4ALL, Guanaco, MTP, OpenAssistant, OpenChat, RedPajama, StableLM, WizardLM, xDAN-AI and more.
See a complete list of supported models and instructions to add a new model here.
Single GPU
The command below requires around 14GB of GPU memory for Vicuna-7B and 28GB of GPU memory for Vicuna-13B.
See the "Not Enough Memory" section below if you do not have enough memory.
--model-path can be a local folder or a Hugging Face repo name.
python3 -m fastchat.serve.cli --model-path lmsys/vicuna-7b-v1.5
Multiple GPUs
You can use model parallelism to aggregate GPU memory from multiple GPUs on the same machine.
python3 -m fastchat.serve.cli --model-path lmsys/vicuna-7b-v1.5 --num-gpus 2
Tips:
Sometimes the "auto" device mapping strategy in huggingface/transformers does not perfectly balance the memory allocation across multiple GPUs.
You can use --max-gpu-memory to specify the maximum memory per GPU for storing model weights.
This allows it to allocate more memory for activations, so you can use longer context lengths or larger batch sizes. For example,
python3 -m fastchat.serve.cli --model-path lmsys/vicuna-7b-v1.5 --num-gpus 2 --max-gpu-memory 8GiB
CPU Only
This runs on the CPU only and does not require GPU. It requires around 30GB of CPU memory for Vicuna-7B and around 60GB of CPU memory for Vicuna-13B.
python3 -m fastchat.serve.cli --model-path lmsys/vicuna-7b-v1.5 --device cpu
Use Intel AI Accelerator AVX512_BF16/AMX to accelerate CPU inference.
CPU_ISA=amx python3 -m fastchat.serve.cli --model-path lmsys/vicuna-7b-v1.5 --device cpu
Metal Backend (Mac Computers with Apple Silicon or AMD GPUs)
Use --device mps to enable GPU acceleration on Mac computers (requires torch >= 2.0).
Use --load-8bit to turn on 8-bit compression.
python3 -m fastchat.serve.cli --model-path lmsys/vicuna-7b-v1.5 --device mps --load-8bit
Vicuna-7B can run on a 32GB M1 Macbook with 1 - 2 words / second.
Intel XPU (Intel Data Center and Arc A-Series GPUs)
Install the Intel Extension for PyTorch. Set the OneAPI environment variables:
source /opt/intel/oneapi/setvars.sh
Use --device xpu to enable XPU/GPU acceleration.
python3 -m fastchat.serve.cli --model-path lmsys/vicuna-7b-v1.5 --device xpu
Vicuna-7B can run on an Intel Arc A770 16GB.
Ascend NPU
Install the Ascend PyTorch Adapter. Set the CANN environment variables:
source /usr/local/Ascend/ascend-toolkit/set_env.sh
Use --device npu to enable NPU acceleration.
python3 -m fastchat.serve.cli --model-path lmsys/vicuna-7b-v1.5 --device npu
Vicuna-7B/13B can run on an Ascend NPU.
Not Enough Memory
If you do not have enough memory, you can enable 8-bit compression by adding --load-8bit to commands above.
This can reduce memory usage by around half with slightly degraded model quality.
It is compatible with the CPU, GPU, and Metal backend.
Vicuna-13B with 8-bit compression can run on a single GPU with 16 GB of VRAM, like an Nvidia RTX 3090, RTX 4080, T4, V100 (16GB), or an AMD RX 6800 XT.
python3 -m fastchat.serve.cli --model-path lmsys/vicuna-7b-v1.5 --load-8bit
In addition to that, you can add --cpu-offloading to commands above to offload weights that don't fit on your GPU onto the CPU memory.
This requires 8-bit compression to be enabled and the bitsandbytes package to be installed, which is only available on linux operating systems.
More Platforms and Quantization
- For AMD GPU users, please install ROCm and the ROCm version of PyTorch before you install FastChat. See also this post.
- FastChat supports ExLlama V2. See docs/exllama_v2.md.
- FastChat supports GPTQ 4bit inference with GPTQ-for-LLaMa. See docs/gptq.md.
- FastChat supports AWQ 4bit inference with mit-han-lab/llm-awq. See docs/awq.md.
- [MLC LLM](https:/
