MonaHamid commited on
Commit
5097a5c
Β·
verified Β·
1 Parent(s): 2fab740

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +52 -14
README.md CHANGED
@@ -1,14 +1,52 @@
1
- ---
2
- title: ExplainAnything AI
3
- emoji: 🏒
4
- colorFrom: indigo
5
- colorTo: indigo
6
- sdk: gradio
7
- sdk_version: 5.33.1
8
- app_file: app.py
9
- pinned: false
10
- license: mit
11
- short_description: ' A multimodal science tutor that explains images, answers qu'
12
- ---
13
-
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ πŸ“š ExplainAnything.AI
2
+ ExplainAnything.AI is an interactive multimodal science explainer built with Gradio. It allows users to:
3
+
4
+ Ask science questions or upload diagrams/PDFs
5
+
6
+ Get clear explanations using Google Gemini or Mistral
7
+
8
+ Generate visual diagrams via FLUX (Stable Diffusion)
9
+
10
+ Take auto-generated quizzes to test understanding
11
+
12
+ Download personalized science reports in PDF or Markdown
13
+
14
+ πŸš€ How It Works
15
+ Ask a Question
16
+ Type a science question (e.g., How do volcanoes erupt?)
17
+ β†’ Choose level: Kid, Beginner, or Advanced
18
+
19
+ Upload a File (Optional)
20
+ You can upload a PDF, image, or diagram to get contextual explanations
21
+
22
+ View Explanation + Diagram
23
+ The app generates a clear explanation and a visual illustration using generative models
24
+
25
+ Take the Quiz
26
+ Answer auto-generated multiple choice questions to reinforce learning
27
+
28
+ Download Report
29
+ Export everything to a PDF or Markdown file for later review
30
+
31
+ πŸ”§ Technologies Used
32
+ Gradio (UI)
33
+
34
+ Google Gemini API (explanation from images + PDFs)
35
+
36
+ Mistral via OpenRouter (text-based science explanations)
37
+
38
+ Stable Diffusion FLUX (diagram generation)
39
+
40
+ PDFPlumber + FPDF (report creation)
41
+
42
+ Hugging Face Spaces (deployment)
43
+
44
+ πŸ” Environment Variables (set under Settings > Secrets)
45
+ Make sure to add the following API keys as secrets in your Space:
46
+
47
+
48
+ GEMINI_API_KEY
49
+ OPENROUTER_API_KEY
50
+ HF_TOKEN
51
+ πŸ“ License
52
+ This project is licensed under the Apache 2.0 License.