Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
@@ -10,5 +10,59 @@ pinned: false
|
|
10 |
license: mit
|
11 |
short_description: Chat with your docs very Easy
|
12 |
---
|
|
|
13 |
|
14 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
10 |
license: mit
|
11 |
short_description: Chat with your docs very Easy
|
12 |
---
|
13 |
+
# Easy RAG π€
|
14 |
|
15 |
+
Easy RAG is a powerful and user-friendly Retrieval Augmented Generation (RAG) system that allows users to upload their own documents and query them using state-of-the-art language models.
|
16 |
+
|
17 |
+
## Features
|
18 |
+
|
19 |
+
- π Support for multiple document formats (PDF, TXT, DOCX)
|
20 |
+
- π Upload up to 5 documents (max 10MB each)
|
21 |
+
- π Advanced document processing and chunking
|
22 |
+
- π‘ Intelligent question answering using Llama-2
|
23 |
+
- π Multilingual support
|
24 |
+
- π GPU-accelerated inference
|
25 |
+
- π Source tracking and citation
|
26 |
+
|
27 |
+
## Technical Stack
|
28 |
+
|
29 |
+
- **Language Model**: Meta-llama/Llama-2-7b-chat-hf
|
30 |
+
- **Embeddings**: intfloat/multilingual-e5-large
|
31 |
+
- **Vector Store**: FAISS
|
32 |
+
- **UI Framework**: Gradio
|
33 |
+
- **Document Processing**: LangChain
|
34 |
+
|
35 |
+
## Installation
|
36 |
+
|
37 |
+
1. Clone the repository
|
38 |
+
2. Install dependencies:
|
39 |
+
```bash
|
40 |
+
pip install -r requirements.txt
|
41 |
+
```
|
42 |
+
3. Set up your HuggingFace token as an environment variable:
|
43 |
+
```bash
|
44 |
+
export HUGGINGFACE_TOKEN=your_token_here
|
45 |
+
```
|
46 |
+
4. Run the application:
|
47 |
+
```bash
|
48 |
+
python app.py
|
49 |
+
```
|
50 |
+
|
51 |
+
## Usage
|
52 |
+
|
53 |
+
1. Upload your documents using the file upload interface
|
54 |
+
2. Wait for the system to process and index your documents
|
55 |
+
3. Start asking questions about your documents
|
56 |
+
4. View answers with source citations
|
57 |
+
|
58 |
+
## Requirements
|
59 |
+
|
60 |
+
See `requirements.txt` for a complete list of dependencies.
|
61 |
+
|
62 |
+
## Credits
|
63 |
+
|
64 |
+
Based on original work by [Camilo Vega](https://www.linkedin.com/in/camilo-vega-169084b1/), AI Professor and Solutions Consultant.
|
65 |
+
|
66 |
+
## License
|
67 |
+
|
68 |
+
MIT License
|