mirror of
https://github.com/TabbyML/tabby
synced 2024-11-22 00:08:06 +00:00
62 lines
3.9 KiB
Plaintext
Vendored
62 lines
3.9 KiB
Plaintext
Vendored
---
|
|
sidebar_position: 0
|
|
---
|
|
|
|
# 👋 Getting Started
|
|
|
|
Tabby is an open-source, self-hosted AI coding assistant. With Tabby, every team can set up its own LLM-powered code completion server with ease.
|
|
|
|
[](https://links.tabbyml.com/join-slack)
|
|
[](https://www.linkedin.com/company/tabbyml/)
|
|
[](https://github.com/TabbyML/tabby)
|
|
|
|
<div className="flex w-full flex-col justify-center items-center">
|
|
<div className="flex w-full lg:w-8/12 aspect-[16/10]">
|
|
<iframe className="flex-1"
|
|
allow="fullscreen"
|
|
src="https://www.loom.com/embed/a137618d68fd4629805dbfeb93471035?sid=78d1e91a-984e-4e06-b682-e1ab10ca380a?hide_owner=true&hide_share=true&hide_title=true&hideEmbedTopBar=true"
|
|
>
|
|
</iframe>
|
|
</div>
|
|
|
|
<p className="mt-2 italic">Product demo to bring Tabby locally on Mac</p>
|
|
</div>
|
|
|
|
## 📄 About the Docs
|
|
|
|
| Section | Goal |
|
|
| ----------------------------------------------- | --------------------------------------------------------------------------- |
|
|
| [📚 Installation](/docs/installation) | Everything deployment: Docker, Homebrew, Hugging Face Space and many others |
|
|
| [💻 IDE / Editor Extensions](/docs/extensions) | IDE/Editor extensions that can be seamlessly integrated with Tabby |
|
|
| [🧑🔬 Models Directory](/docs/models) | A curated list of models that we recommend using with Tabby |
|
|
| [🏷️ API References](/api) | Checkout Tabby API Documentation |
|
|
| [🏘️ Community](#%EF%B8%8F-community) | Everything about for developers and contributing |
|
|
| [🗺️ Roadmap](/docs/roadmap) | Our future plans |
|
|
|
|
## 📏 Principles
|
|
|
|
* **Open**: Tabby is free, open-source, and compatible with major Coding LLMs (CodeLlama, StarCoder, CodeGen). In fact, you can use and combine your preferred models without implementing anything by yourself.
|
|
|
|
* **End-to-End**: While most coding tools consider code completion merely as a thin wrapper atop Coding LLMs, in real-world scenarios, optimizations in IDE extensions can be just as crucial as the capabilities of Coding LLMs.
|
|
Tabby optimizes the entire stack:
|
|
+ <u>IDE extensions</u>: Tabby achieves accurate streaming and cancellation with an adaptive caching strategy to ensure rapid completion (in less than a second).
|
|
+ <u>Model serving</u>: Tabby parses relevant code into Tree Sitter tags to provide effective prompts.
|
|
|
|
* **User and Developer Experience**: The key to sustainable open-source solutions is to make it easier for everyone to contribute to projects.
|
|
AI experts should feel comfortable understanding and improving the suggestion quality.
|
|
EngOps team should find it easy to set up and feel in control of the data.
|
|
Developers should have an "aha" moment during coding time.
|
|
Tabby optimizes the experience for these core users to enhance your team's productivity.
|
|
|
|
## 🏘️ Community
|
|
|
|
- ⭐ Tabby [Github repo](https://github.com/TabbyML/tabby) to stay updated about new releases and tutorials.
|
|
|
|
- 🙋 Join the Tabby community on [Slack](https://links.tabbyml.com/join-slack) and get direct support from the community.
|
|
|
|
- 🎤 Follow Tabby on [Twitter / X](https://twitter.com/Tabby_ML) to engage with TabbyML for all things possible.
|
|
|
|
- 📚 Follow Tabby on [LinkedIn](https://www.linkedin.com/company/tabbyml/) for the latest from the community.
|
|
|
|
- 💌 Subscribe to our [Newsletter](https://newsletter.tabbyml.com/archive) to unlock Tabby insights and secrets.
|