Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/PygmalionAI/aphrodite-engine

Large-scale LLM inference engine
https://github.com/PygmalionAI/aphrodite-engine

api-rest cuda inference-engine inferentia intel lora machine-learning rocm speculative-decoding tpu

Last synced: 13 days ago
JSON representation

Large-scale LLM inference engine

Host: GitHub
URL: https://github.com/PygmalionAI/aphrodite-engine
Owner: PygmalionAI
License: agpl-3.0
Created: 2023-06-23T02:34:29.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-10-29T12:45:30.000Z (18 days ago)
Last Synced: 2024-10-29T15:03:39.279Z (18 days ago)
Topics: api-rest, cuda, inference-engine, inferentia, intel, lora, machine-learning, rocm, speculative-decoding, tpu
Language: Python
Homepage: https://aphrodite.pygmalion.chat
Size: 17.1 MB
Stars: 1,085
Watchers: 14
Forks: 120
Open Issues: 65
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-repositories - PygmalionAI/aphrodite-engine - Large-scale LLM inference engine (Python)
StarryDivineSky - PygmalionAI/aphrodite-engine

README

        


Breathing Life into Language



![aphrodite](https://raw.githubusercontent.com/PygmalionAI/aphrodite-engine/main/assets/aphrodite.png)

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](https://huggingface.co/PygmalionAI) 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](#acknowledgements).

The compute necessary for Aphrodite's development is provided by [Arc Compute](https://www.arccompute.io).

## Features

- Continuous Batching

- Efficient K/V management with [PagedAttention](./aphrodite/modeling/layers/attention.py) 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](https://arxiv.org/abs/2007.14966), [Locally Typical Sampling](https://arxiv.org/abs/2202.00666), Tail-Free Sampling, etc)

- 8-bit KV Cache for higher context lengths and throughput, at both FP8 and INT8 formats.

## Quickstart

Install the engine:

```sh

pip install -U aphrodite-engine --extra-index-url https://downloads.pygmalion.chat/whl

```

***

> [!IMPORTANT]  

> If you need the latest features, such as **Llama 3.1** support, you will need to build the release candidate branch.

Install directly:

```sh

pip install -U aphrodite-engine@git+https://github.com/PygmalionAI/aphrodite-engine.git@rc_054

```

Or clone and build (recommended):

```sh

git clone -b rc_054 https://github.com/PygmalionAI/aphrodite-engine.git && cd aphrodite-engine

pip install -e .

```

***

Then launch a model:

```sh

aphrodite run meta-llama/Meta-Llama-3-8B-Instruct

```

This will create a [OpenAI](https://platform.openai.com/docs/api-reference/)-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](https://github.com/SillyTavern/SillyTavern).

Please refer to the [wiki](https://github.com/PygmalionAI/aphrodite-engine/wiki) for the full list of arguments and flags you can pass to the engine.

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

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/AlpinDale/misc-scripts/blob/main/Aphrodite.ipynb)

### Docker

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

```sh

sudo docker run -d -e MODEL_NAME="mistralai/Mistral-7B-Instruct-v0.2" -p 2242:2242 --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](/docker/.env) for the full list of env variables.

See [here](/docker/docker-compose.yml) 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](https://github.com/theroyallab/tabbyAPI) instead, if you do not need batching support.

#### Build Requirements:

- CUDA >= 11

For supported GPUs, see [here](https://github.com/PygmalionAI/aphrodite-engine/wiki/1.-Installation#supported-gpus). Generally speaking, all semi-modern GPUs are supported - down to Pascal (GTX 10xx, P40, etc.)

## Installation

- [Using pip](https://github.com/PygmalionAI/aphrodite-engine/wiki/1.-Installation#pre-compiled-binaries-via-pypi)

- [Build from source](https://github.com/PygmalionAI/aphrodite-engine/wiki/1.-Installation#build-from-source)

## Usage

For usage, please refer to the [wiki page](https://github.com/PygmalionAI/aphrodite-engine/wiki/2.-Usage) for detailed instructions. Aphrodite provides many different options for LLM inference, so please read through the list of options [here](https://github.com/PygmalionAI/aphrodite-engine/wiki/3.-Engine-Options).

## 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](https://github.com/PygmalionAI/aphrodite-engine/blob/main/aphrodite/endpoints/openai/api_server.py).

### 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.

![](/assets/bsz1.png)

### High Batch Size Performance

Work in Progress.

### 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 `aphrodite run --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](https://github.com/PygmalionAI/aphrodite-engine/wiki/6.-FAQ-&-Issues) if you run into problems. If you don't find an answer there, please make an [issue](https://github.com/PygmalionAI/aphrodite-engine/issues).

## Acknowledgements

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

- [vLLM](https://github.com/vllm-project/vllm) (CacheFlow)

- [TensorRT-LLM](https://github.com/NVIDIA/TensorRT-LLM)

- [xFormers](https://github.com/facebookresearch/xformers)

- [AutoAWQ](https://github.com/casper-hansen/AutoAWQ)

- [AutoGPTQ](https://github.com/PanQiWei/AutoGPTQ)

- [SqueezeLLM](https://github.com/SqueezeAILab/SqueezeLLM/)

- [Exllamav2](https://github.com/turboderp/exllamav2)

- [TabbyAPI](https://github.com/theroyallab/tabbyAPI)

- [AQLM](https://github.com/Vahe1994/AQLM)

- [KoboldAI](https://github.com/henk717/KoboldAI)

- [Text Generation WebUI](https://github.com/oobabooga/text-generation-webui)

- [Megatron-LM](https://github.com/NVIDIA/Megatron-LM)

- [Ray](https://github.com/ray-project/ray)

## Contributing

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