From 3e9cbc021954dba913084b22c34e5a04ad8c8841 Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Mon, 27 Mar 2023 12:09:07 +0800 Subject: [PATCH] Update README.md --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5cc7deb..d93e37b 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,28 @@ -## 🐾 Tabby +
+# 🐾 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. +> Tabby is still in the alpha phrase -An opensource / on-prem alternative to GitHub Copilot +An opensource / on-prem alternative to GitHub Copilot. -## Deployment +## Features -See [deployment](./docs/deployment.md) +* Self-contained, with no need for a DBMS or cloud service +* Web UI for visualizing and configuration models and MLOps. +* OpenAPI interface, easy to integrate with existing infrastructure (e.g Cloud IDE). +* Consumer level GPU supports (FP-16 weight loading with various optimization). + +## Getting started +To get started with Tabby, see the [docs/deployment](./docs/deployment). + +## Roadmap + +* [ ] Fine-tuning models on private code repository. +* [ ] Plot metrics in admin panel (e.g acceptance rate). +* [ ] Production ready (Open Telemetry, Prometheus metrics).