Update README.md
Browse files
README.md
CHANGED
|
@@ -11,9 +11,14 @@ license: mit
|
|
| 11 |
|
| 12 |
# ⚛️ H2 Physics Feynman Bot
|
| 13 |
|
| 14 |
-
An AI physics tutor using
|
| 15 |
|
| 16 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 17 |
|
| 18 |
## 🎯 Features
|
| 19 |
|
|
@@ -21,37 +26,60 @@ An AI physics tutor using DeepSeek API with Richard Feynman's teaching style, de
|
|
| 21 |
- 📊 **Graph plotting** - Generates physics graphs with Python
|
| 22 |
- 🖼️ **Diagram search** - Finds relevant physics diagrams
|
| 23 |
- 🗣️ **Text-to-speech** - Reads responses aloud
|
| 24 |
-
-
|
| 25 |
-
|
| 26 |
-
## 🚀 Quick Start
|
| 27 |
-
|
| 28 |
-
1. **Get a DeepSeek API key** from [platform.deepseek.com](https://platform.deepseek.com)
|
| 29 |
-
2. **Enter your API key** in the sidebar
|
| 30 |
-
3. **Select a physics topic** from the dropdown
|
| 31 |
-
4. **Start chatting** with Feynman!
|
| 32 |
|
| 33 |
## 🛠️ Setup on Hugging Face
|
| 34 |
|
| 35 |
-
### Method 1:
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
3. The app will deploy automatically
|
| 40 |
|
| 41 |
### Method 2: Manual Setup
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
4. **Add Secrets** (in Space settings → Settings → Secrets):
|
| 52 |
```yaml
|
| 53 |
DEEPSEEK_API_KEY: "your-deepseek-api-key-here"
|
| 54 |
# Optional for image search:
|
| 55 |
GOOGLE_SEARCH_KEY: "your-google-search-key"
|
| 56 |
GOOGLE_CX: "your-google-cx"
|
| 57 |
-
GOOGLE_SEARCH_KEY_2: "your-google-search-key-2" # optional backup
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 11 |
|
| 12 |
# ⚛️ H2 Physics Feynman Bot
|
| 13 |
|
| 14 |
+
An AI physics tutor using Groq API with Richard Feynman's teaching style, designed for Singapore H2 Physics students.
|
| 15 |
|
| 16 |
+
## 🚀 Quick Start
|
| 17 |
+
|
| 18 |
+
1. **Get a FREE Groq API key** from [console.groq.com](https://console.groq.com)
|
| 19 |
+
2. **Enter your API key** in the sidebar
|
| 20 |
+
3. **Select a physics topic** from the dropdown
|
| 21 |
+
4. **Start chatting** with Feynman!
|
| 22 |
|
| 23 |
## 🎯 Features
|
| 24 |
|
|
|
|
| 26 |
- 📊 **Graph plotting** - Generates physics graphs with Python
|
| 27 |
- 🖼️ **Diagram search** - Finds relevant physics diagrams
|
| 28 |
- 🗣️ **Text-to-speech** - Reads responses aloud
|
| 29 |
+
- ⚡ **Fast responses** - Powered by Groq's LPU technology
|
| 30 |
+
- 🆓 **Free tier** - 10,000 requests/month
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 31 |
|
| 32 |
## 🛠️ Setup on Hugging Face
|
| 33 |
|
| 34 |
+
### Method 1: Quick Deploy
|
| 35 |
+
1. **Fork this Space** (click Fork button)
|
| 36 |
+
2. **Add your Groq API key** in Settings → Secrets:
|
| 37 |
+
3. **Wait for build** (2-5 minutes)
|
|
|
|
| 38 |
|
| 39 |
### Method 2: Manual Setup
|
| 40 |
+
1. **Create new Space** on Hugging Face
|
| 41 |
+
2. **Select "Docker"** as SDK
|
| 42 |
+
3. **Upload files:**
|
| 43 |
+
- `app.py`
|
| 44 |
+
- `Dockerfile`
|
| 45 |
+
- `requirements.txt`
|
| 46 |
+
- `README.md` (this file)
|
| 47 |
+
4. **Add API key** as Secret
|
| 48 |
+
**Add Secrets** (in Space settings → Settings → Secrets):
|
|
|
|
| 49 |
```yaml
|
| 50 |
DEEPSEEK_API_KEY: "your-deepseek-api-key-here"
|
| 51 |
# Optional for image search:
|
| 52 |
GOOGLE_SEARCH_KEY: "your-google-search-key"
|
| 53 |
GOOGLE_CX: "your-google-cx"
|
| 54 |
+
GOOGLE_SEARCH_KEY_2: "your-google-search-key-2" # optional backup
|
| 55 |
+
5. **Wait for build**
|
| 56 |
+
|
| 57 |
+
## 📚 Topics Covered
|
| 58 |
+
Based on Singapore H2 Physics (9478) Syllabus)
|
| 59 |
+
Based on Singapore H2 Physics (9478) Syllabus:
|
| 60 |
+
|
| 61 |
+
Measurement & Uncertainty
|
| 62 |
+
|
| 63 |
+
Kinematics & Dynamics
|
| 64 |
+
|
| 65 |
+
Forces & Turning Effects
|
| 66 |
+
|
| 67 |
+
Work, Energy, Power
|
| 68 |
+
|
| 69 |
+
Circular Motion
|
| 70 |
+
|
| 71 |
+
Gravitational Fields
|
| 72 |
+
|
| 73 |
+
Thermal Physics
|
| 74 |
+
|
| 75 |
+
Oscillations & Waves
|
| 76 |
+
|
| 77 |
+
Electricity & DC Circuits
|
| 78 |
+
|
| 79 |
+
Electromagnetism (EMI/AC)
|
| 80 |
+
|
| 81 |
+
Modern Physics (Quantum/Nuclear)
|
| 82 |
+
|
| 83 |
+
Paper 4: Practical Skills
|
| 84 |
+
|
| 85 |
+
|