tabby/README.md

## 🐾 Tabby
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
![Docker build status](https://img.shields.io/github/actions/workflow/status/TabbyML/tabby/docker.yml?label=docker%20image%20build)

> **Warning**
> This repository is undering heavy construction, everything changes fast.

An opensource / on-prem alternative to GitHub Copilot

## Contents
* [`admin`](./admin): Admin panel for monitoring / settings purpose.
* [`server`](./server): API server for completion requests. It also logs users' selections (as feedback to model's quality).
* [`deployment`](./deployment): Container related deployment configs.
* [`converter`](./converter): Converts a [transformers](https://huggingface.co/docs/transformers) causal LM model into TensorRT / FasterTransformer serving formats.
* [`preprocess`](./preprocess): Preprocess files into [datasets](https://huggingface.co/docs/datasets)
* [`tabformer`](./tabformer): *NOT RELEASED* Trainer(PEFT w/RLHF) for tabby models.

## Development

Assuming Linux workstation with:
1. docker
2. docker w/ gpu driver
3. python 3.10

Use `make dev` to start local dev server.
Add project preprocessing 2023-03-16 09:26:43 +00:00			`## 🐾 Tabby`
Update README.md 2023-03-16 09:28:20 +00:00			`[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)`
Add project preprocessing 2023-03-16 09:26:43 +00:00			`[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)`
Add docker build workflow 2023-03-22 15:20:24 +00:00			`![Docker build status](https://img.shields.io/github/actions/workflow/status/TabbyML/tabby/docker.yml?label=docker%20image%20build)`
Add project preprocessing 2023-03-16 09:26:43 +00:00
			`> Warning`
			`> This repository is undering heavy construction, everything changes fast.`
Update README.md 2023-03-16 10:23:45 +00:00
Update README.md 2023-03-22 16:22:44 +00:00			`An opensource / on-prem alternative to GitHub Copilot`
Update README.md 2023-03-22 16:21:07 +00:00
Update README.md 2023-03-16 10:23:45 +00:00			`## Contents`
Add admin panel (w/ streamlit) and logging (w/ vectordev) (#4) 2023-03-22 15:18:12 +00:00			* [`admin`](./admin): Admin panel for monitoring / settings purpose.
Update README.md 2023-03-22 15:27:30 +00:00			* [`server`](./server): API server for completion requests. It also logs users' selections (as feedback to model's quality).
Add admin panel (w/ streamlit) and logging (w/ vectordev) (#4) 2023-03-22 15:18:12 +00:00			* [`deployment`](./deployment): Container related deployment configs.
Update README.md 2023-03-16 10:24:22 +00:00			* [`converter`](./converter): Converts a [transformers](https://huggingface.co/docs/transformers) causal LM model into TensorRT / FasterTransformer serving formats.
Add admin panel (w/ streamlit) and logging (w/ vectordev) (#4) 2023-03-22 15:18:12 +00:00			* [`preprocess`](./preprocess): Preprocess files into [datasets](https://huggingface.co/docs/datasets)
Update README.md 2023-03-22 16:19:38 +00:00			* [`tabformer`](./tabformer): NOT RELEASED Trainer(PEFT w/RLHF) for tabby models.
Reduce repo size (#5) * Remove binary files from git * Add Makefile * update 2023-03-23 05:10:59 +00:00
			`## Development`

			`Assuming Linux workstation with:`
			`1. docker`
			`2. docker w/ gpu driver`
			`3. python 3.10`

			Use `make dev` to start local dev server.