mirrors/tabby
1
0
Fork 0
mirror of https://github.com/TabbyML/tabby synced 2024-11-22 08:21:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add docs ToC + fix model directory license (#439)

Browse Source 
* docs: fix license for model directory

* docs: add docs ToC
This commit is contained in:
Meng Zhang 2023-09-13 10:19:29 +08:00 committed by GitHub
parent aae392417e
commit 4ac5006b89
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 26 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
website/docs/getting-started.md
View File

@ -9,11 +9,23 @@ Tabby is an open-source, self-hosted AI coding assistant. With Tabby, every team
[![Follow on Linkedin](https://shields.io/badge/Follow%20on%20Linkedin-e29351?logo=linkedin)](https://www.linkedin.com/company/tabbyml/)
[![Star on Github](https://img.shields.io/github/stars/TabbyML/tabby?labelColor=e29351&label=Star&color=ffffff&logo=github)](https://github.com/TabbyML/tabby)
## 📄 About the Docs
| Section | Goal |
| ------------------------------------------- | --------------------------------------------------------------------------- |
| [🔧 Installation](./installation) | Everything deployment: Docker, Homebrew, Hugging Face Space and many others |
| [💻 IDE / Editor Extensions](./extensions) | IDE/Editor extensions that can be seamlessly integrated with Tabby |
| [🧑‍🔬 Models Directory](./models) | A curated list of models that we recommend using with Tabby |
| [🏷️ API References](/api) | API Documentation |
| [🏘️ Community](#%EF%B8%8F-community) | Everything about for developers and contributing |
| [🗺️ Roadmap](./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 serving stack:
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.
@ -27,8 +39,4 @@ Tabby optimizes the experience for these core users to enhance your team's produ
⭐ Tabby [Github repo](https://github.com/TabbyML/tabby) to stay updated about new releases and tutorials.
🙋 Join the Tabby community on [Slack](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA) and get direct support from the community.
## 🗺️ Roadmap
We continuously work on updating [our roadmap](./roadmap) and we love to discuss those with our community. Feel encouraged to participate.
🙋 Join the Tabby community on [Slack](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA) and get direct support from the community.

18
website/docs/models/index.md
View File

@ -4,16 +4,16 @@ sidebar_position: 4
# 🧑‍🔬 Models Directory
We maintains a recommended collection of models varies from 200M to 10B+ for various use cases.
We maintains a curated list of models varies from 200M to 10B+.
| Model ID | License | <span title="Apple M1/M2 Only">Metal Support</span> |
| --------------------------------------------------------------------- | ---------------- | :-------------------------------------------------: |
| [TabbyML/CodeLlama-13B](https://huggingface.co/TabbyML/CodeLlama-13B) | Llama2 | ❌ |
| [TabbyML/CodeLlama-7B](https://huggingface.co/TabbyML/CodeLlama-7B) | Llama2 | ✅ |
| [TabbyML/StarCoder-1B](https://huggingface.co/TabbyML/StarCoder-1B) | BigCode-OpenRAIL | ❌ |
| [TabbyML/SantaCoder-1B](https://huggingface.co/TabbyML/SantaCoder-1B) | OpenRAIL | ❌ |
| [TabbyML/J-350M](https://huggingface.co/TabbyML/J-350M) | BSD-3 | ❌ |
| [TabbyML/T5P-220M](https://huggingface.co/TabbyML/T5P-220M) | BSD-3 | ❌ |
| Model ID | License | <span title="Apple M1/M2 Only">Metal Support</span> |
| --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | :-------------------------------------------------: |
| [TabbyML/CodeLlama-13B](https://huggingface.co/TabbyML/CodeLlama-13B) | [Llama2](https://github.com/facebookresearch/llama/blob/main/LICENSE) | ❌ |
| [TabbyML/CodeLlama-7B](https://huggingface.co/TabbyML/CodeLlama-7B) | [Llama2](https://github.com/facebookresearch/llama/blob/main/LICENSE) | ✅ |
| [TabbyML/StarCoder-1B](https://huggingface.co/TabbyML/StarCoder-1B) | [BigCode-OpenRAIL-M](https://huggingface.co/spaces/bigcode/bigcode-model-license-agreement) | ❌ |
| [TabbyML/SantaCoder-1B](https://huggingface.co/TabbyML/SantaCoder-1B) | [BigCode-OpenRAIL-M](https://huggingface.co/spaces/bigcode/bigcode-model-license-agreement) | ❌ |
| [TabbyML/J-350M](https://huggingface.co/TabbyML/J-350M) | [BSD-3](https://opensource.org/license/bsd-3-clause/) | ❌ |
| [TabbyML/T5P-220M](https://huggingface.co/TabbyML/T5P-220M) | [BSD-3](https://opensource.org/license/bsd-3-clause/) | ❌ |
### CodeLlama-7B / CodeLlama-13B
Code Llama is a collection of pretrained and fine-tuned generative text models. Theses model is designed for general code synthesis and understanding.

4
website/docs/roadmap.md
View File

@ -1,4 +1,6 @@
# 🚀 Roadmap
# 🗺️ Roadmap
We continuously work on updating our roadmap and we love to discuss those with our community. Feel encouraged to participate.
## Q4 2023
* 🔧 Improve RAG by deeper integration with Treesitter using custom query. This will bring LSP-like understanding to Tabby's code index.