sivakum4 commited on
Commit
53f047d
Β·
verified Β·
1 Parent(s): feb9951

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -12
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/ # 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
@@ -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
+ ```