Skip to content

Commit d8976e2

Browse files
authored
Update README.md
1 parent d4df82a commit d8976e2

File tree

1 file changed

+71
-1
lines changed

1 file changed

+71
-1
lines changed

README.md

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,71 @@
1-
# CV_PS
1+
# VideoQA – Ask Questions About Any Video!
2+
3+
> A full-stack AI-powered application that allows users to upload a video and ask context-aware questions about it using CLIP, FAISS, and LLaVA via Segmind API.
4+
5+
---
6+
7+
## How It Works
8+
9+
1. **Upload a Video** via a React + Tailwind frontend.
10+
2. **Frame Extraction**: Key frames are extracted using OpenCV.
11+
3. **Embedding**: Frames are embedded using Hugging Face’s CLIP model.
12+
4. **Indexing**: Embeddings are stored and queried with FAISS.
13+
5. **Questioning**: User questions are semantically matched to the most relevant frames.
14+
6. **Answering**: Segmind's LLaVA API generates answers using the retrieved context.
15+
16+
---
17+
18+
## Tech Stack
19+
20+
### Backend (FastAPI)
21+
- CLIP (Hugging Face `openai/clip-vit-large-patch14`)
22+
- FAISS (vector similarity search)
23+
- Segmind LLaVA API
24+
- OpenCV (frame extraction)
25+
- Python, PIL, Torch
26+
27+
### 💻 Frontend (Vite + React)
28+
- Tailwind CSS
29+
- Fetch API (HTTP-based interaction)
30+
31+
---
32+
33+
## Getting Started
34+
35+
### 🔧 Prerequisites
36+
37+
- Python ≥ 3.9
38+
- Node.js ≥ 18
39+
- [Segmind LLaVA API Key](https://segmind.com/)
40+
41+
---
42+
43+
## Backend Setup (FastAPI)
44+
45+
```bash
46+
# Clone the repo
47+
git clone https://github.com/coderuhaan2004/VideoQA.git
48+
cd VideoQA/backend
49+
50+
# Create a virtual env
51+
python -m venv venv
52+
source venv/bin/activate # or venv\Scripts\activate on Windows
53+
54+
# Install dependencies
55+
pip install -r requirements.txt
56+
57+
# Run the server
58+
python app.py
59+
```
60+
61+
## Frontend Setup (Vite-React)
62+
```bash
63+
# Clone the repo
64+
cd VideoQA/chatbot
65+
66+
# Install Libraries
67+
npm install
68+
69+
# Run
70+
npm run dev
71+
```

0 commit comments

Comments
 (0)