From eacafd63a56da33cc22769fe1e214793543caf7a Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Mon, 27 Mar 2023 12:59:08 +0800 Subject: [PATCH] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index bdbfb4435..128b4a490 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,9 @@ An opensource / on-prem alternative to GitHub Copilot. * Consumer level GPU supports (FP-16 weight loading with various optimization). ## Get started + +### Docker + The easiest way of getting started is using the `deployment/docker-compose.yml`: ```bash docker-compose up @@ -40,6 +43,10 @@ We also provides an interactive playground in admin panel [localhost:8501](http: ![image](https://user-images.githubusercontent.com/388154/227792390-ec19e9b9-ebbb-4a94-99ca-8a142ffb5e46.png) +### API documentation + +Tabby opens an FastAPI server at [localhost:5000](https://localhost:5000), which embeds an OpenAPI documentation of the HTTP API. + ## TODOs * [ ] Fine-tuning models on private code repository.