Skip to content

An OAI compatible exllamav2 API that's both lightweight and fast

License

Notifications You must be signed in to change notification settings

sribuu/tabbyAPI

 
 

Repository files navigation

TabbyAPI

Python 3.10, 3.11, and 3.12 License: AGPL v3 Discord Server

Developer facing API documentation

Support on Ko-Fi

Important

In addition to the README, please read the Wiki page for information about getting started!

Note

Need help? Join the Discord Server and get the Tabby role. Please be nice when asking questions.

A FastAPI based application that allows for generating text using an LLM (large language model) using the Exllamav2 backend

TabbyAPI is also the official API backend server for ExllamaV2.

Disclaimer

This project is marked as rolling release. There may be bugs and changes down the line. Please be aware that you might need to reinstall dependencies if needed.

TabbyAPI is a hobby project made for a small amount of users. It is not meant to run on production servers. For that, please look at other solutions that support those workloads.

Supported Model Types

TabbyAPI uses Exllamav2 as a powerful and fast backend for model inference, loading, etc. Therefore, the following types of models are supported:

  • Exl2 (Highly recommended)

  • GPTQ

  • FP16 (using Exllamav2's loader)

In addition, TabbyAPI supports parallel batching using paged attention for Nvidia Ampere GPUs and higher.

Alternative Loaders/Backends

If you want to use a different model type or quantization method than the ones listed above, here are some alternative backends with their own APIs:

Getting Started

Choose Models

Find the model you want on huggingface models with exl2 quantization. For example: bartowski/Qwen2-7B-Instruct-exl2

Build and Run Service Using Docker

Edit the variables in docker.sh file.

MODEL_NAME=bartowski/Qwen2-7B-Instruct-exl2 -> repo name
REVISION=6_5                                -> the specific model version to use (quantization bits in this case)
TAG=qwen2-7b                                -> docker image tag
PORT=5000                                   -> exposed port

Build service

bash docker.sh build

Run service

bash docker.sh start

Stop service

docker stop llm_onprem

Test Service using Curl

Example:

curl http://127.0.0.1:5000/v1/chat/completions \
  -H "Content-Type: application/json" \
  -d '{
     "model": "test",
     "messages": [{"role": "user", "content": "Say this is a test!"}],
     "temperature": 0.7
   }'

Contributing

Use the template when creating issues or pull requests, otherwise the developers may not look at your post.

If you have issues with the project:

  • Describe the issue in detail

  • If you have a feature request, please indicate it as such.

If you have a Pull Request

  • Describe the pull request in detail, what, and why you are changing something

Acknowldgements

TabbyAPI would not exist without the work of other contributors and FOSS projects:

Developers and Permissions

Creators/Developers:

About

An OAI compatible exllamav2 API that's both lightweight and fast

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 91.0%
  • Jupyter Notebook 4.0%
  • Jinja 1.4%
  • Dockerfile 1.3%
  • Shell 1.3%
  • Batchfile 1.0%