From 020625277c4b182df91ee0f41ba00959b92fdb8f Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Tue, 12 Sep 2023 10:47:31 +0800 Subject: [PATCH 1/8] Create spaces-sdks-docker-tabby.md --- docs/hub/spaces-sdks-docker-tabby.md | 60 ++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 docs/hub/spaces-sdks-docker-tabby.md diff --git a/docs/hub/spaces-sdks-docker-tabby.md b/docs/hub/spaces-sdks-docker-tabby.md new file mode 100644 index 000000000..67540eaac --- /dev/null +++ b/docs/hub/spaces-sdks-docker-tabby.md @@ -0,0 +1,60 @@ +# Tabby on Spaces + +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. + +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. + +![image](https://github.com/huggingface/hub-docs/assets/388154/b00eb7ea-7de6-4832-b3ff-512859bfa92e) + + +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. + +![image](https://github.com/huggingface/hub-docs/assets/388154/f2320e55-7aad-42ed-8b1c-aec4e42e05f0) + +### 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. + +
+ +![image](https://github.com/huggingface/hub-docs/assets/388154/1f24a977-6d47-4819-923e-b2c17b747fb0) + +
+ +3. You'll notice a ✓ icon indicating a successful connection. +![Tabby Connected](https://github.com/huggingface/hub-docs/assets/388154/8657bce4-6e08-4eab-bb26-a48974d5fd8d) + +4. You've complete the setup, now enjoy tabing! + +
+ +![image](https://github.com/huggingface/hub-docs/assets/388154/c186aafc-36bf-415e-bfe5-946de2686d54) + +
+ +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). From 4c85fba0a33e92c8d8b83aa559decb6c421160ca Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Tue, 12 Sep 2023 11:02:57 +0800 Subject: [PATCH 2/8] Update spaces-sdks-docker-tabby.md --- docs/hub/spaces-sdks-docker-tabby.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hub/spaces-sdks-docker-tabby.md b/docs/hub/spaces-sdks-docker-tabby.md index 67540eaac..2bf1352f7 100644 --- a/docs/hub/spaces-sdks-docker-tabby.md +++ b/docs/hub/spaces-sdks-docker-tabby.md @@ -1,6 +1,6 @@ # Tabby on Spaces -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. +[Tabby](https://tabby.tabbyml.com) 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. In this guide, you will learn how to deploy your own Tabby instance and use it for development directly from the Huggingface website. From 7b795729952f002df1bd17c3d2f84ca58f4b9539 Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Tue, 12 Sep 2023 17:10:15 +0800 Subject: [PATCH 3/8] Update _toctree.yml --- docs/hub/_toctree.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/hub/_toctree.yml b/docs/hub/_toctree.yml index 2a1dff983..9f1196ca7 100644 --- a/docs/hub/_toctree.yml +++ b/docs/hub/_toctree.yml @@ -171,6 +171,8 @@ title: Panel on Spaces - local: spaces-sdks-docker-chatui title: ChatUI on Spaces + - local: spaces-sdks-docker-tabby + title: Tabby on Spaces - local: spaces-embed title: Embed your Space - local: spaces-run-with-docker From 5f9417730628bf5ac1c4df58ddcd4da97f0f03ea Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Tue, 12 Sep 2023 17:10:57 +0800 Subject: [PATCH 4/8] Apply suggestions from code review Co-authored-by: Mishig --- docs/hub/spaces-sdks-docker-tabby.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/hub/spaces-sdks-docker-tabby.md b/docs/hub/spaces-sdks-docker-tabby.md index 2bf1352f7..f6a8320a3 100644 --- a/docs/hub/spaces-sdks-docker-tabby.md +++ b/docs/hub/spaces-sdks-docker-tabby.md @@ -19,7 +19,9 @@ You need to define the Owner (your personal account or an organization), a Space ![image](https://github.com/huggingface/hub-docs/assets/388154/b00eb7ea-7de6-4832-b3ff-512859bfa92e) + 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. @@ -27,10 +29,12 @@ You’ll see the Building status and once it becomes Running your space is ready ![image](https://github.com/huggingface/hub-docs/assets/388154/f2320e55-7aad-42ed-8b1c-aec4e42e05f0) ### 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`. @@ -57,4 +61,5 @@ You can also utilize Tabby extensions in other IDEs, such as [JetBrains](https:/ ## 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). From 04e36ac52e002eb285d71b0e955c95c179ff932e Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Tue, 19 Sep 2023 22:42:57 +0800 Subject: [PATCH 5/8] Apply suggestions from code review Co-authored-by: Omar Sanseviero --- docs/hub/spaces-sdks-docker-tabby.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/hub/spaces-sdks-docker-tabby.md b/docs/hub/spaces-sdks-docker-tabby.md index f6a8320a3..9fa29415f 100644 --- a/docs/hub/spaces-sdks-docker-tabby.md +++ b/docs/hub/spaces-sdks-docker-tabby.md @@ -2,7 +2,7 @@ [Tabby](https://tabby.tabbyml.com) 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. -In this guide, you will learn how to deploy your own Tabby instance and use it for development directly from the Huggingface website. +In this guide, you will learn how to deploy your own Tabby instance and use it for development directly from the Hugging Face website. ## Your first Tabby Space @@ -18,16 +18,18 @@ You need to define the Owner (your personal account or an organization), a Space ![image](https://github.com/huggingface/hub-docs/assets/388154/b00eb7ea-7de6-4832-b3ff-512859bfa92e) + + +You’ll see the *Building status*. Once it becomes *Running*, your Space is ready to go. If you don’t see the Tabby Swagger UI, try refreshing the page. + +![image](https://github.com/huggingface/hub-docs/assets/388154/f2320e55-7aad-42ed-8b1c-aec4e42e05f0) + 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. - -![image](https://github.com/huggingface/hub-docs/assets/388154/f2320e55-7aad-42ed-8b1c-aec4e42e05f0) - ### 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). @@ -38,7 +40,7 @@ You’ll see a URL like this: https://tabbyml-tabby.hf.space. This URL gives you 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. + * 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.
From fec7ad71468d8db0ef9498f3d7100d0cfb4cf05c Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Tue, 19 Sep 2023 23:05:59 +0800 Subject: [PATCH 6/8] Update spaces-sdks-docker-tabby.md --- docs/hub/spaces-sdks-docker-tabby.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/hub/spaces-sdks-docker-tabby.md b/docs/hub/spaces-sdks-docker-tabby.md index 9fa29415f..7871429bd 100644 --- a/docs/hub/spaces-sdks-docker-tabby.md +++ b/docs/hub/spaces-sdks-docker-tabby.md @@ -32,8 +32,8 @@ If you want to customize the title, emojis, and colors of your space, go to "Fil ### 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. +Once Tabby is up and running, for a space link such as https://huggingface.com/spaces/TabbyML/tabby, the direct URL will be https://tabbyml-tabby.hf.space. +This URL provides access to a stable Tabby instance in full-screen mode and serves as the API endpoint for IDE/Editor Extensions to talk with. ### Connect VSCode Extension to Space backend From 8d756d926c3ef02e1dca09949e574eabd6369f06 Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Wed, 20 Sep 2023 00:13:18 +0800 Subject: [PATCH 7/8] Update spaces-sdks-docker-tabby.md --- docs/hub/spaces-sdks-docker-tabby.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/hub/spaces-sdks-docker-tabby.md b/docs/hub/spaces-sdks-docker-tabby.md index 7871429bd..60b53603e 100644 --- a/docs/hub/spaces-sdks-docker-tabby.md +++ b/docs/hub/spaces-sdks-docker-tabby.md @@ -16,13 +16,13 @@ You can deploy Tabby on Spaces with just a few clicks: 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. -![image](https://github.com/huggingface/hub-docs/assets/388154/b00eb7ea-7de6-4832-b3ff-512859bfa92e) +![Duplicate Space](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/tabby/duplicate-space.png) You’ll see the *Building status*. Once it becomes *Running*, your Space is ready to go. If you don’t see the Tabby Swagger UI, try refreshing the page. -![image](https://github.com/huggingface/hub-docs/assets/388154/f2320e55-7aad-42ed-8b1c-aec4e42e05f0) +![Swagger UI](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/tabby/swagger-ui.png) @@ -44,18 +44,18 @@ This URL provides access to a stable Tabby instance in full-screen mode and serv
-![image](https://github.com/huggingface/hub-docs/assets/388154/1f24a977-6d47-4819-923e-b2c17b747fb0) +![Agent Config](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/tabby/agent-config.png)
3. You'll notice a ✓ icon indicating a successful connection. -![Tabby Connected](https://github.com/huggingface/hub-docs/assets/388154/8657bce4-6e08-4eab-bb26-a48974d5fd8d) +![Tabby Connected](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/tabby/tabby-connected.png) 4. You've complete the setup, now enjoy tabing!
-![image](https://github.com/huggingface/hub-docs/assets/388154/c186aafc-36bf-415e-bfe5-946de2686d54) +![Code Completion](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/tabby/code-completion.png)
From 5f4ff79558ec8d32f95f90282f5f928529c9efa9 Mon Sep 17 00:00:00 2001 From: Merve Noyan Date: Wed, 22 Feb 2023 12:57:53 +0100 Subject: [PATCH 8/8] minor nit --- docs/hub/spaces-sdks-docker-examples.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hub/spaces-sdks-docker-examples.md b/docs/hub/spaces-sdks-docker-examples.md index 8f6ea75ae..d09fb1b67 100644 --- a/docs/hub/spaces-sdks-docker-examples.md +++ b/docs/hub/spaces-sdks-docker-examples.md @@ -9,6 +9,6 @@ We gathered some example demos in the [Docker Templates](https://huggingface.co/ * Shiny app written in Python https://huggingface.co/spaces/elonmuskceo/shiny-orbit-simulation * Genie.jl app in Julia https://huggingface.co/spaces/nooji/GenieOnHuggingFaceSpaces * Argilla app for data labelling and curation: https://huggingface.co/spaces/argilla/live-demo and [write-up about hosting Argilla on Spaces](./spaces-sdks-docker-argilla) by [@dvilasuero](https://huggingface.co/dvilasuero) 🎉 -* JupyterLab: https://huggingface.co/spaces/camenduru/jupyter +* JupyterLab and VSCode: https://huggingface.co/spaces/DockerTemplates/docker-examples * Zeno app for interactive model evaluation: https://huggingface.co/spaces/zeno-ml/diffusiondb and [instructions for setup](https://zenoml.com/docs/deployment#hugging-face-spaces) * Gradio App: https://huggingface.co/spaces/sayakpaul/demo-docker-gradio