dfdfdsfgs commited on
Commit
51ac68d
Β·
1 Parent(s): e33dac9

Add proper README.md with Hugging Face Spaces configuration

Browse files
Files changed (1) hide show
  1. README.md +56 -0
README.md CHANGED
@@ -1,3 +1,59 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  # TheoremExplainAgent (TEA) 🍡
2
  [![arXiv](https://img.shields.io/badge/arXiv-2502.19400-b31b1b.svg)](https://arxiv.org/abs/2502.19400)
3
  <a href='https://huggingface.co/papers/2502.19400'><img src='https://img.shields.io/static/v1?label=Paper&message=Huggingface&color=orange'></a>
 
1
+ ---
2
+ title: TheoremExplainAgent
3
+ emoji: πŸŽ“
4
+ colorFrom: blue
5
+ colorTo: purple
6
+ sdk: gradio
7
+ sdk_version: "4.44.0"
8
+ app_file: app.py
9
+ pinned: false
10
+ license: mit
11
+ ---
12
+
13
+ # πŸŽ“ Theorem-Explain-Agent Video Generation
14
+
15
+ Generate educational videos explaining mathematical theorems and concepts using AI.
16
+
17
+ ## Features
18
+
19
+ - πŸ€– Multiple AI model support (Gemini, OpenAI, Anthropic)
20
+ - 🎬 Automated video generation with Manim
21
+ - 🎡 Text-to-speech narration
22
+ - πŸ“Š Real-time status tracking
23
+ - πŸ”„ Background processing
24
+
25
+ ## How to Use
26
+
27
+ 1. **Start Generation**: Enter a Model, Topic, and Context
28
+ 2. **Get Task ID**: Copy the generated task ID
29
+ 3. **Check Status**: Monitor progress in the Check Status tab
30
+ 4. **Download**: Get your video when generation completes
31
+
32
+ ## Supported Models
33
+
34
+ - `gemini/gemini-1.5-flash` (recommended)
35
+ - `gemini/gemini-1.5-pro`
36
+ - `openai/gpt-4o`
37
+ - `openai/o3-mini`
38
+ - `anthropic/claude-3-opus-20240229`
39
+
40
+ ## Requirements
41
+
42
+ This application requires API keys for the AI models you want to use. Set them in the Space's Repository Secrets:
43
+
44
+ - `GEMINI_API_KEY`
45
+ - `OPENAI_API_KEY`
46
+ - `LANGFUSE_PUBLIC_KEY`
47
+ - `LANGFUSE_SECRET_KEY`
48
+
49
+ ## Example Usage
50
+
51
+ **Topic**: "The Pythagorean Theorem"
52
+ **Context**: "In a right-angled triangle, the square of the length of the hypotenuse is equal to the sum of the squares of the other two sides."
53
+ **Model**: "gemini/gemini-1.5-flash"
54
+
55
+ The system will generate an educational video explaining the theorem with visual animations and narration.
56
+
57
  # TheoremExplainAgent (TEA) 🍡
58
  [![arXiv](https://img.shields.io/badge/arXiv-2502.19400-b31b1b.svg)](https://arxiv.org/abs/2502.19400)
59
  <a href='https://huggingface.co/papers/2502.19400'><img src='https://img.shields.io/static/v1?label=Paper&message=Huggingface&color=orange'></a>