2023-03-27 04:09:07 +00:00
< div align = "center" >
2023-03-27 04:45:59 +00:00
2023-09-21 09:35:59 +00:00
# 🐾 Tabby 🐱
2023-06-06 00:38:54 +00:00
[](https://github.com/TabbyML/tabby/actions/workflows/ci.yml)
2023-04-09 10:08:07 +00:00
[](https://hub.docker.com/r/tabbyml/tabby)
2023-06-06 00:38:54 +00:00
[](https://opensource.org/licenses/Apache-2.0)
2023-06-17 06:11:04 +00:00
[](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA)
2023-06-16 21:55:06 +00:00
2023-03-27 04:09:07 +00:00
< / div >
2023-03-16 09:26:43 +00:00
2023-08-29 02:14:44 +00:00
Tabby is a self-hosted AI coding assistant, offering an open-source and on-premises alternative to GitHub Copilot. It boasts several key features:
* Self-contained, with no need for a DBMS or cloud service.
2023-03-27 04:09:07 +00:00
* OpenAPI interface, easy to integrate with existing infrastructure (e.g Cloud IDE).
2023-08-29 02:14:44 +00:00
* Supports consumer-grade GPUs.
2023-03-16 10:23:45 +00:00
2023-04-06 16:35:48 +00:00
< p align = "center" >
2023-06-07 23:24:18 +00:00
< a target = "_blank" href = "https://tabbyml.github.io/tabby/playground" > < img alt = "Open in Playground" src = "https://img.shields.io/badge/OPEN%20IN%20PLAYGROUND-blue?logo=xcode&style=for-the-badge&logoColor=green" > < / a >
2023-04-06 16:35:48 +00:00
< / p >
2023-04-06 16:30:00 +00:00
< p align = "center" >
< img alt = "Demo" src = "https://user-images.githubusercontent.com/388154/230440226-9bc01d05-9f57-478b-b04d-81184eba14ca.gif" >
< / p >
2023-09-21 09:35:59 +00:00
## 🔥 What's New
* **09/21/2023** We've hit **10K stars** 🌟 on GitHub! 🚀🎉👏
2023-09-18 04:54:14 +00:00
* **09/18/2023** Apple's M1/M2 Metal inference support has landed in [v0.1.1 ](https://github.com/TabbyML/tabby/releases/tag/v0.1.1 )!
2023-09-21 09:35:59 +00:00
* **08/31/2023** Tabby's first stable release [v0.0.1 ](https://github.com/TabbyML/tabby/releases/tag/v0.0.1 ) 🥳.
2023-08-29 02:14:44 +00:00
* **08/28/2023** Experimental support for the [CodeLlama 7B ](https://github.com/TabbyML/tabby/issues/370 ).
* **08/24/2023** Tabby is now on [JetBrains Marketplace ](https://plugins.jetbrains.com/plugin/22379-tabby )!
2023-04-06 16:30:00 +00:00
2023-09-06 13:04:35 +00:00
## 👋 Getting Started
2023-03-27 04:59:08 +00:00
2023-08-29 02:36:05 +00:00
The easiest way to start a Tabby server is by using the following Docker command:
```bash
docker run -it \
--gpus all -p 8080:8080 -v $HOME/.tabby:/data \
tabbyml/tabby \
serve --model TabbyML/SantaCoder-1B --device cuda
```
For additional options (e.g inference type, parallelism), please refer to the documentation at https://tabbyml.github.io/tabby.
2023-06-15 02:33:57 +00:00
2023-09-06 13:04:35 +00:00
## 🤝 Contributing
### Get the Code
```bash
2023-09-08 00:50:25 +00:00
git clone --recurse-submodules https://github.com/TabbyML/tabby
2023-09-06 13:04:35 +00:00
cd tabby
```
2023-09-22 03:20:36 +00:00
If you have already cloned the repository, you could run the `git submodule update --recursive --init` command to fetch all submodules.
2023-09-06 13:04:35 +00:00
### Build
1. Set up the Rust environment by following this [tutorial ](https://www.rust-lang.org/learn/get-started ).
2. Install the required dependencies:
```bash
# For MacOS
brew install protobuf
# For Ubuntu / Debian
apt-get install protobuf-compiler libopenblas-dev
```
3. Now, you can build Tabby by running the command `cargo build` .
2023-09-06 13:18:07 +00:00
### Start Hacking!
2023-09-06 13:20:37 +00:00
... and don't forget to submit a [Pull Request ](https://github.com/TabbyML/tabby/compare )
2023-09-06 13:18:07 +00:00
2023-09-06 13:04:35 +00:00
2023-08-29 02:14:44 +00:00
## 🌟 Star History
2023-06-15 02:33:57 +00:00
[](https://star-history.com/#tabbyml/tabby& Date)
