Mishig commited on
Commit
f51765d
·
unverified ·
1 Parent(s): 572bcbe

Improve docs (#1223)

Browse files

* better interlinking

* upload imgs

docs/source/configuration/models/tools.md CHANGED
@@ -2,6 +2,11 @@
2
 
3
  Tool calling instructs the model to generate an output matching a user-defined schema, which may be parsed for invoking external tools. The model simply chooses the tools and their parameters. Currently, only `TGI` and `Cohere` with `Command R+` are supported.
4
 
 
 
 
 
 
5
  ## TGI Configuration
6
 
7
  A custom tokenizer is required for prompting the model for generating tool calls, as well as prompting with the results. The expected format for these tools and the resulting tool calls are hard coded for TGI, so it's likely that only the following configuration will work:
 
2
 
3
  Tool calling instructs the model to generate an output matching a user-defined schema, which may be parsed for invoking external tools. The model simply chooses the tools and their parameters. Currently, only `TGI` and `Cohere` with `Command R+` are supported.
4
 
5
+ <div class="flex justify-center">
6
+ <img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/chat-ui/tools-light.png" height="auto"/>
7
+ <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/chat-ui/tools-dark.png" height="auto"/>
8
+ </div>
9
+
10
  ## TGI Configuration
11
 
12
  A custom tokenizer is required for prompting the model for generating tool calls, as well as prompting with the results. The expected format for these tools and the resulting tool calls are hard coded for TGI, so it's likely that only the following configuration will work:
docs/source/configuration/web-search.md CHANGED
@@ -11,6 +11,11 @@ Chat UI features a powerful Web Search feature. A high level overview of how it
11
  7. Get the corresponding Markdown elements and their parent, up to 8000 characters
12
  8. Supply the information as context to the model
13
 
 
 
 
 
 
14
  ## Providers
15
 
16
  Many providers are supported for the web search, or you can use locally scraped Google results.
 
11
  7. Get the corresponding Markdown elements and their parent, up to 8000 characters
12
  8. Supply the information as context to the model
13
 
14
+ <div class="flex justify-center">
15
+ <img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/chat-ui/websearch-light.png" height="auto"/>
16
+ <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/chat-ui/websearch-dark.png" height="auto"/>
17
+ </div>
18
+
19
  ## Providers
20
 
21
  Many providers are supported for the web search, or you can use locally scraped Google results.
docs/source/index.md CHANGED
@@ -2,13 +2,29 @@
2
 
3
  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](./installation/spaces).
4
 
5
- 🔧 **Tools**: Function calling with custom tools and support for [Zero GPU spaces](https://huggingface.co/spaces/enzostvs/zero-gpu-spaces)
6
 
7
- 🔍 **Web Search**: Automated web search, scraping and RAG for all models
8
 
9
- 🐙 **Multimodal**: Accepts image file uploads on supported providers
10
 
11
- 👤 **OpenID**: Optionally setup OpenID for user authentication
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
 
13
  ## Quickstart
14
 
 
2
 
3
  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](./installation/spaces).
4
 
5
+ 🔧 **[Tools](./configuration/models/tools)**: Function calling with custom tools and support for [Zero GPU spaces](https://huggingface.co/spaces/enzostvs/zero-gpu-spaces)
6
 
7
+ 🔍 **[Web Search](./configuration/web-search)**: Automated web search, scraping and RAG for all models
8
 
9
+ 🐙 **[Multimodal](./configuration/models/multimodal)**: Accepts image file uploads on supported providers
10
 
11
+ 👤 **[OpenID](./configuration/open-id)**: Optionally setup OpenID for user authentication
12
+
13
+ <div class="flex flex-wrap">
14
+
15
+ <div class="flex justify-center">
16
+ Tools
17
+ <img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/chat-ui/tools-light.png" height="auto"/>
18
+ <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/chat-ui/tools-dark.png" height="auto"/>
19
+ </div>
20
+
21
+ <div class="flex justify-center">
22
+ Web Search
23
+ <img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/chat-ui/websearch-light.png" height="auto"/>
24
+ <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/chat-ui/websearch-dark.png" height="auto"/>
25
+ </div>
26
+
27
+ </div>
28
 
29
  ## Quickstart
30