Yaswanth123 commited on
Commit
f5736a4
·
verified ·
1 Parent(s): b08aea7

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +22 -12
README.md CHANGED
@@ -2,7 +2,7 @@
2
  # AI Tutor Project
3
 
4
 
5
- A personalized AI learning assistant that **helps** to accelerate individual learning.
6
  ---
7
 
8
  **Table of Contents**
@@ -14,8 +14,7 @@ A personalized AI learning assistant that **helps** to accelerate individual lea
14
  * [Core Components](#core-components)
15
  * [Effective Use Cases & Tips](#effective-use-cases--tips)
16
  * [Future Improvements](#future-improvements)
17
- * [Contributing](#contributing)
18
- * [License](#license)
19
 
20
  ---
21
 
@@ -39,14 +38,19 @@ Traditional Large Language Models (LLMs) are incredibly knowledgeable but can so
39
  * Designed for topics requiring deep thinking and understanding.
40
 
41
  ## How It Works (The Gist)
 
 
 
 
 
 
 
42
 
43
- The AI Tutor operates through a workflow involving several key steps:
44
- 1. **Conversation Manager:** Talks with you to understand *what* you want to learn and *why* you want to learn.It **takes** summaries of resources you **provide** and **negotiates** the syllabus with you.You **can** modify it after the syllabus **is generated**.
45
- 2. **Syllabus Generator:** Based on your conversation and resources, it creates a structured learning plan.
46
- 3. **Persona Prompt Generator:** Helps define the "personality" and teaching style of the Explainer Agent. You guide this by describing how you want to be taught. This is the single most important step.
47
- 4. **Explainer Agent:** This is the AI that actually teaches you, following the generated syllabus and adopting the defined persona.
48
 
49
- You can start a new chat to redefine the syllabus or persona if needed.
 
50
 
51
 
52
  ## A Deeper Dive: How AI Tutor Works
@@ -61,11 +65,14 @@ This project tackles these issues through a structured workflow:
61
  ### Core Components
62
 
63
  1. **Conversation Manager (`Convo Manager`)**
 
 
64
  * **Role:** Interacts with the user to understand their learning goals: *what* they want to learn, *why* (optional), and how (teaching style preferences. The "how" is **further refined** by the Persona Prompt Generator).
65
  * **Resource Handling:** If resources are provided, it generates an initial summary.
66
  * **Control Flow:** Manages the conversation flow, asking clarifying questions (temperature can be adjusted to reduce chattiness) and producing tags (e.g., generate , modify , finalize , persona) to trigger subsequent agents like the Syllabus Generator and Persona Generator.
67
 
68
- 2. **Syllabus Generator**
 
69
  * **Input:** User's learning objectives (from Convo Manager) and any provided resources.
70
  * **Process:**
71
  * **No Resources:** Uses a specific prompt to generate a syllabus from scratch.
@@ -73,7 +80,8 @@ This project tackles these issues through a structured workflow:
73
  * *(Note: Performance with heavy resources can be enhanced with more powerful models or paid tiers by tweaking code in orchestrator & Dynamic Resource Generation.)*
74
  * **Output:** A structured syllabus, which the user can then ask to modify.
75
 
76
- 3. **Persona Prompt Generator**
 
77
  * **Trigger:** Activates after the syllabus is finalized.
78
  * **Goal:** Defines the teaching style and "personality" of the Explainer Agent. This is a critical step for an effective learning experience.
79
  * **User Input:** The user describes how they want to be taught.
@@ -82,7 +90,8 @@ This project tackles these issues through a structured workflow:
82
  * **Output:** A system prompt for the Explainer Agent, generated by `PersonaPromptBodyPredictSignature` based on chat history and the user's persona description.
83
  * *(Note: A good persona prompt is key. A generic one often leads to a subpar learning experience.)*
84
 
85
- 4. **Explainer Agent**
 
86
  * **Input:** The system prompt (syllabus + persona) generated previously.
87
  * **Role:** Greets the user and begins teaching according to the syllabus and defined persona.
88
  * **Features:** Renders code and mathematical formulas correctly.
@@ -124,4 +133,5 @@ app_file: app.py
124
  pinned: false
125
  license: mit
126
  short_description: Your personal learning plan architect.
 
127
 
 
2
  # AI Tutor Project
3
 
4
 
5
+ "A personalized AI learning assistant that designs your learning plan with you, then tutors you through it."
6
  ---
7
 
8
  **Table of Contents**
 
14
  * [Core Components](#core-components)
15
  * [Effective Use Cases & Tips](#effective-use-cases--tips)
16
  * [Future Improvements](#future-improvements)
17
+
 
18
 
19
  ---
20
 
 
38
  * Designed for topics requiring deep thinking and understanding.
39
 
40
  ## How It Works (The Gist)
41
+ The AI Tutor guides you from a broad idea to a focused learning session in four simple steps:
42
+
43
+ 1. **Plan Your Lessons**
44
+ Start by chatting with the AI to define your learning goals. It can even process documents you provide (like PDFs or articles) to understand the context of what you want to master.
45
+
46
+ 2. **Refine Your Roadmap**
47
+ The system then drafts a structured syllabus tailored to your conversation. You have full control to review, modify, and finalize this plan until it perfectly matches your needs.
48
 
49
+ 3. **Choose Your Teacher**
50
+ Once your plan is locked in, you describe your ideal teaching style. Want a demanding professor who uses the Socratic method? A friendly peer who explains with analogies? You define the persona.
 
 
 
51
 
52
+ 4. **Start Learning**
53
+ A custom AI tutor comes to life, ready to teach you based on *your* syllabus and in *your* preferred style, complete with proper formatting for code and math.
54
 
55
 
56
  ## A Deeper Dive: How AI Tutor Works
 
65
  ### Core Components
66
 
67
  1. **Conversation Manager (`Convo Manager`)**
68
+
69
+ * **Key Responsibility:** Manages the initial dialogue to define user goals and control the workflow
70
  * **Role:** Interacts with the user to understand their learning goals: *what* they want to learn, *why* (optional), and how (teaching style preferences. The "how" is **further refined** by the Persona Prompt Generator).
71
  * **Resource Handling:** If resources are provided, it generates an initial summary.
72
  * **Control Flow:** Manages the conversation flow, asking clarifying questions (temperature can be adjusted to reduce chattiness) and producing tags (e.g., generate , modify , finalize , persona) to trigger subsequent agents like the Syllabus Generator and Persona Generator.
73
 
74
+ 3. **Syllabus Generator**
75
+ * **Key Responsibility:** Generates a structured learning plan from the user's goals and provided resources.
76
  * **Input:** User's learning objectives (from Convo Manager) and any provided resources.
77
  * **Process:**
78
  * **No Resources:** Uses a specific prompt to generate a syllabus from scratch.
 
80
  * *(Note: Performance with heavy resources can be enhanced with more powerful models or paid tiers by tweaking code in orchestrator & Dynamic Resource Generation.)*
81
  * **Output:** A structured syllabus, which the user can then ask to modify.
82
 
83
+ 5. **Persona Prompt Generator**
84
+ * **Key Responsibility:** Crafts the detailed system prompt that defines the AI tutor's personality and teaching methodology.
85
  * **Trigger:** Activates after the syllabus is finalized.
86
  * **Goal:** Defines the teaching style and "personality" of the Explainer Agent. This is a critical step for an effective learning experience.
87
  * **User Input:** The user describes how they want to be taught.
 
90
  * **Output:** A system prompt for the Explainer Agent, generated by `PersonaPromptBodyPredictSignature` based on chat history and the user's persona description.
91
  * *(Note: A good persona prompt is key. A generic one often leads to a subpar learning experience.)*
92
 
93
+ 7. **Explainer Agent**
94
+ * **Key Responsibility:** Acts as the final AI tutor, executing the teaching session based on the finalized syllabus and persona.
95
  * **Input:** The system prompt (syllabus + persona) generated previously.
96
  * **Role:** Greets the user and begins teaching according to the syllabus and defined persona.
97
  * **Features:** Renders code and mathematical formulas correctly.
 
133
  pinned: false
134
  license: mit
135
  short_description: Your personal learning plan architect.
136
+ ---
137