No description
Find a file
kingbri 30a3cd75cf Start: Migrate options from cu121/118 to cu12
This encapsulates more cuda versions and makes install easier for
new users.

Signed-off-by: kingbri <8082010+kingbri1@users.noreply.github.com>
2025-08-19 22:56:58 -04:00
.github Actions: Update and add Wiki publish 2025-02-17 23:47:38 -05:00
backends Model: Add log messages for model loading 2025-08-17 23:09:27 -04:00
colab Start: Migrate options from cu121/118 to cu12 2025-08-19 22:56:58 -04:00
common Config: Move sampling higher in the list 2025-08-18 22:55:03 -04:00
docker Start: Migrate options from cu121/118 to cu12 2025-08-19 22:56:58 -04:00
docs Start: Migrate options from cu121/118 to cu12 2025-08-19 22:56:58 -04:00
endpoints Model: Add tensor_parallel_backend option 2025-08-17 22:35:10 -04:00
loras Implement lora support (#24) 2023-12-08 23:38:08 -05:00
models Tree: Update documentation and configs 2023-11-16 02:30:33 -05:00
sampler_overrides Config: Enable safe sampler overrides by default 2025-08-18 12:32:28 -07:00
templates Templates: Adjust tool call example 2025-07-05 21:42:23 -04:00
tests Tree: Format 2025-05-17 00:46:40 -04:00
update_scripts Start: Make linux scripts executable 2024-08-03 15:19:31 -04:00
.dockerignore debloat docker build 2024-09-08 00:02:00 +01:00
.gitignore Config: Enable safe sampler overrides by default 2025-08-18 12:32:28 -07:00
api_tokens_sample.yml Improve docker deployment configuration (#163) 2024-08-18 15:19:18 -04:00
config_sample.yml Config: Move sampling higher in the list 2025-08-18 22:55:03 -04:00
formatting.bat feat: workflows for formatting/linting (#35) 2023-12-22 16:20:35 +00:00
formatting.sh feat: workflows for formatting/linting (#35) 2023-12-22 16:20:35 +00:00
LICENSE Create LICENSE 2023-11-16 17:43:23 -05:00
main.py Start: Migrate options from cu121/118 to cu12 2025-08-19 22:56:58 -04:00
pyproject.toml Start: Migrate options from cu121/118 to cu12 2025-08-19 22:56:58 -04:00
README.md Update README 2025-06-13 14:57:01 -04:00
start.bat Start: Fix startup with new argparser 2024-09-21 14:36:21 -04:00
start.py Start: Migrate options from cu121/118 to cu12 2025-08-19 22:56:58 -04:00
start.sh Start: Fix startup with new argparser 2024-09-21 14:36:21 -04:00

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.

Note

Want to run GGUF models? Take a look at YALS, TabbyAPI's sister project.

A FastAPI based application that allows for generating text using an LLM (large language model) using the Exllamav2 and Exllamav3 backends.

TabbyAPI is also the official API backend server for ExllamaV2 and V3.

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.

Getting Started

Important

Looking for more information? Check out the Wiki.

For a step-by-step guide, choose the format that works best for you:

📖 Read the Wiki Covers installation, configuration, API usage, and more.

🎥 Watch the Video Guide A hands-on walkthrough to get you up and running quickly.

Features

  • OpenAI compatible API
  • Loading/unloading models
  • HuggingFace model downloading
  • Embedding model support
  • JSON schema + Regex + EBNF support
  • AI Horde support
  • Speculative decoding via draft models
  • Multi-lora with independent scaling (ex. a weight of 0.9)
  • Inbuilt proxy to override client request parameters/samplers
  • Flexible Jinja2 template engine for chat completions that conforms to HuggingFace
  • Concurrent inference with asyncio
  • Utilizes modern python paradigms
  • Continuous batching engine using paged attention
  • Fast classifier-free guidance
  • OAI style tool/function calling

And much more. If something is missing here, PR it in!

Supported Model Types

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

  • Exl2 (Highly recommended)

  • Exl3 (Highly recommended)

  • GPTQ

  • FP16 (using Exllamav2's loader)

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

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: