docs: add faq on how to convert own model for tabby (#592)

r0.4
Meng Zhang 2023-10-18 16:18:24 -07:00 committed by GitHub
parent fc63dd7458
commit 7818f640e9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 0 deletions

View File

@ -1,5 +1,11 @@
# Tabby Model Specification (Unstable)
> 💁 **INFO**
> Tabby currently operates with two inference backends: [ctranslate2](https://github.com/OpenNMT/CTranslate2) and [llama.cpp](https://github.com/ggerganov/llama.cpp).
> The CUDA/CPU device utilizes ctranslate2 when the `--device cuda` or `--device cpu` options are specified, while the Metal (M1/M2) device employs llama.cpp with the `--device metal` option.
>
> It is possible to create a model that is only usable for a specific inference backend. However, in general, the Tabby team will maintain models that are usable on all devices.
Tabby organizes the model within a directory. This document provides an explanation of the necessary contents for supporting model serving. An example model directory can be found at https://huggingface.co/TabbyML/StarCoder-1B
The minimal Tabby model directory should include the following contents:

View File

@ -31,3 +31,11 @@ import CodeBlock from '@theme/CodeBlock';
</CodeBlock>
</div>
</details>
<details>
<summary>How can I convert my own model for use with Tabby?</summary>
<div>
<p>Follow the instructions provided in the <a href="https://github.com/TabbyML/tabby/blob/main/MODEL_SPEC.md">Model Spec</a>.</p>
<p>Please note that the spec is unstable and does not adhere to semver.</p>
</div>
</details>