Kashish commited on
Commit
bfc6f8c
·
1 Parent(s): e92d49a

Fix README metadata for Hugging Face Spaces

Browse files
Files changed (1) hide show
  1. README.md +23 -9
README.md CHANGED
@@ -1,4 +1,13 @@
1
- <<<<<<< HEAD
 
 
 
 
 
 
 
 
 
2
  # FAQ RAG Chatbot
3
 
4
  RAG chatbot for a FAQ knowledge base. Uses FAISS for vector search with dense embeddings and a BM25 hybrid retriever.
@@ -8,7 +17,11 @@ RAG chatbot for a FAQ knowledge base. Uses FAISS for vector search with dense em
8
  - Virtualenv with dependencies in `requirements.txt`
9
 
10
  ## Quick setup
11
- 1. Activate virtualenv
 
 
 
 
12
  2. Install packages:
13
  ```powershell
14
  pip install -r requirements.txt
@@ -22,30 +35,31 @@ copy .env.example .env
22
  - `GOOGLE_GENAI_API_KEY` — API key for the Google GenAI LLM
23
  - `HF_TOKEN` — Hugging Face token to avoid unauthenticated download slowdowns
24
 
25
- ## Building the vectorstore (recommended before first run)
26
- Run the one-shot builder to compute embeddings and persist the FAISS index. This avoids the expensive first-request work during normal usage.
27
 
28
  ```powershell
29
  myenv\Scripts\python.exe build_index.py
30
  ```
31
 
32
- On first run this can take ~15–25s depending on hardware and network (model download).
33
 
34
  ## Run CLI
35
  ```powershell
36
- myenv\Scripts\python.exe cli.py "What is the Vicharanashala internship?"
37
  ```
38
 
39
  ## Run API
40
  ```powershell
41
  myenv\Scripts\python.exe -m uvicorn app:app --reload
42
  ```
 
43
  Then POST JSON to `http://127.0.0.1:8000/chat`:
44
  ```json
45
  { "question": "What is VINS?" }
46
  ```
47
 
48
- ## Notes & guidance
49
  - The first run must compute embeddings if the index does not exist.
50
- - To avoid repeated downloads and speed up startup: set `HF_TOKEN` and run `build_index.py` once on the host machine.
51
- - If you need smaller cold-start times, consider precomputing embeddings offline or using an even smaller embedding model.
 
1
+ ---
2
+ title: CSFAQ Project
3
+ emoji: 💻
4
+ colorFrom: purple
5
+ colorTo: red
6
+ sdk: docker
7
+ app_file: app.py
8
+ pinned: false
9
+ ---
10
+
11
  # FAQ RAG Chatbot
12
 
13
  RAG chatbot for a FAQ knowledge base. Uses FAISS for vector search with dense embeddings and a BM25 hybrid retriever.
 
17
  - Virtualenv with dependencies in `requirements.txt`
18
 
19
  ## Quick setup
20
+ 1. Activate virtualenv:
21
+ ```powershell
22
+ cd C:\Users\gupta\Desktop\faq-ai-chatbot
23
+ myenv\Scripts\Activate.ps1
24
+ ```
25
  2. Install packages:
26
  ```powershell
27
  pip install -r requirements.txt
 
35
  - `GOOGLE_GENAI_API_KEY` — API key for the Google GenAI LLM
36
  - `HF_TOKEN` — Hugging Face token to avoid unauthenticated download slowdowns
37
 
38
+ ## Build the vectorstore
39
+ Run once to compute embeddings and persist the FAISS index:
40
 
41
  ```powershell
42
  myenv\Scripts\python.exe build_index.py
43
  ```
44
 
45
+ On first run this can take ~15–25s depending on hardware and network.
46
 
47
  ## Run CLI
48
  ```powershell
49
+ myenv\Scripts\python.exe cli.py
50
  ```
51
 
52
  ## Run API
53
  ```powershell
54
  myenv\Scripts\python.exe -m uvicorn app:app --reload
55
  ```
56
+
57
  Then POST JSON to `http://127.0.0.1:8000/chat`:
58
  ```json
59
  { "question": "What is VINS?" }
60
  ```
61
 
62
+ ## Notes
63
  - The first run must compute embeddings if the index does not exist.
64
+ - To avoid repeated downloads and speed up startup: set `HF_TOKEN` and run `build_index.py` once.
65
+ - Do not commit `vectorstore/`, `myenv/`, or `.env`.