PygmalionAI's large-scale inference engine
pygmalion.chat

It is designed to serve as the inference endpoint for the PygmalionAI website, and to allow serving the Pygmalion models to a large number of users with blazing fast speeds (thanks to vLLM's Paged Attention).

AlpinDale c3b15f0926 do not allow context shift for enc-dec 9 months ago
.github 06312251a7 fix: explictly export CUDA arches for CI 9 months ago
aphrodite c3b15f0926 do not allow context shift for enc-dec 9 months ago
assets b3df2351c8 readme: update with bsz1 graph 10 months ago
docker 8e259ee7cf chore: hf_transfer for faster downloads (#339) 9 months ago
examples 070c1cef8c fix: explicit RFC3986 for prometheus_client asgi (#344) 9 months ago
kernels a788ca33bf hack in custom bias for attention kernels 9 months ago
rocm_patch 13d850334e fix: navi support (#283) 10 months ago
tests e42a78381a feat: switch from pylint to ruff (#322) 9 months ago
.gitignore e42a78381a feat: switch from pylint to ruff (#322) 9 months ago
LICENSE 5adcb33e14 Revert license back to AGPLv3 (#38) 1 year ago
MANIFEST.in 3c512ef982 fix docker container and add klite embd to wheel 1 year ago
README.md 5d747cfc4d readme: docker docs (#340) 9 months ago
build-linux-wheel.sh aebd68c632 feat: backport kernels (#235) 11 months ago
env.py e42a78381a feat: switch from pylint to ruff (#322) 9 months ago
environment.yaml e120404436 Revert "feat: CMake Build System Generator (#332)" 9 months ago
formatting.sh e42a78381a feat: switch from pylint to ruff (#322) 9 months ago
mypy.ini 9b317aa26a feat: finish up tests and workflows (#87) 1 year ago
patch_xformers.rocm.sh 13d850334e fix: navi support (#283) 10 months ago
pyproject.toml e120404436 Revert "feat: CMake Build System Generator (#332)" 9 months ago
requirements-dev.txt e42a78381a feat: switch from pylint to ruff (#322) 9 months ago
requirements-rocm.txt 2755a48d51 merge dev branch into main (#153) 1 year ago
requirements.txt 1b6732fcde chore: bump transformers version 9 months ago
runtime.sh cbe37e8b18 fix: speed up cuda home detection (#288) 10 months ago
setup.py e120404436 Revert "feat: CMake Build System Generator (#332)" 9 months ago
update-runtime.sh 132d9927cb fix: speedup runtime update script 10 months ago

README.md

Breathing Life into Language

aphrodite

Aphrodite is the official backend engine for PygmalionAI. It is designed to serve as the inference endpoint for the PygmalionAI website, and to allow serving the Pygmalion models to a large number of users with blazing fast speeds (thanks to vLLM's Paged Attention).

Aphrodite builds upon and integrates the exceptional work from various projects.

The compute necessary for Aphrodite's development is provided by Arc Compute.

Features

  • Continuous Batching
  • Efficient K/V management with PagedAttention from vLLM
  • Optimized CUDA kernels for improved inference
  • Quantization support via AQLM, AWQ, Bitsandbytes, EXL2, GGUF, GPTQ, QuIP#, Smoothquant+, and SqueezeLLM
  • Distributed inference
  • Variety of sampling methods (Mirostat, Locally Typical Sampling, Tail-Free Sampling, etc)
  • 8-bit KV Cache for higher context lengths and throughput, at both FP8 and INT8 formats.

Quickstart

pip install aphrodite-engine

python -m aphrodite.endpoints.openai.api_server --model PygmalionAI/pygmalion-2-7b

[!CAUTION] If the installation reports CUDA kernel errors, please run pip install aphrodite-engine=0.4.5 instead.

This will create a OpenAI-compatible API server that can be accessed at port 2242 of the localhost. You can plug in the API into a UI that supports OpenAI, such as SillyTavern.

You can play around with the engine in the demo here:

Open In Colab

Docker

Additionally, we provide a Docker image for easy deployment. Here's a basic command to get you started:

sudo docker run -d -e MODEL_NAME="mistralai/Mistral-7B-Instruct-v0.2" -p 2242:7860 --gpus all --ipc host alpindale/aphrodite-engine

This will pull the Aphrodite Engine image (~9GiB download), and launch the engine with the Mistral-7B model at port 2242. Check here for the full list of env variables.

See here for the Compose file to use with Docker Compose.

Requirements

  • Operating System: Linux (or WSL for Windows)
  • Python: at least 3.8

For windows users, it's recommended to use tabbyAPI instead, if you do not need batching support.

Build Requirements:

  • CUDA >= 11

For supported GPUs, see here. Generally speaking, all semi-modern GPUs are supported - down to Pascal (GTX 10xx, P40, etc.)

Installation

Usage

For usage, please refer to the wiki page for detailed instructions. Aphrodite provides many different options for LLM inference, so please read through the list of options here.

Performance

Speeds vary with different GPUs, model sizes, quantization schemes, batch sizes, etc. Here are some baseline benchmarks conducted by requesting as many completions as possible from the API server.

Batch Size 1 Performance

These are the speeds a user would normally get if they request a single output with a sizable prompt and output length. Essentially, normal chatting experience.

The following results were gathered by sending a request with 8192 prompt tokens and requesting 1024 tokens with ignore_eos=True.

GPU: NVIDIA A40, Mistral 7B. Baseline is the same model loaded with text-generation-webui in FP16.

High Batch Size Performance

[!NOTE]
The numbers below are the theoretical peak achieved by only requesting output tokens at very high batch sizes. At lower batch sizes with much larger prompts, the results will be vastly different. Throughput refers to output tokens per second.

This table is outdated, will be replaced soon.

Model Quantization bits GPU Throughput (T/s)
Mistral 7B None 16 RTX 4090 5489.3
AWQ 4 RTX 4090 4078.8
GPTQ 4 RTX 4090 7850.4
8 RTX 4090 7658.0
GGUF Q8 RTX 4090 5141.2
Q6KM RTX 4090 5791.7
Q5KM RTX 4090 5786.2
Q4KM RTX 4090 5815.8
SqueezeLLM 4 RTX 4090 549.5
Llama-2 7B None 16 RTX 4090 2576.2
AWQ 4 RTX 4090 3551.3
GPTQ 4 RTX 4090 2919.1
GGUF Q4KM RTX 4090 2726.6
Q5KM RTX 4090 2763.4
Q6KM RTX 4090 2694.7
Q8 RTX 4090 2647.0
SqueezeLLM 4 RTX 4090 580.3

Notes

  1. By design, Aphrodite takes up 90% of your GPU's VRAM. If you're not serving an LLM at scale, you may want to limit the amount of memory it takes up. You can do this in the API example by launching the server with the --gpu-memory-utilization 0.6 (0.6 means 60%).

  2. You can view the full list of commands by running python -m aphrodite.endpoints.openai.api_server --help.

  3. Context Length extension via the RoPE method is supported for most models. Use the command-line flag --max-model-len to specify a desired context length and the engine will adjust the RoPE scaling accordingly.

  4. Please refer to the FAQ & Issues if you run into problems. If you don't find an answer there, please make an issue.

Acknowledgements

Aphrodite Engine would have not been possible without the phenomenal work of other open-source projects. Credits go to:

Contributing

Everyone is welcome to contribute. You can support the project by opening Pull Requests for new features, fixes, or general UX improvements.