English | 简体中文

👋 join us on Twitter, Discord and WeChat

• [2023/11] TurboMind major upgrades, including: Paged Attention, faster attention kernels without sequence length limitation, 2x faster KV8 kernels, Split-K decoding (Flash Decoding), and W4A16 inference for sm_75
• [2023/09] TurboMind supports Qwen-14B
• [2023/09] TurboMind supports InternLM-20B
• [2023/09] TurboMind supports all features of Code Llama: code completion, infilling, chat / instruct, and python specialist. Click here for deployment guide
• [2023/09] TurboMind supports Baichuan2-7B
• [2023/08] TurboMind supports flash-attention2.
• [2023/08] TurboMind supports Qwen-7B, dynamic NTK-RoPE scaling and dynamic logN scaling
• [2023/08] TurboMind supports Windows (tp=1)
• [2023/08] TurboMind supports 4-bit inference, 2.4x faster than FP16, the fastest open-source implementation🚀. Check this guide for detailed info
• [2023/08] LMDeploy has launched on the HuggingFace Hub, providing ready-to-use 4-bit models.
• [2023/08] LMDeploy supports 4-bit quantization using the AWQ algorithm.
• [2023/07] TurboMind supports Llama-2 70B with GQA.
• [2023/07] TurboMind supports Llama-2 7B/13B.
• [2023/07] TurboMind supports tensor-parallel inference of InternLM.

LMDeploy is a toolkit for compressing, deploying, and serving LLM, developed by the MMRazor and MMDeploy teams. It has the following core features:

• Efficient Inference Engine (TurboMind): Based on FasterTransformer, we have implemented an efficient inference engine - TurboMind, which supports the inference of LLaMA and its variant models on NVIDIA GPUs.

• Interactive Inference Mode: By caching the k/v of attention during multi-round dialogue processes, it remembers dialogue history, thus avoiding repetitive processing of historical sessions.

• Multi-GPU Model Deployment and Quantization: We provide comprehensive model deployment and quantification support, and have been validated at different scales.

• Persistent Batch Inference: Further optimization of model execution efficiency.

LMDeploy has two inference backends, Pytorch and TurboMind. You can run lmdeploy list to check the supported model names.

Note
W4A16 inference requires Nvidia GPU with Ampere architecture or above.

Case I: output token throughput with fixed input token and output token number (1, 2048)

Case II: request throughput with real conversation data

Test Setting: LLaMA-7B, NVIDIA A100(80G)

The output token throughput of TurboMind exceeds 2000 tokens/s, which is about 5% - 15% higher than DeepSpeed overall and outperforms huggingface transformers by up to 2.3x. And the request throughput of TurboMind is 30% higher than vLLM.

Install lmdeploy with pip ( python 3.8+) or from source

pip install lmdeploy

Note
pip install lmdeploy can only install the runtime required packages. If users want to run codes from modules like lmdeploy.lite and lmdeploy.serve, they need to install the extra required packages. For instance, running pip install lmdeploy[lite] would install extra dependencies for lmdeploy.lite module.

• all: Install lmdeploy with all dependencies in requirements.txt
• lite: Install lmdeploy with extra dependencies in requirements/lite.txt
• serve: Install lmdeploy with dependencies in requirements/serve.txt

# 1. Download InternLM model

# Make sure you have git-lfs installed (https://git-lfs.com)
git lfs install
git clone https://huggingface.co/internlm/internlm-chat-7b-v1_1 /path/to/internlm-chat-7b

# if you want to clone without large files – just their pointers
# prepend your git clone with the following env var:
GIT_LFS_SKIP_SMUDGE=1

# 2. Convert InternLM model to turbomind's format, which will be in "./workspace" by default
lmdeploy convert internlm-chat-7b /path/to/internlm-chat-7b

lmdeploy chat turbomind ./workspace

Note
When inferring with FP16 precision, the InternLM-7B model requires at least 15.7G of GPU memory overhead on TurboMind.
It is recommended to use NVIDIA cards such as 3090, V100, A100, etc. Disable GPU ECC can free up 10% memory, try sudo nvidia-smi --ecc-config=0 and reboot system.

Note
Tensor parallel is available to perform inference on multiple GPUs. Add --tp=<num_gpu> on chat to enable runtime TP.

# install lmdeploy with extra dependencies
pip install lmdeploy[serve]

lmdeploy serve gradio ./workspace

Launch inference server by:

# install lmdeploy with extra dependencies
pip install lmdeploy[serve]

lmdeploy serve api_server ./workspace --instance_num 32 --tp 1

Then, you can communicate with it by command line,

# restful_api_url is what printed in api_server.py, e.g. https://localhost:23333
lmdeploy serve api_client api_server_url

or webui,

# api_server_url is what printed in api_server.py, e.g. https://localhost:23333
# server_ip and server_port here are for gradio ui
# example: lmdeploy serve gradio https://localhost:23333 --server_name localhost --server_port 6006
lmdeploy serve gradio api_server_url --server_name ${gradio_ui_ip} --server_port ${gradio_ui_port}

Refer to restful_api.md for more details.

Launch inference server by:

bash workspace/service_docker_up.sh

Then, you can communicate with the inference server by command line,

python3 -m pip install tritonclient[grpc]
lmdeploy serve triton_client {server_ip_addresss}:33337

or webui,

lmdeploy serve gradio {server_ip_addresss}:33337

For the deployment of other supported models, such as LLaMA, LLaMA-2, vicuna and so on, you can find the guide from here

For detailed instructions on Inference pytorch models, see here.

lmdeploy chat torch $NAME_OR_PATH_TO_HF_MODEL \
    --max_new_tokens 64 \
    --temperture 0.8 \
    --top_p 0.95 \
    --seed 0

deepspeed --module --num_gpus 2 lmdeploy.pytorch.chat \
    $NAME_OR_PATH_TO_HF_MODEL \
    --max_new_tokens 64 \
    --temperture 0.8 \
    --top_p 0.95 \
    --seed 0

You need to install deepspeed first to use this feature.

pip install deepspeed

LMDeploy uses AWQ algorithm for model weight quantization

Click here to view the test results for weight int4 usage.

Click here to view the usage method, implementation formula, and test results for kv int8.

Warning
runtime Tensor Parallel for quantized model is not available. Please setup --tp on deploy to enable static TP.

We appreciate all contributions to LMDeploy. Please refer to CONTRIBUTING.md for the contributing guideline.

• FasterTransformer
• llm-awq

This project is released under the Apache 2.0 license.