AmirAziz1221 commited on
Commit
2175406
·
verified ·
1 Parent(s): 6e712c6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +28 -1
README.md CHANGED
@@ -9,4 +9,31 @@ python_version: 3.11
9
  app_file: app.py
10
  pinned: false
11
  license: mit
12
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  app_file: app.py
10
  pinned: false
11
  license: mit
12
+ ---
13
+
14
+ # 🎬 Agentic AI Video Analysis System — Gradio Edition
15
+
16
+ An end-to-end video analysis pipeline powered by YOLOv8, Groq LLaMA-3, and Gradio for Hugging Face Spaces.
17
+
18
+ ## What it does
19
+ - Extracts frames from an uploaded video using OpenCV
20
+ - Detects objects in each frame using YOLOv8 nano
21
+ - Generates a natural-language summary using Groq LLaMA-3 or mock mode
22
+ - Produces an analysis report with insights, risk flags, and recommendations
23
+ - Lets users download JSON and text reports
24
+
25
+ ## How to use
26
+ 1. Upload a video in MP4, AVI, MOV, or MKV format
27
+ 2. Adjust frame extraction and detection settings
28
+ 3. Click Analyze Video
29
+ 4. Review extracted frames, annotated frames, summaries, and reports
30
+
31
+ ## API Key Setup
32
+ 1. Get a Groq API key
33
+ 2. Open Space Settings → Secrets
34
+ 3. Add:
35
+ - Name: GROQ_API_KEY
36
+ - Value: your key
37
+ 4. Restart the Space
38
+
39
+ Without a key, the app still works in mock mode.