Spaces:
Sleeping
Sleeping
Commit
Β·
06e084c
1
Parent(s):
6c6a755
docs: Update README with learning modes and new features
Browse files- Added badges for live demo and GitHub
- Updated feature list with all 6 learning modes
- Added links to FEATURES.md and QUICKSTART.md
- Updated API reference with mode, difficulty, persona parameters
- Enhanced quick start section with better formatting
README.md
CHANGED
|
@@ -6,50 +6,46 @@ app_file: app.py
|
|
| 6 |
license: apache-2.0
|
| 7 |
---
|
| 8 |
|
| 9 |
-
#
|
| 10 |
|
| 11 |
-
|
| 12 |
|
| 13 |
-
|
| 14 |
|
| 15 |
-
|
| 16 |
-
-
|
| 17 |
-
- 4-bit quantization for reduced memory usage
|
| 18 |
-
- Interactive command-line interface
|
| 19 |
-
- Configurable generation parameters
|
| 20 |
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
- Python 3.8 or higher
|
| 24 |
-
- PyTorch (will be installed via requirements.txt)
|
| 25 |
-
- CUDA-compatible GPU (recommended) or CPU
|
| 26 |
|
| 27 |
-
##
|
| 28 |
|
| 29 |
-
|
| 30 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 31 |
|
| 32 |
-
|
| 33 |
-
pip install -r requirements.txt
|
| 34 |
-
```
|
| 35 |
|
| 36 |
---
|
| 37 |
-
title: Eidolon
|
| 38 |
-
---
|
| 39 |
-
|
| 40 |
-
# Eidolon β Interactive Tutor Demo
|
| 41 |
-
|
| 42 |
-
Production-ready demo application: a static frontend with a serverless API that accepts prompts and returns adaptive responses. Built for easy deployment to Vercel or Hugging Face Spaces with optional inference backend integration.
|
| 43 |
|
| 44 |
## β¨ Features
|
| 45 |
|
| 46 |
- **Demo Mode**: Safe, deterministic responses for public demos (no API keys or model hosting required)
|
| 47 |
- **External Inference**: Plug in any hosted inference API (Hugging Face, Replicate, custom endpoints)
|
|
|
|
|
|
|
|
|
|
|
|
|
| 48 |
- **Conversation History**: SQLite-backed session storage with history retrieval
|
| 49 |
- **Rate Limiting**: Configurable IP-based rate limiting to prevent abuse
|
| 50 |
-
- **Modern UI**: Interactive interface with example prompts, copy buttons, and loading states
|
| 51 |
- **Retry Logic**: Automatic retries with exponential backoff for inference calls
|
| 52 |
- **CORS Support**: Cross-origin requests enabled for flexible deployment
|
|
|
|
|
|
|
| 53 |
|
| 54 |
## Quick Start (Demo Mode)
|
| 55 |
|
|
@@ -147,12 +143,24 @@ Request body:
|
|
| 147 |
```json
|
| 148 |
{
|
| 149 |
"prompt": "Your question here",
|
|
|
|
|
|
|
|
|
|
| 150 |
"max_tokens": 512,
|
| 151 |
"temperature": 0.7,
|
| 152 |
"session_id": "optional-session-id"
|
| 153 |
}
|
| 154 |
```
|
| 155 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 156 |
Response:
|
| 157 |
```json
|
| 158 |
{
|
|
|
|
| 6 |
license: apache-2.0
|
| 7 |
---
|
| 8 |
|
| 9 |
+
# π§ Eidolon Cognitive Tutor
|
| 10 |
|
| 11 |
+
**Interactive AI Tutor with Multiple Learning Modes, Adaptive Difficulty, and Gamification**
|
| 12 |
|
| 13 |
+
> Learn Anything, Your Way β Personalized, Interactive, Engaging
|
| 14 |
|
| 15 |
+
[](https://huggingface.co/spaces/BonelliLab/Eidolon-CognitiveTutor)
|
| 16 |
+
[](https://github.com/Zwin-ux/Eidolon-Cognitive-Tutor)
|
|
|
|
|
|
|
|
|
|
| 17 |
|
| 18 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
| 19 |
|
| 20 |
+
## π― What Makes This Special?
|
| 21 |
|
| 22 |
+
Not just another chatbot - this is a **complete learning experience** with:
|
| 23 |
+
- π **6 Learning Modes**: Socratic, ELI5, Technical, Analogy, Code, Standard
|
| 24 |
+
- ποΈ **Adaptive Difficulty**: 1-5 scale from Beginner to Expert
|
| 25 |
+
- π **Tutor Personas**: Choose your teacher's personality style
|
| 26 |
+
- π **Gamification**: Achievements, streaks, progress tracking
|
| 27 |
+
- β‘ **Typing Animation**: Smooth character-by-character responses
|
| 28 |
+
- πΎ **Conversation History**: SQLite-backed session storage
|
| 29 |
|
| 30 |
+
**[π See all unique features β](./FEATURES.md)** | **[π Quick Start Guide β](./QUICKSTART.md)**
|
|
|
|
|
|
|
| 31 |
|
| 32 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 33 |
|
| 34 |
## β¨ Features
|
| 35 |
|
| 36 |
- **Demo Mode**: Safe, deterministic responses for public demos (no API keys or model hosting required)
|
| 37 |
- **External Inference**: Plug in any hosted inference API (Hugging Face, Replicate, custom endpoints)
|
| 38 |
+
- **6 Learning Modes**: Standard, Socratic (questions), ELI5 (simple), Technical (deep), Analogy (metaphors), Code (examples)
|
| 39 |
+
- **Adaptive Difficulty**: 1-5 scale with content that scales to your level
|
| 40 |
+
- **Tutor Personas**: Friendly, Strict, Enthusiastic, Professional, Playful
|
| 41 |
+
- **Gamification**: Achievements, learning streaks, progress tracking
|
| 42 |
- **Conversation History**: SQLite-backed session storage with history retrieval
|
| 43 |
- **Rate Limiting**: Configurable IP-based rate limiting to prevent abuse
|
| 44 |
+
- **Modern UI**: Interactive interface with typing animation, example prompts, copy buttons, and loading states
|
| 45 |
- **Retry Logic**: Automatic retries with exponential backoff for inference calls
|
| 46 |
- **CORS Support**: Cross-origin requests enabled for flexible deployment
|
| 47 |
+
- **Prompt Enhancement**: AI-powered suggestions to improve your questions
|
| 48 |
+
- **Mobile Responsive**: Beautiful UI that works on all devices
|
| 49 |
|
| 50 |
## Quick Start (Demo Mode)
|
| 51 |
|
|
|
|
| 143 |
```json
|
| 144 |
{
|
| 145 |
"prompt": "Your question here",
|
| 146 |
+
"mode": "standard",
|
| 147 |
+
"difficulty": 3,
|
| 148 |
+
"persona": "friendly",
|
| 149 |
"max_tokens": 512,
|
| 150 |
"temperature": 0.7,
|
| 151 |
"session_id": "optional-session-id"
|
| 152 |
}
|
| 153 |
```
|
| 154 |
|
| 155 |
+
**Parameters:**
|
| 156 |
+
- `prompt` (string, required): The question or prompt to ask the tutor
|
| 157 |
+
- `mode` (string, optional): Learning mode - `standard`, `socratic`, `eli5`, `technical`, `analogy`, or `code`. Default: `standard`
|
| 158 |
+
- `difficulty` (int, optional): Difficulty level 1-5. Default: `3`
|
| 159 |
+
- `persona` (string, optional): Tutor personality - `friendly`, `strict`, `enthusiastic`, `professional`, or `playful`. Default: `friendly`
|
| 160 |
+
- `max_tokens` (int, optional): Maximum response length. Default: `512`
|
| 161 |
+
- `temperature` (float, optional): Response creativity 0.0-1.0. Default: `0.7`
|
| 162 |
+
- `session_id` (string, optional): Session ID for conversation history
|
| 163 |
+
|
| 164 |
Response:
|
| 165 |
```json
|
| 166 |
{
|