HuzaifaTech commited on
Commit
5cc5508
·
verified ·
1 Parent(s): a34e65c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +27 -7
README.md CHANGED
@@ -1,14 +1,34 @@
1
  ---
2
- title: Multi Documents
3
- emoji: 💻
4
- colorFrom: purple
5
- colorTo: pink
6
  sdk: gradio
7
- sdk_version: 6.14.0
8
- python_version: '3.13'
9
  app_file: app.py
10
  pinned: false
11
  license: mit
12
  ---
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: Groq RAG Assistant
3
+ emoji: 🧠
4
+ colorFrom: blue
5
+ colorTo: indigo
6
  sdk: gradio
7
+ sdk_version: "4.44.0"
 
8
  app_file: app.py
9
  pinned: false
10
  license: mit
11
  ---
12
 
13
+ # 🧠 Groq RAG Assistant
14
+
15
+ A fully local RAG (Retrieval-Augmented Generation) chatbot that lets you upload documents and ask questions about them.
16
+
17
+ ## Features
18
+ - 📄 Supports **PDF**, **DOCX**, and **TXT** files
19
+ - 🧠 Local embeddings via `sentence-transformers` (`all-MiniLM-L6-v2`)
20
+ - 🗄️ Vector storage via **ChromaDB** (stored in `/tmp`)
21
+ - ⚡ Fast LLM inference via **Groq** (`llama3-8b-8192`)
22
+
23
+ ## Setup
24
+
25
+ 1. Fork / duplicate this Space.
26
+ 2. Go to **Settings → Variables and secrets**.
27
+ 3. Add a secret named `GROQ_API_KEY` with your key from [console.groq.com](https://console.groq.com).
28
+ 4. Restart the Space — you're ready to go!
29
+
30
+ ## How to use
31
+
32
+ 1. Upload one or more PDF / DOCX / TXT files in the left panel.
33
+ 2. Click **🚀 Process Files** and wait for the confirmation message.
34
+ 3. Type your question in the chat box and hit **Send**.