Update README.md
Browse files
README.md
CHANGED
@@ -1,41 +1,9 @@
|
|
1 |
-
|
2 |
-
|
3 |
-
|
4 |
-
|
5 |
-
|
6 |
-
|
7 |
-
|
8 |
-
|
9 |
-
|
10 |
-
- `requirements.txt`: Required Python packages to run the code in this repository.
|
11 |
-
|
12 |
-
## About RAG (Retrieval Augmented Generation)
|
13 |
-
|
14 |
-
RAG is a novel approach combining Large Language Models (LLMs) capabilities with external knowledge bases to enhance the quality and freshness of generated responses. It addresses the challenge of outdated information by retrieving contextually relevant knowledge from external sources and incorporating it into LLM-generated content.
|
15 |
-
|
16 |
-
## About Gradio
|
17 |
-
|
18 |
-
[Gradio](https://www.gradio.app) is a Python library that helps you quickly create UIs for your machine learning models. It allows you to quickly deploy models and make them accessible through a user-friendly interface without extensive frontend development.
|
19 |
-
|
20 |
-
A Gradio app is launched when `gradio_chatbot.py` code is run. It contains modifiable elements such as the Embedding model, Generation model, editable system prompt, and tunable parameters of the chosen LLM.
|
21 |
-
|
22 |
-
### Steps
|
23 |
-
|
24 |
-
To use the code in this repository, follow these steps:
|
25 |
-
|
26 |
-
1. Clone the repository to your local machine.
|
27 |
-
2. Navigate to the repository directory using the command line.
|
28 |
-
3. Install the required packages using the following command:
|
29 |
-
|
30 |
-
```bash
|
31 |
-
pip install -r requirements.txt
|
32 |
-
```
|
33 |
-
|
34 |
-
4. Run the chatbot application using the command:
|
35 |
-
|
36 |
-
```bash
|
37 |
-
python src/gradio_chatbot.py
|
38 |
-
```
|
39 |
-
|
40 |
-
5. Once the Gradio app is up, upload a document (pdf or csv), choose the models (embedding and generation), adjust the tunable parameters, fiddle with the system prompt, and ask anything you need!
|
41 |
-
|
|
|
1 |
+
---
|
2 |
+
title: RAG
|
3 |
+
sdk: gradio
|
4 |
+
emoji: ⚡
|
5 |
+
colorFrom: gray
|
6 |
+
colorTo: pink
|
7 |
+
app_file: rag/src/gradio_chatbot.py
|
8 |
+
pinned: false
|
9 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|