Hugging Face's logo

Spaces:
Pavaas
/
BatAnki
Sleeping

App Files Community
Pavaas commited on
Commit
9b430d3
·
verified ·
1 Parent(s): fd08e9f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +26 -37
README.md CHANGED
@@ -6,53 +6,42 @@ colorFrom: indigo
6
  colorTo: purple
7
  sdk_version: 1.46.0
8
  ---
9
- # 🦇 BatAnki – AI Flashcard Engine for PDF / Image / Audio / YouTube / Text
10
 
11
- BatAnki is an offline, fully open-source, AI-powered flashcard app designed for students, medicos, and power learners. Built for Hugging Face Spaces, no API keys required.
12
 
13
- ---
14
-
15
- ### ✅ Features (All Green Table Items Supported)
16
- - 📄 Upload & process **PDF, Image, Audio, YouTube, Text (.txt/.docx)**
17
- - 🔠 Extract text using **OCR**, **Whisper**, or **PyMuPDF**
18
- - 🧠 Generate flashcards using **T5** or **BioGPT**
19
- - 💡 Supports **Q&A, Cloze, MCQ, and Reverse cards**
20
- - 🏷️ Tag flashcards manually
21
- - 💾 Export to **Anki (.apkg)** and **CSV**
22
- - 🧾 Inline preview & edit of each card
23
- - 🎨 Light/Dark themes with Batman-style layout
24
- - ⚙️ 100% deployable without any paid APIs
25
 
26
  ---
27
 
28
- ### 🧠 Models Used
29
- - `t5-base` (general QA generation)
30
- - `microsoft/BioGPT` (medical/scientific Q&A)
31
- - `openai/whisper` (audio transcription)
32
- - `easyocr` + `pytesseract` (OCR engine)
 
 
 
33
 
34
  ---
35
 
36
- ### 💻 Usage Instructions
37
- 1. 📁 Upload a file (PDF, Image, Audio, Text) or paste a YouTube link
38
- 2. 🎯 Choose the card types you want (Q&A, Cloze, MCQ, Reverse)
39
- 3. 🚀 Click **Extract Text**, then **Generate Flashcards**
40
- 4. ✍️ Edit, tag, and preview each card
41
- 5. ⬇️ Export as `.apkg` or `.csv`
 
42
 
43
  ---
44
 
45
- ### 🛠 Requirements
 
 
46
 
47
  ```bash
48
- streamlit
49
- transformers
50
- torch
51
- genanki
52
- easyocr
53
- PyMuPDF
54
- pytesseract
55
- whisper
56
- yt-dlp
57
- python-docx
58
- Pillow
 
6
  colorTo: purple
7
  sdk_version: 1.46.0
8
  ---
9
+ # 🦇 BatAnki – AI-Powered Flashcard Generator
10
 
11
+ BatAnki is a lightweight AI-driven app that converts any document, image, audio, or video into spaced-repetition flashcards. Designed for learners, researchers, and educators, BatAnki supports multiple input types and smart flashcard types including:
12
 
13
+ - Q&A Cards
14
+ - Cloze Deletions
15
+ - Multiple Choice Questions
16
+ - Reverse Recall
 
 
 
 
 
 
 
 
17
 
18
  ---
19
 
20
+ ## 🚀 Features
21
+
22
+ - 📄 PDF & Text file support with preview
23
+ - 🖼️ Image-to-text (OCR) processing
24
+ - 🎧 Audio/Video transcription to text
25
+ - 🧠 AI-based flashcard generation with multiple engines
26
+ - 📦 Export flashcards to `.apkg` (Anki) and `.csv`
27
+ - ✅ 100% free & open-source — no paid APIs needed
28
 
29
  ---
30
 
31
+ ## 📂 Input Formats Supported
32
+
33
+ - PDF (`.pdf`)
34
+ - Text & Docs (`.txt`, `.docx`)
35
+ - Image (`.jpg`, `.png`)
36
+ - Audio (`.mp3`, `.wav`)
37
+ - YouTube audio via link
38
 
39
  ---
40
 
41
+ ## ⚙️ Installation
42
+
43
+ To run locally:
44
 
45
  ```bash
46
+ pip install -r requirements.txt
47
+ streamlit run app.py