diff --git a/website/.gitattributes b/website/.gitattributes index db2511e..e169d29 100644 --- a/website/.gitattributes +++ b/website/.gitattributes @@ -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 diff --git a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/building.png b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/building.png index 62daa77..64fdccc 100644 Binary files a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/building.png and b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/building.png differ diff --git a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/curl.png b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/curl.png index af8d094..d3a9b09 100644 Binary files a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/curl.png and b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/curl.png differ diff --git a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/docker-space.png b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/docker-space.png index 1bb67e1..aaa9a97 100644 Binary files a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/docker-space.png and b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/docker-space.png differ diff --git a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/edit-dockerfile.png b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/edit-dockerfile.png index 0580040..e6761a5 100644 Binary files a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/edit-dockerfile.png and b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/edit-dockerfile.png differ diff --git a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/edit-readme.png b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/edit-readme.png index 9611f9a..b7e75ec 100644 Binary files a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/edit-readme.png and b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/edit-readme.png differ diff --git a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/empty-readme.png b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/empty-readme.png index bf76b85..761dc58 100644 Binary files a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/empty-readme.png and b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/empty-readme.png differ diff --git a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/empty-space.png b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/empty-space.png index cbebcc6..850a9a8 100644 Binary files a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/empty-space.png and b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/empty-space.png differ diff --git a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/new-space.png b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/new-space.png index 384c389..607dfaf 100644 Binary files a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/new-space.png and b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/new-space.png differ diff --git a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/tabby-swagger.png b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/tabby-swagger.png index 7a247d6..2c23dcd 100644 Binary files a/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/tabby-swagger.png and b/website/blog/2023-09-05-deploy-tabby-to-huggingface-space/tabby-swagger.png differ diff --git a/website/docs/installation/hugging-face/agent-config.png b/website/docs/installation/hugging-face/agent-config.png new file mode 100644 index 0000000..15eca34 --- /dev/null +++ b/website/docs/installation/hugging-face/agent-config.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a58b8ec8dcbee680f4e83bf6bbd04de0cd95cd79c40a1f004a065f8ea9e09fa8 +size 47926 diff --git a/website/docs/installation/hugging-face/code-completion.png b/website/docs/installation/hugging-face/code-completion.png new file mode 100644 index 0000000..f406033 --- /dev/null +++ b/website/docs/installation/hugging-face/code-completion.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d45cf131a4a5d46dc0f4e36d0f74a3668fae14dcdef04d77889e1e2d9e5b29e9 +size 13946 diff --git a/website/docs/installation/hugging-face/duplicate-space.png b/website/docs/installation/hugging-face/duplicate-space.png new file mode 100644 index 0000000..d53fdd9 --- /dev/null +++ b/website/docs/installation/hugging-face/duplicate-space.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9a5f5b32d5328a60d42a62a4908048f427149e3df87497c6b7f6c1357ec0e051 +size 297279 diff --git a/website/docs/installation/hugging-face/index.md b/website/docs/installation/hugging-face/index.md new file mode 100644 index 0000000..435a2cb --- /dev/null +++ b/website/docs/installation/hugging-face/index.md @@ -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. +::: + +You’ll see the Building status and once it becomes Running your space is ready to go. If you don’t 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 Direct URL in the **Embed this Space** option (top right). +You’ll 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. + +
+ +![Agent Config](./agent-config.png) + +
+ +3. You'll notice a ✓ icon indicating a successful connection. +![Tabby Connected](./tabby-connected.png) + +4. You've complete the setup, now enjoy tabing! + +
+ +![Code Completion](./code-completion.png) + +
+ +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 [Tabby’s GitHub repository](https://github.com/TabbyML/tabby). diff --git a/website/docs/installation/hugging-face/swagger-ui.png b/website/docs/installation/hugging-face/swagger-ui.png new file mode 100644 index 0000000..afc8bbd --- /dev/null +++ b/website/docs/installation/hugging-face/swagger-ui.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5be9d492ddf6992a634cdca6a303b95c411100881f9d75a3b534d2b6a4b2c8b5 +size 332826 diff --git a/website/docs/installation/hugging-face/tabby-connected.png b/website/docs/installation/hugging-face/tabby-connected.png new file mode 100644 index 0000000..ee8a305 --- /dev/null +++ b/website/docs/installation/hugging-face/tabby-connected.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b94e50a0d2f12d4ba28fe789c045e25a7c73f8b45c04c9c763b349e1f64de1ba +size 2032