Update README.md
Browse files
README.md
CHANGED
|
@@ -40,7 +40,22 @@ Weβre on the free HF hardware tier; first response may take ~30 s while the co
|
|
| 40 |
|
| 41 |
---
|
| 42 |
|
| 43 |
-
##
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 44 |
|
| 45 |
```bash
|
| 46 |
git clone https://huggingface.co/spaces/TeamSAS/UB_VSA
|
|
@@ -59,19 +74,3 @@ python main.py --build
|
|
| 59 |
# 4. Launch backend + frontend
|
| 60 |
python main.py --run
|
| 61 |
|
| 62 |
-
---
|
| 63 |
-
|
| 64 |
-
## Project Structure
|
| 65 |
-
|
| 66 |
-
buffalo_rag/
|
| 67 |
-
βββ api/ # Flask routes
|
| 68 |
-
βββ embeddings/ # chunker & encoder
|
| 69 |
-
βββ frontend/ # Flask templates + static JS
|
| 70 |
-
βββ model/ # RAG orchestration (BuffaloRAG)
|
| 71 |
-
βββ scraper/ # Playwright/BeautifulSoup crawler
|
| 72 |
-
βββ vector_store/ # FAISS DB + hybrid search
|
| 73 |
-
data/
|
| 74 |
-
βββ embeddings/ # .pkl + FAISS index (generated)
|
| 75 |
-
Dockerfile
|
| 76 |
-
start.sh
|
| 77 |
-
main.py # CLI pipeline entry-point
|
|
|
|
| 40 |
|
| 41 |
---
|
| 42 |
|
| 43 |
+
## Project Structure
|
| 44 |
+
|
| 45 |
+
buffalo_rag/
|
| 46 |
+
βββ api/ # Flask routes
|
| 47 |
+
βββ embeddings/ # chunker & encoder
|
| 48 |
+
βββ frontend/ # Flask templates + static JS
|
| 49 |
+
βββ model/ # RAG orchestration (BuffaloRAG)
|
| 50 |
+
βββ scraper/ # Playwright/BeautifulSoup crawler
|
| 51 |
+
βββ vector_store/ # FAISS DB + hybrid search
|
| 52 |
+
data/
|
| 53 |
+
βββ embeddings/ # .pkl + FAISS index (generated)
|
| 54 |
+
Dockerfile
|
| 55 |
+
start.sh
|
| 56 |
+
main.py # CLI pipeline entry-point
|
| 57 |
+
|
| 58 |
+
## ποΈ Quick Start (Local)
|
| 59 |
|
| 60 |
```bash
|
| 61 |
git clone https://huggingface.co/spaces/TeamSAS/UB_VSA
|
|
|
|
| 74 |
# 4. Launch backend + frontend
|
| 75 |
python main.py --run
|
| 76 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|