Spaces:
Sleeping
Sleeping
updated project files
Browse files
README.md
CHANGED
@@ -19,62 +19,44 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
|
|
19 |
# π LearnFlow Agent
|
20 |
|
21 |
### Your Smart Educational Guide for Personalized Learning Paths π§ π
|
22 |
-
|
23 |
---
|
24 |
-
|
25 |
## π― What is LearnFlow Agent?
|
26 |
|
27 |
**LearnFlow Agent** is an intelligent, conversational tool that helps you figure out *what to learn next* β tailored precisely to your **age**, **background**, and **interests**.
|
28 |
|
29 |
Powered by advanced language models and a sleek Gradio interface, it delivers a **personalized study roadmap**, helpful explanations, beginner resources, and even custom questions to test your understanding.
|
30 |
-
|
31 |
---
|
32 |
-
|
33 |
## π Key Objectives
|
34 |
|
35 |
LearnFlow Agent is built to **empower learners** by:
|
36 |
-
|
37 |
* π **Creating Personalized Learning Plans**
|
38 |
Customized to match your educational background and interests.
|
39 |
-
|
40 |
* π§ **Clarifying Why It Matters**
|
41 |
Get a clear reason behind every suggested topic and how it helps *you*.
|
42 |
-
|
43 |
* π **Recommending Actionable Resources**
|
44 |
Handpicked beginner-friendly content like courses, videos, and books.
|
45 |
-
|
46 |
* π§© **Ensuring You Understand**
|
47 |
Test yourself with grasp-check questions based on your learning path.
|
48 |
-
|
49 |
---
|
50 |
-
|
51 |
## π What You Get
|
52 |
|
53 |
### πΊοΈ **Personalized Study Workflow**
|
54 |
-
|
55 |
Generates a structured roadmap (`study_workflow`) with 3β5 main topics and their subtopics, progressing from beginner β advanced.
|
56 |
|
57 |
### π§ **Meaningful Reasoning + Outcomes**
|
58 |
-
|
59 |
Clearly explains:
|
60 |
-
|
61 |
* Why this learning path fits *you*
|
62 |
* What youβll be able to do after completing it
|
63 |
|
64 |
### π **Beginner-Friendly Resources**
|
65 |
-
|
66 |
Includes 2β3 handpicked materials (YouTube, MOOCs, docs) to help you get started confidently.
|
67 |
|
68 |
### β **Grasp Check Questions**
|
69 |
-
|
70 |
Provides 5β10 custom questions to assess your comprehension along the way.
|
71 |
|
72 |
### π **Visual Mermaid Diagram**
|
73 |
-
|
74 |
Automatically turns your learning roadmap into an interactive diagram for visual learners.
|
75 |
-
|
76 |
---
|
77 |
-
|
78 |
## π Integrations & Stack
|
79 |
|
80 |
| Component | Description |
|
@@ -89,81 +71,54 @@ Automatically turns your learning roadmap into an interactive diagram for visual
|
|
89 |
## π How It Works
|
90 |
|
91 |
### 1οΈβ£ User Input
|
92 |
-
|
93 |
You enter your **age**, **background**, and **interests** via a friendly Gradio form.
|
94 |
|
95 |
### 2οΈβ£ Study Plan Generation
|
96 |
-
|
97 |
A powerful LLM processes your input and returns:
|
98 |
-
|
99 |
* A detailed **study\_workflow**
|
100 |
* A tailored **reason** and **expected outcome**
|
101 |
* Curated **resources**
|
102 |
|
103 |
### 3οΈβ£ Visual Diagram
|
104 |
-
|
105 |
The study plan is rendered as a clean **Mermaid diagram** to help you visualize your learning journey.
|
106 |
|
107 |
### 4οΈβ£ Feedback Loop
|
108 |
-
|
109 |
Want changes? Provide feedback and get an updated plan instantly.
|
110 |
|
111 |
### 5οΈβ£ Resources & Comprehension
|
112 |
-
|
113 |
Alongside your study path, receive:
|
114 |
-
|
115 |
* π Beginner resources
|
116 |
* β Smart grasp-check questions to reinforce your learning
|
117 |
-
|
118 |
---
|
119 |
-
|
120 |
## π‘ Example Outputs
|
121 |
-
|
122 |
* π **Study Workflow:** `"Python Basics β NumPy β Pandas β Visualization"`
|
123 |
* π¬ **Reason:** βThis path introduces you to practical tools for data analysis using your interest in numbers.β
|
124 |
* π― **Outcome:** βBy the end, you'll be able to clean, analyze, and visualize real datasets using Python.β
|
125 |
* π **Resources:** CS50, freeCodeCamp, Kaggle
|
126 |
* β
**Questions:** What is a DataFrame? What does `axis=1` mean in Pandas?
|
127 |
-
|
128 |
---
|
129 |
-
|
130 |
## π€ Who Is This For?
|
131 |
-
|
132 |
Whether you're:
|
133 |
-
|
134 |
* A **student** exploring tech,
|
135 |
* A **career switcher** entering data or programming,
|
136 |
* A **hobbyist** wanting structure in your learning journeyβ¦
|
137 |
-
|
138 |
**LearnFlow Agent** is here to guide you with confidence and clarity. π
|
139 |
-
|
140 |
---
|
141 |
-
|
142 |
## π§ͺ Future Features (Coming Soon!)
|
143 |
-
|
144 |
* π Multi-language support
|
145 |
* π§βπ« Tutor Mode with progress tracking
|
146 |
* π Resource bookmark sync
|
147 |
* π§ AI-powered concept explanation on hover
|
148 |
-
|
149 |
---
|
150 |
-
|
151 |
## π οΈ Tech Stack
|
152 |
-
|
153 |
* `Python` + `Gradio` + `Pydantic`
|
154 |
-
* `OpenAI
|
155 |
* `MermaidJS` for diagrams
|
156 |
-
|
157 |
---
|
158 |
-
|
159 |
## π License
|
160 |
-
|
161 |
MIT License
|
162 |
-
|
163 |
---
|
164 |
-
|
165 |
## π Contribute
|
166 |
-
|
167 |
Have ideas? Found a bug? PRs and feedback are welcome. Let's build better learning tools together. π€
|
168 |
|
169 |
---
|
|
|
19 |
# π LearnFlow Agent
|
20 |
|
21 |
### Your Smart Educational Guide for Personalized Learning Paths π§ π
|
|
|
22 |
---
|
|
|
23 |
## π― What is LearnFlow Agent?
|
24 |
|
25 |
**LearnFlow Agent** is an intelligent, conversational tool that helps you figure out *what to learn next* β tailored precisely to your **age**, **background**, and **interests**.
|
26 |
|
27 |
Powered by advanced language models and a sleek Gradio interface, it delivers a **personalized study roadmap**, helpful explanations, beginner resources, and even custom questions to test your understanding.
|
|
|
28 |
---
|
|
|
29 |
## π Key Objectives
|
30 |
|
31 |
LearnFlow Agent is built to **empower learners** by:
|
|
|
32 |
* π **Creating Personalized Learning Plans**
|
33 |
Customized to match your educational background and interests.
|
|
|
34 |
* π§ **Clarifying Why It Matters**
|
35 |
Get a clear reason behind every suggested topic and how it helps *you*.
|
|
|
36 |
* π **Recommending Actionable Resources**
|
37 |
Handpicked beginner-friendly content like courses, videos, and books.
|
|
|
38 |
* π§© **Ensuring You Understand**
|
39 |
Test yourself with grasp-check questions based on your learning path.
|
|
|
40 |
---
|
|
|
41 |
## π What You Get
|
42 |
|
43 |
### πΊοΈ **Personalized Study Workflow**
|
|
|
44 |
Generates a structured roadmap (`study_workflow`) with 3β5 main topics and their subtopics, progressing from beginner β advanced.
|
45 |
|
46 |
### π§ **Meaningful Reasoning + Outcomes**
|
|
|
47 |
Clearly explains:
|
|
|
48 |
* Why this learning path fits *you*
|
49 |
* What youβll be able to do after completing it
|
50 |
|
51 |
### π **Beginner-Friendly Resources**
|
|
|
52 |
Includes 2β3 handpicked materials (YouTube, MOOCs, docs) to help you get started confidently.
|
53 |
|
54 |
### β **Grasp Check Questions**
|
|
|
55 |
Provides 5β10 custom questions to assess your comprehension along the way.
|
56 |
|
57 |
### π **Visual Mermaid Diagram**
|
|
|
58 |
Automatically turns your learning roadmap into an interactive diagram for visual learners.
|
|
|
59 |
---
|
|
|
60 |
## π Integrations & Stack
|
61 |
|
62 |
| Component | Description |
|
|
|
71 |
## π How It Works
|
72 |
|
73 |
### 1οΈβ£ User Input
|
|
|
74 |
You enter your **age**, **background**, and **interests** via a friendly Gradio form.
|
75 |
|
76 |
### 2οΈβ£ Study Plan Generation
|
|
|
77 |
A powerful LLM processes your input and returns:
|
|
|
78 |
* A detailed **study\_workflow**
|
79 |
* A tailored **reason** and **expected outcome**
|
80 |
* Curated **resources**
|
81 |
|
82 |
### 3οΈβ£ Visual Diagram
|
|
|
83 |
The study plan is rendered as a clean **Mermaid diagram** to help you visualize your learning journey.
|
84 |
|
85 |
### 4οΈβ£ Feedback Loop
|
|
|
86 |
Want changes? Provide feedback and get an updated plan instantly.
|
87 |
|
88 |
### 5οΈβ£ Resources & Comprehension
|
|
|
89 |
Alongside your study path, receive:
|
|
|
90 |
* π Beginner resources
|
91 |
* β Smart grasp-check questions to reinforce your learning
|
|
|
92 |
---
|
|
|
93 |
## π‘ Example Outputs
|
|
|
94 |
* π **Study Workflow:** `"Python Basics β NumPy β Pandas β Visualization"`
|
95 |
* π¬ **Reason:** βThis path introduces you to practical tools for data analysis using your interest in numbers.β
|
96 |
* π― **Outcome:** βBy the end, you'll be able to clean, analyze, and visualize real datasets using Python.β
|
97 |
* π **Resources:** CS50, freeCodeCamp, Kaggle
|
98 |
* β
**Questions:** What is a DataFrame? What does `axis=1` mean in Pandas?
|
|
|
99 |
---
|
|
|
100 |
## π€ Who Is This For?
|
|
|
101 |
Whether you're:
|
|
|
102 |
* A **student** exploring tech,
|
103 |
* A **career switcher** entering data or programming,
|
104 |
* A **hobbyist** wanting structure in your learning journeyβ¦
|
|
|
105 |
**LearnFlow Agent** is here to guide you with confidence and clarity. π
|
|
|
106 |
---
|
|
|
107 |
## π§ͺ Future Features (Coming Soon!)
|
|
|
108 |
* π Multi-language support
|
109 |
* π§βπ« Tutor Mode with progress tracking
|
110 |
* π Resource bookmark sync
|
111 |
* π§ AI-powered concept explanation on hover
|
|
|
112 |
---
|
|
|
113 |
## π οΈ Tech Stack
|
|
|
114 |
* `Python` + `Gradio` + `Pydantic`
|
115 |
+
* `OpenAI` + `SambaNova`
|
116 |
* `MermaidJS` for diagrams
|
|
|
117 |
---
|
|
|
118 |
## π License
|
|
|
119 |
MIT License
|
|
|
120 |
---
|
|
|
121 |
## π Contribute
|
|
|
122 |
Have ideas? Found a bug? PRs and feedback are welcome. Let's build better learning tools together. π€
|
123 |
|
124 |
---
|