Skip to content

Commit 309f226

Browse files
author
Mishig
authored
[docs] docs are not live yet (#1181)
1 parent 9227230 commit 309f226

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,23 @@ load_balancing_strategy: random
1616

1717
![Chat UI repository thumbnail](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/chatui-websearch.png)
1818

19-
Open source chat interface with support for tools, web search, multimodal and many API providers. The app uses MongoDB and SvelteKit behind the scenes. Try the live version of the app called [HuggingChat on hf.co/chat](https://huggingface.co/chat) or [setup your own instance](https://huggingface.co/docs/chat-ui/installation/spaces).
19+
A chat interface using open source models, eg OpenAssistant or Llama. It is a SvelteKit app and it powers the [HuggingChat app on hf.co/chat](https://huggingface.co/chat).
2020

21-
🔧 **Tools**: Function calling with custom tools and support for [Zero GPU spaces](https://huggingface.co/spaces/enzostvs/zero-gpu-spaces)
21+
0. [No Setup Deploy](#no-setup-deploy)
22+
1. [Setup](#setup)
23+
2. [Launch](#launch)
24+
3. [Web Search](#web-search)
25+
4. [Text Embedding Models](#text-embedding-models)
26+
5. [Extra parameters](#extra-parameters)
27+
6. [Common issues](#common-issues)
28+
7. [Deploying to a HF Space](#deploying-to-a-hf-space)
29+
8. [Building](#building)
2230

23-
🔍 **Web Search**: Automated web search, scraping and RAG for all models
31+
## No Setup Deploy
2432

25-
🐙 **Multimodal**: Accepts image file uploads on supported providers
33+
If you don't want to configure, setup, and launch your own Chat UI yourself, you can use this option as a fast deploy alternative.
2634

27-
👤 **OpenID**: Optionally setup OpenID for user authentication
35+
You can deploy your own customized Chat UI instance with any supported [LLM](https://huggingface.co/models?pipeline_tag=text-generation&sort=trending) of your choice on [Hugging Face Spaces](https://huggingface.co/spaces). To do so, use the chat-ui template [available here](https://huggingface.co/new-space?template=huggingchat/chat-ui-template).
2836

2937
Set `HF_TOKEN` in [Space secrets](https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables) to deploy a model with gated access or a model in a private repository. It's also compatible with [Inference for PROs](https://huggingface.co/blog/inference-pro) curated list of powerful models with higher rate limits. Make sure to create your personal token first in your [User Access Tokens settings](https://huggingface.co/settings/tokens).
3038

0 commit comments

Comments
 (0)