Skip to content

Commit 9cf1d88

Browse files
dbkinderpre-commit-ci[bot]
dbkinder
and
pre-commit-ci[bot]
authored
doc: use markdown table in supported_examples (#707)
* doc: use markdown table in supported_examples replace raw html with markdown table syntax to fix yucky github.io rendering for raw html tables Signed-off-by: David B. Kinder <david.b.kinder@intel.com> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Signed-off-by: David B. Kinder <david.b.kinder@intel.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent a8244c4 commit 9cf1d88

File tree

1 file changed

+27
-180
lines changed

1 file changed

+27
-180
lines changed

‎supported_examples.md‎

Lines changed: 27 additions & 180 deletions
Original file line numberDiff line numberDiff line change
@@ -1,220 +1,67 @@
1-
<div align="center">
2-
31
# Supported Examples
42

5-
<div align="left">
6-
73
This document introduces the supported examples of GenAIExamples. The supported Vector Database, LLM models, serving frameworks and hardwares are listed as below.
84

95
## ChatQnA
106

117
[ChatQnA](./ChatQnA/README.md) is an example of chatbot for question and answering through retrieval augmented generation (RAG).
128

13-
<table>
14-
<tbody>
15-
<tr>
16-
<td>Framework</td>
17-
<td>LLM</td>
18-
<td>Embedding</td>
19-
<td>Vector Database</td>
20-
<td>Serving</td>
21-
<td>HW</td>
22-
<td>Description</td>
23-
</tr>
24-
<tr>
25-
<td><a href="https://www.langchain.com">LangChain</a>/<a href="https://www.llamaindex.ai">LlamaIndex</a></td>
26-
<td><a href="https://huggingface.co/Intel/neural-chat-7b-v3-3">NeuralChat-7B</a></td>
27-
<td><a href="https://huggingface.co/BAAI/bge-base-en">BGE-Base</a></td>
28-
<td><a href="https://redis.io/">Redis</a></td>
29-
<td><a href="https://github.com/huggingface/text-generation-inference">TGI</a> <a href="https://github.com/huggingface/text-embeddings-inference">TEI</a></td>
30-
<td>Xeon/Gaudi2/GPU</td>
31-
<td>Chatbot</td>
32-
</tr>
33-
<tr>
34-
<td><a href="https://www.langchain.com">LangChain</a>/<a href="https://www.llamaindex.ai">LlamaIndex</a></td>
35-
<td><a href="https://huggingface.co/Intel/neural-chat-7b-v3-3">NeuralChat-7B</a></td>
36-
<td><a href="https://huggingface.co/BAAI/bge-base-en">BGE-Base</a></td>
37-
<td><a href="https://www.trychroma.com/">Chroma</a></td>
38-
<td><a href="https://github.com/huggingface/text-generation-inference">TGI</a> <a href="https://github.com/huggingface/text-embeddings-inference">TEI</td>
39-
<td>Xeon/Gaudi2</td>
40-
<td>Chatbot</td>
41-
</tr>
42-
<tr>
43-
<td><a href="https://www.langchain.com">LangChain</a>/<a href="https://www.llamaindex.ai">LlamaIndex</a></td>
44-
<td><a href="https://huggingface.co/mistralai/Mistral-7B-v0.1">Mistral-7B</a></td>
45-
<td><a href="https://huggingface.co/BAAI/bge-base-en">BGE-Base</a></td>
46-
<td><a href="https://redis.io/">Redis</a></td>
47-
<td><a href="https://github.com/huggingface/text-generation-inference">TGI</a> <a href="https://github.com/huggingface/text-embeddings-inference">TEI</td>
48-
<td>Xeon/Gaudi2</td>
49-
<td>Chatbot</td>
50-
</tr>
51-
<tr>
52-
<td><a href="https://www.langchain.com">LangChain</a>/<a href="https://www.llamaindex.ai">LlamaIndex</a></td>
53-
<td><a href="https://huggingface.co/mistralai/Mistral-7B-v0.1">Mistral-7B</a></td>
54-
<td><a href="https://huggingface.co/BAAI/bge-base-en">BGE-Base</a></td>
55-
<td><a href="https://qdrant.tech/">Qdrant</a></td>
56-
<td><a href="https://github.com/huggingface/text-generation-inference">TGI</a> <a href="https://github.com/huggingface/text-embeddings-inference">TEI</td>
57-
<td>Xeon/Gaudi2</td>
58-
<td>Chatbot</td>
59-
</tr>
60-
<tr>
61-
<td><a href="https://www.langchain.com">LangChain</a>/<a href="https://www.llamaindex.ai">LlamaIndex</a></td>
62-
<td><a href="https://huggingface.co/Qwen/Qwen2-7B">Qwen2-7B</a></td>
63-
<td><a href="https://huggingface.co/BAAI/bge-base-en">BGE-Base</a></td>
64-
<td><a href="https://redis.io/">Redis</a></td>
65-
<td><a href=<a href="https://github.com/huggingface/text-embeddings-inference">TEI</td>
66-
<td>Xeon/Gaudi2</td>
67-
<td>Chatbot</td>
68-
</tr>
69-
</tbody>
70-
</table>
9+
| Framework | LLM | Embedding | Vector Database | Serving | HW | Description |
10+
| ------------------------------------------------------------------------------ | ----------------------------------------------------------------- | --------------------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- | --------------- | ----------- |
11+
| [LangChain](https://www.langchain.com)/[LlamaIndex](https://www.llamaindex.ai) | [NeuralChat-7B](https://huggingface.co/Intel/neural-chat-7b-v3-3) | [BGE-Base](https://huggingface.co/BAAI/bge-base-en) | [Redis](https://redis.io/) | [TGI](https://github.com/huggingface/text-generation-inference) [TEI](https://github.com/huggingface/text-embeddings-inference) | Xeon/Gaudi2/GPU | Chatbot |
12+
| [LangChain](https://www.langchain.com)/[LlamaIndex](https://www.llamaindex.ai) | [NeuralChat-7B](https://huggingface.co/Intel/neural-chat-7b-v3-3) | [BGE-Base](https://huggingface.co/BAAI/bge-base-en) | [Chroma](https://www.trychroma.com/) | [TGI](https://github.com/huggingface/text-generation-inference) [TEI](https://github.com/huggingface/text-embeddings-inference) | Xeon/Gaudi2 | Chatbot |
13+
| [LangChain](https://www.langchain.com)/[LlamaIndex](https://www.llamaindex.ai) | [Mistral-7B](https://huggingface.co/mistralai/Mistral-7B-v0.1) | [BGE-Base](https://huggingface.co/BAAI/bge-base-en) | [Redis](https://redis.io/) | [TGI](https://github.com/huggingface/text-generation-inference) [TEI](https://github.com/huggingface/text-embeddings-inference) | Xeon/Gaudi2 | Chatbot |
14+
| [LangChain](https://www.langchain.com)/[LlamaIndex](https://www.llamaindex.ai) | [Mistral-7B](https://huggingface.co/mistralai/Mistral-7B-v0.1) | [BGE-Base](https://huggingface.co/BAAI/bge-base-en) | [Qdrant](https://qdrant.tech/) | [TGI](https://github.com/huggingface/text-generation-inference) [TEI](https://github.com/huggingface/text-embeddings-inference) | Xeon/Gaudi2 | Chatbot |
15+
| [LangChain](https://www.langchain.com)/[LlamaIndex](https://www.llamaindex.ai) | [Qwen2-7B](https://huggingface.co/Qwen/Qwen2-7B) | [BGE-Base](https://huggingface.co/BAAI/bge-base-en) | [Redis](https://redis.io/) | [TEI](https://github.com/huggingface/text-embeddings-inference) | Xeon/Gaudi2 | Chatbot |
7116

7217
### CodeGen
7318

7419
[CodeGen](./CodeGen/README.md) is an example of copilot designed for code generation in Visual Studio Code.
7520

76-
<table>
77-
<tbody>
78-
<tr>
79-
<td>Framework</td>
80-
<td>LLM</td>
81-
<td>Serving</td>
82-
<td>HW</td>
83-
<td>Description</td>
84-
</tr>
85-
<tr>
86-
<td><a href="https://www.langchain.com">LangChain</a>/<a href="https://www.llamaindex.ai">LlamaIndex</a></td>
87-
<td><a href="https://huggingface.co/meta-llama/CodeLlama-7b-hf">meta-llama/CodeLlama-7b-hf</a></td>
88-
<td><a href="https://github.com/huggingface/text-generation-inference">TGI</a></td>
89-
<td>Xeon/Gaudi2</td>
90-
<td>Copilot</td>
91-
</tr>
92-
</tbody>
93-
</table>
21+
| Framework | LLM | Serving | HW | Description |
22+
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------- | ----------- |
23+
| [LangChain](https://www.langchain.com)/[LlamaIndex](https://www.llamaindex.ai) | [meta-llama/CodeLlama-7b-hf](https://huggingface.co/meta-llama/CodeLlama-7b-hf) | [TGI](https://github.com/huggingface/text-generation-inference) | Xeon/Gaudi2 | Copilot |
9424

9525
### CodeTrans
9626

9727
[CodeTrans](./CodeTrans/README.md) is an example of chatbot for converting code written in one programming language to another programming language while maintaining the same functionality.
9828

99-
<table>
100-
<tbody>
101-
<tr>
102-
<td>Framework</td>
103-
<td>LLM</td>
104-
<td>Serving</td>
105-
<td>HW</td>
106-
<td>Description</td>
107-
</tr>
108-
<tr>
109-
<td><a href="https://www.langchain.com">LangChain</a>/<a href="https://www.llamaindex.ai">LlamaIndex</a></td>
110-
<td><a href="https://huggingface.co/HuggingFaceH4/mistral-7b-grok">HuggingFaceH4/mistral-7b-grok</a></td>
111-
<td><a href="https://github.com/huggingface/text-generation-inference">TGI</a></td>
112-
<td>Xeon/Gaudi2</td>
113-
<td>Code Translation</td>
114-
</tr>
115-
</tbody>
116-
</table>
29+
| Framework | LLM | Serving | HW | Description |
30+
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------- | ---------------- |
31+
| [LangChain](https://www.langchain.com)/[LlamaIndex](https://www.llamaindex.ai) | [HuggingFaceH4/mistral-7b-grok](https://huggingface.co/HuggingFaceH4/mistral-7b-grok) | [TGI](https://github.com/huggingface/text-generation-inference) | Xeon/Gaudi2 | Code Translation |
11732

11833
### DocSum
11934

12035
[DocSum](./DocSum/README.md) is an example of chatbot for summarizing the content of documents or reports.
12136

122-
<table>
123-
<tbody>
124-
<tr>
125-
<td>Framework</td>
126-
<td>LLM</td>
127-
<td>Serving</td>
128-
<td>HW</td>
129-
<td>Description</td>
130-
</tr>
131-
<tr>
132-
<td><a href="https://www.langchain.com">LangChain</a>/<a href="https://www.llamaindex.ai">LlamaIndex</a></td>
133-
<td><a href="https://huggingface.co/Intel/neural-chat-7b-v3-3">NeuralChat-7B</a></td>
134-
<td><a href="https://github.com/huggingface/text-generation-inference">TGI</a></td>
135-
<td>Xeon/Gaudi2</td>
136-
<td>Chatbot</td>
137-
</tr>
138-
<tr>
139-
<td><a href="https://www.langchain.com">LangChain</a>/<a href="https://www.llamaindex.ai">LlamaIndex</a></td>
140-
<td><a href="https://huggingface.co/mistralai/Mistral-7B-v0.1">Mistral-7B</a></td>
141-
<td><a href="https://github.com/huggingface/text-generation-inference">TGI</a></td>
142-
<td>Xeon/Gaudi2</td>
143-
<td>Chatbot</td>
144-
</tr>
145-
</tbody>
146-
</table>
37+
| Framework | LLM | Serving | HW | Description |
38+
| ------------------------------------------------------------------------------ | ----------------------------------------------------------------- | --------------------------------------------------------------- | ----------- | ----------- |
39+
| [LangChain](https://www.langchain.com)/[LlamaIndex](https://www.llamaindex.ai) | [NeuralChat-7B](https://huggingface.co/Intel/neural-chat-7b-v3-3) | [TGI](https://github.com/huggingface/text-generation-inference) | Xeon/Gaudi2 | Chatbot |
40+
| [LangChain](https://www.langchain.com)/[LlamaIndex](https://www.llamaindex.ai) | [Mistral-7B](https://huggingface.co/mistralai/Mistral-7B-v0.1) | [TGI](https://github.com/huggingface/text-generation-inference) | Xeon/Gaudi2 | Chatbot |
14741

14842
### Language Translation
14943

15044
[Language Translation](./Translation/README.md) is an example of chatbot for converting a source-language text to an equivalent target-language text.
15145

152-
<table>
153-
<tbody>
154-
<tr>
155-
<td>Framework</td>
156-
<td>LLM</td>
157-
<td>Serving</td>
158-
<td>HW</td>
159-
<td>Description</td>
160-
</tr>
161-
<tr>
162-
<td><a href="https://www.langchain.com">LangChain</a>/<a href="https://www.llamaindex.ai">LlamaIndex</a></td>
163-
<td><a href="https://huggingface.co/haoranxu/ALMA-13B">haoranxu/ALMA-13B</a></td>
164-
<td><a href="https://github.com/huggingface/text-generation-inference">TGI</a></td>
165-
<td>Xeon/Gaudi2</td>
166-
<td>Language Translation</td>
167-
</tr>
168-
</tbody>
169-
</table>
46+
| Framework | LLM | Serving | HW | Description |
47+
| ------------------------------------------------------------------------------ | ------------------------------------------------------------- | --------------------------------------------------------------- | ----------- | -------------------- |
48+
| [LangChain](https://www.langchain.com)/[LlamaIndex](https://www.llamaindex.ai) | [haoranxu/ALMA-13B](https://huggingface.co/haoranxu/ALMA-13B) | [TGI](https://github.com/huggingface/text-generation-inference) | Xeon/Gaudi2 | Language Translation |
17049

17150
### SearchQnA
17251

17352
[SearchQnA](./SearchQnA/README.md) is an example of chatbot for using search engine to enhance QA quality.
17453

175-
<table>
176-
<tbody>
177-
<tr>
178-
<td>Framework</td>
179-
<td>LLM</td>
180-
<td>Serving</td>
181-
<td>HW</td>
182-
<td>Description</td>
183-
</tr>
184-
<tr>
185-
<td><a href="https://www.langchain.com">LangChain</a>/<a href="https://www.llamaindex.ai">LlamaIndex</a></td>
186-
<td><a href="https://huggingface.co/Intel/neural-chat-7b-v3-3">NeuralChat-7B</a></td>
187-
<td><a href="https://github.com/huggingface/text-generation-inference">TGI</a></td>
188-
<td>Xeon/Gaudi2</td>
189-
<td>Chatbot</td>
190-
</tr>
191-
<tr>
192-
<td><a href="https://www.langchain.com">LangChain</a>/<a href="https://www.llamaindex.ai">LlamaIndex</a></td>
193-
<td><a href="https://huggingface.co/mistralai/Mistral-7B-v0.1">Mistral-7B</a></td>
194-
<td><a href="https://github.com/huggingface/text-generation-inference">TGI</a></td>
195-
<td>Xeon/Gaudi2</td>
196-
<td>Chatbot</td>
197-
</tr>
198-
</tbody>
199-
</table>
54+
| Framework | LLM | Serving | HW | Description |
55+
| ------------------------------------------------------------------------------ | ----------------------------------------------------------------- | --------------------------------------------------------------- | ----------- | ----------- |
56+
| [LangChain](https://www.langchain.com)/[LlamaIndex](https://www.llamaindex.ai) | [NeuralChat-7B](https://huggingface.co/Intel/neural-chat-7b-v3-3) | [TGI](https://github.com/huggingface/text-generation-inference) | Xeon/Gaudi2 | Chatbot |
57+
| [LangChain](https://www.langchain.com)/[LlamaIndex](https://www.llamaindex.ai) | [Mistral-7B](https://huggingface.co/mistralai/Mistral-7B-v0.1) | [TGI](https://github.com/huggingface/text-generation-inference) | Xeon/Gaudi2 | Chatbot |
20058

20159
### VisualQnA
20260

20361
[VisualQnA](./VisualQnA/README.md) is an example of chatbot for question and answering based on the images.
20462

205-
<table>
206-
<tbody>
207-
<tr>
208-
<td>LLM</td>
209-
<td>HW</td>
210-
<td>Description</td>
211-
</tr>
212-
<tr>
213-
<td><a href="https://huggingface.co/llava-hf/llava-1.5-7b-hf">LLaVA-1.5-7B</a></td>
214-
<td>Gaudi2</td>
215-
<td>Chatbot</td>
216-
</tr>
217-
</tbody>
218-
</table>
63+
| LLM | HW | Description |
64+
| --------------------------------------------------------------- | ------ | ----------- |
65+
| [LLaVA-1.5-7B](https://huggingface.co/llava-hf/llava-1.5-7b-hf) | Gaudi2 | Chatbot |
21966

22067
> **_NOTE:_** The `Language Translation`, `SearchQnA`, `VisualQnA` and other use cases not listing here are in active development. The code structure of these use cases are subject to change.

0 commit comments

Comments
 (0)