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