Create README.md
Browse files
README.md
CHANGED
|
@@ -1,20 +1,83 @@
|
|
| 1 |
---
|
| 2 |
-
title: BatAnki
|
| 3 |
-
emoji: 🚀
|
| 4 |
-
colorFrom: red
|
| 5 |
-
colorTo: red
|
| 6 |
-
sdk: docker
|
| 7 |
-
app_port: 8501
|
| 8 |
-
tags:
|
| 9 |
-
- streamlit
|
| 10 |
-
pinned: false
|
| 11 |
-
short_description: Vigilante who creates app for medical students
|
| 12 |
license: apache-2.0
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 13 |
---
|
| 14 |
|
| 15 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 16 |
|
| 17 |
-
|
| 18 |
|
| 19 |
-
|
| 20 |
-
|
|
|
|
| 1 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2 |
license: apache-2.0
|
| 3 |
+
title: BatAnki
|
| 4 |
+
sdk: streamlit
|
| 5 |
+
colorFrom: indigo
|
| 6 |
+
colorTo: purple
|
| 7 |
+
---
|
| 8 |
+
# 🦇 BatAnki – AI Flashcard Generator
|
| 9 |
+
|
| 10 |
+
BatAnki is an AI-powered flashcard generator for medical learners. Inspired by Batman, built for speed. Runs on [Hugging Face Spaces](https://huggingface.co/spaces) using `streamlit`.
|
| 11 |
+
|
| 12 |
+
---
|
| 13 |
+
|
| 14 |
+
## ✅ Features
|
| 15 |
+
|
| 16 |
+
- 📄 PDF → Flashcards (with OCR fallback)
|
| 17 |
+
- 🖼️ Image → Text → Flashcards (via EasyOCR)
|
| 18 |
+
- 🎧 Audio → Transcription → Flashcards (via Whisper)
|
| 19 |
+
- 🧠 AI Flashcard Generator (Q&A, Cloze, MCQ via T5)
|
| 20 |
+
- 💾 Export to `.apkg` (Anki deck)
|
| 21 |
+
- 🦇 Batman/Dark theme UI
|
| 22 |
+
- 🧪 Smart tagging and chunking
|
| 23 |
+
- ✅ 100% free (no OpenAI API, no paid keys)
|
| 24 |
+
|
| 25 |
---
|
| 26 |
|
| 27 |
+
## 🚀 Deployment (Hugging Face)
|
| 28 |
+
|
| 29 |
+
### Step 1: Create Space
|
| 30 |
+
|
| 31 |
+
1. Go to: [https://huggingface.co/spaces](https://huggingface.co/spaces)
|
| 32 |
+
2. Click **Create new Space**
|
| 33 |
+
3. Name it something like `batanki-app`
|
| 34 |
+
4. Choose **"Streamlit"**
|
| 35 |
+
5. Choose **"Public"** (or Private if you have Pro)
|
| 36 |
+
|
| 37 |
+
---
|
| 38 |
+
|
| 39 |
+
### Step 2: Upload Files
|
| 40 |
+
|
| 41 |
+
Upload the following into your Space:
|
| 42 |
+
- `app.py`
|
| 43 |
+
- `config.py`
|
| 44 |
+
- `requirements.txt`
|
| 45 |
+
- (Optional) `README.md`
|
| 46 |
+
|
| 47 |
+
---
|
| 48 |
+
|
| 49 |
+
### Step 3: Let Hugging Face Build
|
| 50 |
+
|
| 51 |
+
- It will automatically install all packages from `requirements.txt`
|
| 52 |
+
- Wait for build to complete (~2–4 minutes)
|
| 53 |
+
- The app will launch at `https://<your-username>.huggingface.space`
|
| 54 |
+
|
| 55 |
+
---
|
| 56 |
+
|
| 57 |
+
## 🧠 Model Details
|
| 58 |
+
|
| 59 |
+
- Flashcard AI: `t5-base` (can be swapped with `BioGPT` or `medalpaca` for more clinical reasoning)
|
| 60 |
+
- OCR: `PyMuPDF` + `pytesseract` + `easyocr`
|
| 61 |
+
- Audio: `openai/whisper` (base model)
|
| 62 |
+
|
| 63 |
+
---
|
| 64 |
+
|
| 65 |
+
## 📦 Output
|
| 66 |
+
|
| 67 |
+
- You can export your flashcards as `.apkg` (for Anki)
|
| 68 |
+
- Flashcards support Q&A + answer-side reveal + optional cloze
|
| 69 |
+
|
| 70 |
+
---
|
| 71 |
+
|
| 72 |
+
## 💡 Notes
|
| 73 |
+
|
| 74 |
+
- No external API needed
|
| 75 |
+
- Fully runs within Hugging Face (free tier)
|
| 76 |
+
- No login/save yet (you can add SQLite/Firestore later)
|
| 77 |
+
|
| 78 |
+
---
|
| 79 |
|
| 80 |
+
## ⚡ Credits
|
| 81 |
|
| 82 |
+
- Built by Dr. Pavan Reddy (idea)
|
| 83 |
+
- Engineered by OpenAI ChatGPT-4
|