Update README.md
Browse files
README.md
CHANGED
@@ -1,14 +1,249 @@
|
|
1 |
---
|
2 |
-
|
3 |
-
|
4 |
-
|
5 |
-
|
|
|
6 |
sdk: gradio
|
7 |
-
sdk_version:
|
8 |
app_file: app.py
|
9 |
pinned: false
|
10 |
-
license:
|
11 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
12 |
---
|
13 |
|
14 |
-
|
|
|
1 |
---
|
2 |
+
---
|
3 |
+
title: Course Creator AI - Multi-Tool Agent Demo
|
4 |
+
emoji: ๐
|
5 |
+
colorFrom: blue
|
6 |
+
colorTo: purple
|
7 |
sdk: gradio
|
8 |
+
sdk_version: 4.44.0
|
9 |
app_file: app.py
|
10 |
pinned: false
|
11 |
+
license: mit
|
12 |
+
tags:
|
13 |
+
- agent-demo-track
|
14 |
+
- education
|
15 |
+
- ai-agents
|
16 |
+
- course-generation
|
17 |
+
- multi-tool
|
18 |
+
- web-research
|
19 |
+
- image-generation
|
20 |
+
- gradio
|
21 |
+
- hackathon
|
22 |
+
short_description: AI-powered educational course generator
|
23 |
+
---
|
24 |
+
|
25 |
+
# ๐ Course Creator AI - Multi-Tool Agent Demo
|
26 |
+
|
27 |
+
**Track 3: Agentic Demo Submission** | **Hugging Face Agent Hackathon 2025**
|
28 |
+
|
29 |
+
> **๐ฏ Tag**: `agent-demo-track`
|
30 |
+
|
31 |
+
## ๐ฌ Video Overview
|
32 |
+
|
33 |
+
**๐น [Watch Demo Video - App Usage & Purpose Explanation](https://youtu.be/3VS010g4_c8)**
|
34 |
+
|
35 |
+
|
36 |
+
---
|
37 |
+
|
38 |
+
## ๐ What is Course Creator AI?
|
39 |
+
|
40 |
+
Course Creator AI is a **real multi-tool agent system** that demonstrates the power of AI agents working together to create comprehensive educational content. This isn't a simulation - it's a live demonstration of agents using actual tools and APIs to research, generate, and create educational materials.
|
41 |
+
|
42 |
+
### ๐ฏ **Purpose & Vision**
|
43 |
+
|
44 |
+
Transform any topic into a complete, engaging educational experience through intelligent agent orchestration. Perfect for educators, students, content creators, and anyone looking to learn or teach effectively.
|
45 |
+
|
46 |
+
## ๐ค **Real Agent Workflow in Action**
|
47 |
+
|
48 |
+
Watch our agents work together in real-time:
|
49 |
+
|
50 |
+
### **๐ Research Agent**
|
51 |
+
- **Tool**: DuckDuckGo Search API
|
52 |
+
- **Action**: Searches the web for current, relevant information
|
53 |
+
- **Output**: Curated research data and reliable sources
|
54 |
+
|
55 |
+
### **๐ Content Agent**
|
56 |
+
- **Tool**: Advanced LLM Integration (OpenAI, Anthropic, Google Gemini)
|
57 |
+
- **Action**: Processes research into structured educational content
|
58 |
+
- **Output**: Comprehensive lessons with learning objectives, interactive flashcards, and quiz
|
59 |
+
|
60 |
+
### **๐จ Image Agent**
|
61 |
+
- **Tool**: Pollinations API (GPT-Image Model)
|
62 |
+
- **Action**: Generates contextual educational images
|
63 |
+
- **Output**: High-quality, relevant visual aids
|
64 |
+
|
65 |
+
### **๐ง Assessment Agent**
|
66 |
+
- **Tool**: Intelligent Content Analysis
|
67 |
+
- **Action**: Creates interactive learning materials
|
68 |
+
- **Output**: Flashcards and quizzes for knowledge retention
|
69 |
+
|
70 |
+
## โจ **Key Features**
|
71 |
+
|
72 |
+
### ๐ **Complete Course Generation**
|
73 |
+
- **5 Comprehensive Lessons** with detailed content (2000+ words each)
|
74 |
+
- **Learning Objectives** tailored to difficulty level
|
75 |
+
- **Real-world Examples** and practical applications
|
76 |
+
- **Progressive Difficulty** building from fundamentals
|
77 |
+
|
78 |
+
### ๐ **Interactive Learning Materials**
|
79 |
+
- **15 Smart Flashcards** for key concept reinforcement
|
80 |
+
- **10 Multiple-Choice Questions** with detailed explanations
|
81 |
+
- **Immediate Feedback** and scoring system
|
82 |
+
- **Category-based Organization** for focused study
|
83 |
+
|
84 |
+
### ๐ผ๏ธ **Visual Learning Enhancement**
|
85 |
+
- **AI-Generated Educational Images** using Flux model
|
86 |
+
- **Contextual Visual Aids** that enhance understanding
|
87 |
+
- **No Watermarks** - clean, professional imagery
|
88 |
+
- **Smart Placeholder System** for optimal image placement
|
89 |
+
|
90 |
+
### ๐ง **Multi-Provider LLM Support**
|
91 |
+
- **OpenAI GPT Models** for premium quality
|
92 |
+
- **Anthropic Claude** for detailed analysis
|
93 |
+
- **Google Gemini** for cost-effective generation
|
94 |
+
- **OpenAI-Compatible APIs** for flexibility
|
95 |
+
- **Smart Provider Switching** via environment variables
|
96 |
+
|
97 |
+
## ๐ ๏ธ **Technical Architecture**
|
98 |
+
|
99 |
+
### **Agent Orchestration**
|
100 |
+
```
|
101 |
+
Research Agent โ Content Agent โ Assessment Agent โ Image Agent
|
102 |
+
โ โ โ โ
|
103 |
+
Web Search โ Lesson Creation โ Quiz Generation โ Visual Enhancement
|
104 |
+
```
|
105 |
+
|
106 |
+
### **Real Tool Integration**
|
107 |
+
- **๐ Web Research**: Live DuckDuckGo search with Crawl4AI content extraction
|
108 |
+
- **๐ง LLM Processing**: Multi-provider support with smart JSON parsing
|
109 |
+
- **๐จ Image Generation**: Pollinations API with Flux model
|
110 |
+
- **๐ Content Analysis**: Intelligent educational content structuring
|
111 |
+
|
112 |
+
### **Smart Features**
|
113 |
+
- **Markdown-Aware JSON Parser** handles LLM response variations
|
114 |
+
- **Provider Fallback System** ensures reliability
|
115 |
+
- **Real-time Progress Tracking** (console-based)
|
116 |
+
- **Error Recovery** with graceful degradation
|
117 |
+
|
118 |
+
## ๐ฎ **How to Use**
|
119 |
+
|
120 |
+
### **1. Quick Start**
|
121 |
+
1. **Enter Your Topic**: Anything from "Python Programming" to "Ancient History"
|
122 |
+
2. **Choose Difficulty**: Beginner, Intermediate, or Advanced
|
123 |
+
3. **Set Lesson Count**: 3-7 lessons based on your needs
|
124 |
+
4. **Click Generate**: Watch the agents work their magic!
|
125 |
+
|
126 |
+
### **2. Explore Your Course**
|
127 |
+
- **๐ Course Overview**: See the complete structure and learning objectives
|
128 |
+
- **๐ Lessons**: Dive into detailed, research-backed content
|
129 |
+
- **๐ Flashcards**: Test your knowledge with interactive cards
|
130 |
+
- **๐ Quiz**: Challenge yourself with comprehensive questions
|
131 |
+
- **๐จ Images**: Enjoy AI-generated visual learning aids
|
132 |
+
|
133 |
+
### **3. Interactive Learning**
|
134 |
+
- **Flip Flashcards** to reveal answers
|
135 |
+
- **Take the Quiz** with immediate feedback
|
136 |
+
- **Review Explanations** for deeper understanding
|
137 |
+
- **Track Your Progress** through the material
|
138 |
+
|
139 |
+
## ๐ง **Configuration**
|
140 |
+
|
141 |
+
### **๐ Quick Start (Hugging Face Space)**
|
142 |
+
1. **Select LLM Provider**: Choose from OpenAI, Anthropic, Google Gemini, or OpenAI-Compatible
|
143 |
+
2. **Enter API Key**: Add your API key in the interface
|
144 |
+
3. **Generate Course**: Enter any topic and start creating!
|
145 |
+
|
146 |
+
### **Provider Options**
|
147 |
+
- **๐ Google Gemini**: Free tier available, excellent quality
|
148 |
+
- **๐ OpenAI GPT**: Premium quality, requires paid API
|
149 |
+
- **๐ง Anthropic Claude**: Advanced reasoning, requires paid API
|
150 |
+
- **๐ OpenAI-Compatible**: Use any compatible endpoint
|
151 |
+
|
152 |
+
### **๐จ Image Generation**
|
153 |
+
- **Automatic**: High-quality educational images generated automatically
|
154 |
+
- **No Setup Required**: Image generation credentials are pre-configured
|
155 |
+
- **Professional Quality**: Clean, watermark-free educational visuals
|
156 |
+
|
157 |
+
## ๐ **Why This Demonstrates Real Agent Power**
|
158 |
+
|
159 |
+
### **๐ Multi-Tool Orchestration**
|
160 |
+
Unlike simple chatbots, our agents actually use real tools:
|
161 |
+
- **Web APIs** for current information
|
162 |
+
- **Image Generation APIs** for visual content
|
163 |
+
- **Multiple LLM providers** for diverse capabilities
|
164 |
+
- **Content Processing Tools** for structured output
|
165 |
+
|
166 |
+
### **๐ฏ Practical Real-World Application**
|
167 |
+
- **Educators** can generate curriculum quickly
|
168 |
+
- **Students** can create study materials for any topic
|
169 |
+
- **Content Creators** can produce educational resources
|
170 |
+
- **Businesses** can develop training materials
|
171 |
+
|
172 |
+
### **๐ Scalable Architecture**
|
173 |
+
- **Modular Design** allows easy tool addition
|
174 |
+
- **Provider Agnostic** works with any LLM service
|
175 |
+
- **Error Resilient** handles API failures gracefully
|
176 |
+
- **Performance Optimized** for real-world usage
|
177 |
+
|
178 |
+
## ๐ **Demo Statistics**
|
179 |
+
|
180 |
+
- **๐ Courses Generated**: Unlimited topics supported
|
181 |
+
- **๐ Content Volume**: 10,000+ words per complete course
|
182 |
+
- **๐จ Images Created**: Up to 15 educational visuals per course
|
183 |
+
- **๐ง Assessment Items**: 25+ interactive learning elements per course
|
184 |
+
- **โก Generation Time**: 2-5 minutes for complete course
|
185 |
+
- **๐ Language Support**: Multi-language content generation
|
186 |
+
|
187 |
+
## ๐ก๏ธ **Reliability Features**
|
188 |
+
|
189 |
+
### **Smart Error Handling**
|
190 |
+
- **Provider Fallback**: Automatically switches if primary LLM fails
|
191 |
+
- **JSON Recovery**: Handles malformed responses gracefully
|
192 |
+
- **Content Validation**: Ensures educational quality standards
|
193 |
+
- **API Resilience**: Continues operation despite individual tool failures
|
194 |
+
|
195 |
+
### **Quality Assurance**
|
196 |
+
- **Research Verification**: Cross-references multiple sources
|
197 |
+
- **Content Coherence**: Maintains logical lesson progression
|
198 |
+
- **Assessment Alignment**: Quizzes match lesson objectives
|
199 |
+
- **Visual Relevance**: Images enhance specific content points
|
200 |
+
|
201 |
+
## ๐ฏ **Perfect for Hackathon Judging**
|
202 |
+
|
203 |
+
### **โ
Innovation**
|
204 |
+
- Real multi-tool agent orchestration (not simulated)
|
205 |
+
- Novel educational content generation approach
|
206 |
+
- Creative use of multiple AI services together
|
207 |
+
|
208 |
+
### **โ
Technical Excellence**
|
209 |
+
- Robust error handling and provider fallbacks
|
210 |
+
- Clean, modular architecture
|
211 |
+
- Real-time tool integration
|
212 |
+
- Professional UI/UX design
|
213 |
+
|
214 |
+
### **โ
Practical Impact**
|
215 |
+
- Immediate value for educators and learners
|
216 |
+
- Scalable to any educational domain
|
217 |
+
- Production-ready implementation
|
218 |
+
- Clear business applications
|
219 |
+
|
220 |
+
### **โ
User Experience**
|
221 |
+
- Intuitive interface requiring no technical knowledge
|
222 |
+
- Engaging interactive elements
|
223 |
+
- Professional visual design
|
224 |
+
- Comprehensive feature set
|
225 |
+
|
226 |
+
## ๐ **Try It Now!**
|
227 |
+
|
228 |
+
Experience the power of real AI agents working together to create educational content. Generate a course on any topic and watch as our agents research, create, and enhance your learning experience in real-time!
|
229 |
+
|
230 |
+
**๐ [Launch Course Creator AI](https://huggingface.co/spaces/Agents-MCP-Hackathon/course-creator-ai)**
|
231 |
+
|
232 |
+
---
|
233 |
+
|
234 |
+
## ๐ **Technical Details**
|
235 |
+
|
236 |
+
- **Framework**: Gradio 4.44.0
|
237 |
+
- **Language**: Python 3.9+
|
238 |
+
- **Architecture**: Async multi-agent system
|
239 |
+
- **APIs**: DuckDuckGo, Pollinations, OpenAI, Anthropic, Google
|
240 |
+
- **Deployment**: Hugging Face Spaces
|
241 |
+
- **License**: MIT
|
242 |
+
|
243 |
+
## ๐ท๏ธ **Tags**
|
244 |
+
|
245 |
+
`agent-demo-track` `education` `ai-agents` `course-generation` `multi-tool` `web-research` `image-generation` `gradio` `hackathon`
|
246 |
+
|
247 |
---
|
248 |
|
249 |
+
**Made with โค๏ธ by Pink Pixel** | **Hugging Face Agent Hackathon 2025** | **Track 3: Agentic Demo**
|