Spaces:
Running
Running
Your Name commited on
Commit ·
94dca4d
1
Parent(s): 7a68239
Add killer README with benchmark results
Browse files
README.md
CHANGED
|
@@ -7,3 +7,38 @@ sdk: docker
|
|
| 7 |
app_file: app.py
|
| 8 |
pinned: false
|
| 9 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 7 |
app_file: app.py
|
| 8 |
pinned: false
|
| 9 |
---
|
| 10 |
+
|
| 11 |
+
# 🔍 AI Codebase Explainer
|
| 12 |
+
|
| 13 |
+
> Ask questions about any GitHub repository in plain English. No more reading 50 files manually.
|
| 14 |
+
|
| 15 |
+
## 🚀 Live Demo
|
| 16 |
+
👉 [Try it here](https://huggingface.co/spaces/Krishp1/codebase-explainer)
|
| 17 |
+
|
| 18 |
+
## 📊 Benchmark Results (psf/requests)
|
| 19 |
+
| Metric | Result |
|
| 20 |
+
|--------|--------|
|
| 21 |
+
| Files indexed | 46 files |
|
| 22 |
+
| Chunks created | 341 chunks |
|
| 23 |
+
| Ingestion time | 15.45 seconds |
|
| 24 |
+
| Vector DB latency | ~100ms |
|
| 25 |
+
| Accuracy | 4/5 questions ✅ |
|
| 26 |
+
|
| 27 |
+
## 🛠️ Tech Stack
|
| 28 |
+
- LangChain + RAG pipeline
|
| 29 |
+
- ChromaDB (vector store)
|
| 30 |
+
- HuggingFace Embeddings (all-MiniLM-L6-v2)
|
| 31 |
+
- Groq LLaMA 3 (LLM)
|
| 32 |
+
- Streamlit (UI)
|
| 33 |
+
- Docker + HuggingFace Spaces (deployment)
|
| 34 |
+
|
| 35 |
+
## 💡 How It Works
|
| 36 |
+
1. Paste any GitHub repo URL
|
| 37 |
+
2. App clones and indexes all code files
|
| 38 |
+
3. Ask questions in plain English
|
| 39 |
+
4. Get answers with source file citations
|
| 40 |
+
|
| 41 |
+
## 🎯 Use Cases
|
| 42 |
+
- Understand a new codebase in minutes
|
| 43 |
+
- Onboard to a new company faster
|
| 44 |
+
- Explore open source projects instantly
|