docs: add hugging face installation guide (#432)

release-0.2
Meng Zhang 2023-09-12 10:37:06 +08:00 committed by GitHub
parent 248c1717df
commit 682c21e536
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 77 additions and 0 deletions

View File

@ -1,2 +1,3 @@
static/img/demo.gif filter=lfs diff=lfs merge=lfs -text
static/img/logo.png filter=lfs diff=lfs merge=lfs -text
*.png filter=lfs diff=lfs merge=lfs -text

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 130 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 142 KiB

After

Width:  |  Height:  |  Size: 131 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 108 KiB

After

Width:  |  Height:  |  Size: 131 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 104 KiB

After

Width:  |  Height:  |  Size: 131 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 89 KiB

After

Width:  |  Height:  |  Size: 130 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 130 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 130 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 184 KiB

After

Width:  |  Height:  |  Size: 131 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 73 KiB

After

Width:  |  Height:  |  Size: 130 B

View File

@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:a58b8ec8dcbee680f4e83bf6bbd04de0cd95cd79c40a1f004a065f8ea9e09fa8
size 47926

View File

@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:d45cf131a4a5d46dc0f4e36d0f74a3668fae14dcdef04d77889e1e2d9e5b29e9
size 13946

View File

@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:9a5f5b32d5328a60d42a62a4908048f427149e3df87497c6b7f6c1357ec0e051
size 297279

View File

@ -0,0 +1,61 @@
---
sidebar_label: Hugging Face Spaces
---
# Hugging Face Spaces
In this guide, you will learn how to deploy your own Tabby instance and use it for development directly from the Huggingface website.
## Your first Tabby Space
In this section, you will learn how to deploy a Tabby Space and use it for yourself or your orgnization.
### Deploy Tabby on Spaces
You can deploy Tabby on Spaces with just a few clicks:
[![Deploy on HF Spaces](https://huggingface.co/datasets/huggingface/badges/raw/main/deploy-to-spaces-lg.svg)](https://huggingface.co/spaces/TabbyML/tabby-template-space?duplicate=true)
You need to define the Owner (your personal account or an organization), a Space name, and the Visibility. To secure the api endpoint, we're configuring the visibility as Private.
![Duplicate Space](./duplicate-space.png)
:::tip
If you want to customize the title, emojis, and colors of your space, go to "Files and Versions" and edit the metadata of your README.md file.
:::
Youll see the Building status and once it becomes Running your space is ready to go. If you dont see the Tabby swagger UI, try refreshing the page.
![Swagger UI](./swagger-ui.png)
### Your Tabby Space URL
Once Tabby is running, you can use the UI with the <u>Direct URL</u> in the **Embed this Space** option (top right).
Youll see a URL like this: https://tabbyml-tabby.hf.space. This URL gives you access to a full-screen, stable Tabby instance, and is the API Endpoint for IDE / Editor Extensions to talk with.
### Connect VSCode Extension to Space backend
1. Install the [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=TabbyML.vscode-tabby).
2. Open the file located at `~/.tabby-client/agent/config.toml`. Uncomment both the `[server]` section and the `[server.requestHeaders]` section.
* Set the endpoint to the Direct URL you found in the previous step, which should look something like `https://UserName-SpaceName.hf.space`.
* As the space is set to **Private**, it is essential to configure the authorization header for accessing the endpoint. You can obtain a token from the [Access Tokens](https://huggingface.co/settings/tokens) page.
<center>
![Agent Config](./agent-config.png)
</center>
3. You'll notice a ✓ icon indicating a successful connection.
![Tabby Connected](./tabby-connected.png)
4. You've complete the setup, now enjoy tabing!
<center>
![Code Completion](./code-completion.png)
</center>
You can also utilize Tabby extensions in other IDEs, such as [JetBrains](https://plugins.jetbrains.com/plugin/22379-tabby).
## Feedback and support
If you have improvement suggestions or need specific support, please join [Tabby Slack community](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA) or reach out on [Tabbys GitHub repository](https://github.com/TabbyML/tabby).

View File

@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:5be9d492ddf6992a634cdca6a303b95c411100881f9d75a3b534d2b6a4b2c8b5
size 332826

View File

@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:b94e50a0d2f12d4ba28fe789c045e25a7c73f8b45c04c9c763b349e1f64de1ba
size 2032