Skip to content

Joun12/Student-Eduction-Portal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🎓 AI Education Assistant

An intelligent, AI-powered education system built with Streamlit that helps students learn without a teacher. This system provides personalized guidance, explanations, and interactive learning experiences using state-of-the-art Hugging Face models.

✨ Features

🧠 AI-Powered Learning

  • Adaptive Explanations: Tailored content based on student's academic level (school, college, university)
  • Real-time Chat Interface: Interactive conversation with AI tutor
  • Smart Response Generation: Uses Hugging Face models for natural language understanding
  • Context-Aware Learning: Remembers conversation history and adapts explanations

🎯 Personalized Learning Experience

  • Student Profile Management: Track academic level, subjects of interest, and learning goals
  • Progress Tracking: Visual progress indicators for each topic
  • Adaptive Difficulty: Adjusts complexity based on student understanding
  • Learning Paths: Structured approach to mastering topics

🛠️ Interactive Learning Tools

  • Interactive Quizzes: Test understanding with adaptive questions
  • Real-time Feedback: Immediate explanations for correct/incorrect answers
  • Learning Modes: Deep dive, quick review, and practice modes
  • Topic Suggestions: Popular subjects and trending topics

📚 Subject Coverage

  • Mathematics, Physics, Chemistry, Biology
  • History, Literature, Computer Science, Economics
  • And many more academic subjects

🚀 Installation

Prerequisites

  • Python 3.8 or higher
  • pip package manager
  • Internet connection (for downloading AI models)

Step 1: Clone the Repository

git clone <repository-url>
cd student-portal

Step 2: Install Dependencies

pip install -r requirements.txt

Step 3: Run the Application

streamlit run app.py

The application will open in your default web browser at http://localhost:8501

🔧 Configuration

AI Models

The system automatically downloads and loads the following Hugging Face models:

  • DialoGPT-medium: For natural conversation and explanations
  • RoBERTa-base: For question answering
  • BART-large-CNN: For text summarization
  • DistilBERT: For text classification

First Run

  • On first launch, click "Load AI Models" in the sidebar
  • Models will be downloaded automatically (may take several minutes)
  • Subsequent runs will be faster as models are cached locally

📖 Usage Guide

1. Student Profile Setup

  • Enter your name and academic level
  • Select subjects of interest
  • Set learning goals
  • Click "Update Profile" to save

2. Starting a Learning Session

  • Ask Questions: Type questions like "Explain photosynthesis" or "What is quantum physics?"
  • Start New Topics: Use the "Start New Topic" button for structured learning
  • Popular Topics: Click on suggested topics for quick access

3. Interactive Learning

  • Chat Interface: Ask follow-up questions for deeper understanding
  • Practice Quizzes: Test your knowledge with interactive questions
  • Learning Modes: Choose between deep dive, quick review, or practice modes

4. Progress Tracking

  • Monitor learning progress in the sidebar
  • View topic completion percentages
  • Track conversation history

🎨 Customization

Adding New Subjects

Edit the popular_topics list in app.py:

popular_topics = ["Mathematics", "Physics", "Chemistry", "Biology", "History", "Literature", "Your Subject"]

Modifying AI Models

Change model configurations in the load_models() method:

self.model = AutoModelForCausalLM.from_pretrained("your-preferred-model")

Customizing Explanations

Modify the generate_explanation() method to include subject-specific content and examples.

🔍 Troubleshooting

Common Issues

Models Not Loading

  • Check internet connection
  • Ensure sufficient disk space (models can be several GB)
  • Try restarting the application

Memory Issues

  • Close other applications to free up RAM
  • Consider using smaller models for lower-end systems

Import Errors

  • Verify all dependencies are installed: pip install -r requirements.txt
  • Check Python version compatibility

Performance Optimization

  • Use GPU acceleration if available (requires CUDA-compatible PyTorch)
  • Adjust model sizes based on system capabilities
  • Enable model caching for faster subsequent runs

🏗️ Architecture

Core Components

  1. AIEducationAssistant Class: Main AI logic and model management
  2. Streamlit Interface: User interface and interaction handling
  3. Session Management: State persistence and user data
  4. Model Pipeline: Hugging Face transformers integration

Data Flow

User Input → AI Processing → Response Generation → UI Update → Progress Tracking

🤝 Contributing

We welcome contributions! Please feel free to:

  • Report bugs and issues
  • Suggest new features
  • Submit pull requests
  • Improve documentation

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Hugging Face: For providing excellent pre-trained models
  • Streamlit: For the amazing web app framework
  • Open Source Community: For continuous improvements and support

📞 Support

If you need help or have questions:

  • Check the troubleshooting section above
  • Review the code comments for implementation details
  • Open an issue on the repository

Happy Learning! 🎓✨

Built with ❤️ using Streamlit and Hugging Face Transformers

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published