LearnFlow / README.md
subham73's picture
updated project files
8eb49da
|
raw
history blame
4.71 kB
metadata
title: LearnFlow
emoji: πŸ“š
colorFrom: red
colorTo: red
sdk: gradio
sdk_version: 5.33.1
app_file: app.py
pinned: true
license: mit
short_description: Imagine having a smart educational guide right at your side.

Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference


πŸ“‘ LearnFlow Agent

Your Smart Educational Guide for Personalized Learning Paths πŸ§ πŸ“š


🎯 What is LearnFlow Agent?

LearnFlow Agent is an intelligent, conversational tool that helps you figure out what to learn next β€” tailored precisely to your age, background, and interests.

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.

πŸš€ Key Objectives

LearnFlow Agent is built to empower learners by: * πŸŽ“ Creating Personalized Learning Plans Customized to match your educational background and interests. * 🧭 Clarifying Why It Matters Get a clear reason behind every suggested topic and how it helps you. * πŸ“š Recommending Actionable Resources Handpicked beginner-friendly content like courses, videos, and books. * 🧩 Ensuring You Understand Test yourself with grasp-check questions based on your learning path.

πŸ”‘ What You Get

πŸ—ΊοΈ Personalized Study Workflow

Generates a structured roadmap (study_workflow) with 3–5 main topics and their subtopics, progressing from beginner ➝ advanced.

🧠 Meaningful Reasoning + Outcomes

Clearly explains:

  • Why this learning path fits you
  • What you’ll be able to do after completing it

πŸ“˜ Beginner-Friendly Resources

Includes 2–3 handpicked materials (YouTube, MOOCs, docs) to help you get started confidently.

❓ Grasp Check Questions

Provides 5–10 custom questions to assess your comprehension along the way.

πŸ“Š Visual Mermaid Diagram

Automatically turns your learning roadmap into an interactive diagram for visual learners.

πŸ”Œ Integrations & Stack

Component Description
🧠 Language Model Uses models like Meta-Llama-3.1-405B-Instruct to generate responses
🧱 Pydantic Validation Enforces JSON structure for consistency using StudyPlan, GraspCheck
πŸ’‘ Gradio Interface Simple, modern UI for input/output, diagrams, and feedback
πŸ“ˆ MermaidJS Converts study workflows into clear visual diagrams

πŸ” How It Works

1️⃣ User Input

You enter your age, background, and interests via a friendly Gradio form.

2️⃣ Study Plan Generation

A powerful LLM processes your input and returns:

  • A detailed study_workflow
  • A tailored reason and expected outcome
  • Curated resources

3️⃣ Visual Diagram

The study plan is rendered as a clean Mermaid diagram to help you visualize your learning journey.

4️⃣ Feedback Loop

Want changes? Provide feedback and get an updated plan instantly.

5️⃣ Resources & Comprehension

Alongside your study path, receive: * πŸ“š Beginner resources * ❓ Smart grasp-check questions to reinforce your learning

πŸ’‘ Example Outputs

  • πŸ“– Study Workflow: "Python Basics ➝ NumPy ➝ Pandas ➝ Visualization"
  • πŸ’¬ Reason: β€œThis path introduces you to practical tools for data analysis using your interest in numbers.”
  • 🎯 Outcome: β€œBy the end, you'll be able to clean, analyze, and visualize real datasets using Python.”
  • πŸ“˜ Resources: CS50, freeCodeCamp, Kaggle
  • βœ… Questions: What is a DataFrame? What does axis=1 mean in Pandas?

πŸ‘€ Who Is This For?

Whether you're: * A student exploring tech, * A career switcher entering data or programming, * A hobbyist wanting structure in your learning journey… LearnFlow Agent is here to guide you with confidence and clarity. 🌟

πŸ§ͺ Future Features (Coming Soon!)

  • 🌍 Multi-language support
  • πŸ§‘β€πŸ« Tutor Mode with progress tracking
  • πŸ”— Resource bookmark sync
  • 🧠 AI-powered concept explanation on hover

πŸ› οΈ Tech Stack

  • Python + Gradio + Pydantic
  • OpenAI + SambaNova
  • MermaidJS for diagrams

πŸ“Ž License

MIT License

πŸ™Œ Contribute

Have ideas? Found a bug? PRs and feedback are welcome. Let's build better learning tools together. 🀝