gladguy commited on
Commit
a12a536
·
1 Parent(s): 5fd80d1

Final submission

Browse files
Files changed (1) hide show
  1. README.md +31 -26
README.md CHANGED
@@ -28,45 +28,50 @@ This project showcases **an intelligent multi-agent educational system** powered
28
 
29
  ---
30
 
31
- ## 🌐 Project Overview
32
 
33
- This system leverages specialized AI agents that collaborate to create an immersive learning experience:
34
 
35
- - 🛡️ **Validator Agent**: Ensures all queries are strictly anatomy-related using **Hyperbolic AI**.
36
- - 🖼️ **Visual Agent**: Instantly fetches and filters high-quality anatomical diagrams via **SERPAPI**.
37
- - 👨‍⚕️ **Professor Agent**: Conducts oral VIVA exams, generating questions and vocalizing them using **ElevenLabs**.
38
- - 🧠 **Analyst Agent**: Reads and interprets uploaded textbook pages to generate summaries and quizzes.
39
 
40
  ---
41
 
42
- ## 🗂️ Data Sources & External APIs
43
 
44
- Our platform relies on **state-of-the-art AI models and real-time data**. Each component is powered by a dedicated API to ensure accuracy and engagement.
45
 
46
- **Here is a detailed overview of the APIs and data sources leveraged by the agents:**
 
 
 
47
 
48
- 1. **Hyperbolic AI (Llama 3.3 70B)** *The Brain*
49
- * Used for query validation, educational content generation, and student answer evaluation.
50
- 2. **SERPAPI (Google Images)** *The Eyes*
51
- * Provides real-time access to high-quality medical diagrams and illustrations.
52
- 3. **ElevenLabs** *The Voice*
53
- * Powers the "Professor Agent" to speak VIVA questions, simulating a real oral exam.
54
 
55
- ---
 
 
 
56
 
57
- ## 🧩 Core Components
 
58
 
59
- ### 🎨 User Interface (`app.py`)
60
- - **Interactive Gradio Interface**: A clean, tabbed UI optimized for learning.
61
- - **Real-time Feedback**: Instant visual and audio responses.
62
- - **Navigation**: Seamless switching between Learning, VIVA, and Book modes.
63
 
64
- ### 🧠 Logic & Agents (`capp.py`)
65
- - **Agent Definitions**: Contains the logic for the Validator, Visual, and Professor agents.
66
- - **State Management**: Handles user sessions, VIVA progress, and PDF processing.
67
 
68
- ### 💾 Data Persistence (`students.db`)
69
- - **Student Records**: SQLite database to track registered students (Name, Medical School, Year).
 
 
 
 
 
70
 
71
  ---
72
 
 
28
 
29
  ---
30
 
31
+ ## 📝 What I want to showcase
32
 
33
+ I want to showcase an intelligent, interactive educational platform designed specifically for MBBS (medical) students. The goal is to bridge the gap between static textbooks and active learning by providing:
34
 
35
+ - **Visual & Contextual Learning**: Instantly fetching relevant anatomical diagrams alongside AI-generated educational summaries.
36
+ - **Active Recall & Simulation**: A "VIVA Mode" that simulates an oral anatomy exam with a strict but fair AI professor, complete with voice interaction.
37
+ - **Resource Augmentation**: A "Book Mode" that allows students to upload their own textbooks and get AI-powered analysis and quiz questions for specific pages.
 
38
 
39
  ---
40
 
41
+ ## �️ What I've built so far
42
 
43
+ I have built a fully functional **Gradio** web application that integrates multiple powerful AI services:
44
 
45
+ ### 1. Smart Query Engine
46
+ * Uses **Hyperbolic AI (Llama 3.3 70B)** to validate if questions are strictly anatomy-related.
47
+ * Fetches high-quality diagrams using **SERPAPI (Google Images)**, filtering out non-diagrammatic results.
48
+ * Generates structured, emoji-rich educational content (Location, Features, Clinical Significance).
49
 
50
+ ### 2. VIVA Training Mode
51
+ * Simulates a real oral exam environment.
52
+ * Generates progressive questions (from basic relations to clinical scenarios).
53
+ * **Voice Interaction**: Uses **ElevenLabs** to vocalize questions, making the experience immersive.
54
+ * **AI Evaluation**: Grades student answers (Distinction, Pass, Borderline, Fail) and provides detailed feedback with reference answers.
 
55
 
56
+ ### 3. Book Learning Mode
57
+ * Allows PDF textbook uploads.
58
+ * Extracts and displays specific pages.
59
+ * Analyzes page content to generate summaries, clinical points, and self-test questions.
60
 
61
+ ### 4. Student System
62
+ * Includes a registration system (SQLite backend) to track student details (Name, Medical School, Year).
63
 
64
+ ---
 
 
 
65
 
66
+ ## Tech Stack
 
 
67
 
68
+ * **Frontend/UI**: Gradio (Python)
69
+ * **LLM Intelligence**: Hyperbolic AI API (Meta Llama 3.3 70B Instruct)
70
+ * **Image Search**: SERPAPI (Google Images Engine)
71
+ * **Voice Synthesis**: ElevenLabs API (Text-to-Speech)
72
+ * **Database**: SQLite (for user management)
73
+ * **Image/PDF Processing**: Pillow, PyPDF2, pdf2image
74
+ * **Environment**: Python, Hugging Face Spaces
75
 
76
  ---
77