Skip to content

mouashmawy/Genie-for-AI-study-Notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Genie-for-AI-Study-Notes

Introduction

Genie-for-AI-Study-Notes is an AI-powered assistant designed to streamline the study process for students. The goal is to help students efficiently manage and understand information from various sources, such as textbooks, PDFs, lecture notes, and online courses.

The AI assistant automatically summarizes complex materials, generates relevant questions, provides answers to specific queries, and highlights areas that need more focus. It optimizes study time, making learning more effective and less overwhelming. Our ultimate vision is to transform how students interact with their study materials, enabling efficient knowledge retention.


Vision

To create a comprehensive AI-powered study assistant that simplifies learning by integrating resources like textbooks, PDFs, and online content into a unified platform. Our tool aims to:

  • Reduce the overwhelm of managing multiple resources.
  • Personalize learning experiences.
  • Optimize study time for students.

What Makes Us Different

  • All-in-One Integration: Handles diverse study formats seamlessly.
  • Personalized Learning: Tailored feedback and recommendations based on individual needs.
  • Active Engagement: Promotes active recall with interactive prompts.
  • Comprehensive Study Companion: From summarization to self-testing, a complete solution.

Technical Approach

  • Backend: Built using Flask for responsive and user-friendly interaction.
  • AI Models: Integrates state-of-the-art NLP models from Hugging Face for summarization, question generation, and answering queries.
  • LangChain: Manages smooth interaction between models and APIs.
  • Retrieval-Augmented Generation (RAG): Ensures contextually relevant outputs.
  • Deployment: Hosted on AWS (EC2 for hosting, S3 for storage) and containerized using Docker for consistency and scalability.

Features

Functional Requirements:

  • User Authentication: Secure account management (signup, login, logout).
  • File Upload: Supports PDFs, DOCX, and TXT formats.
  • Summarization: Generate concise or detailed summaries.
  • Question Generation: Create quizzes for self-assessment.
  • Answering Queries: Accurate responses using NLP models.
  • Highlighting Key Sections: Auto-focus on important areas.
  • Personalized Recommendations: Insights into areas needing improvement.
  • Interactive Flashcards: For spaced repetition learning.
  • Search Functionality: AI-powered content search.
  • Multi-File Integration: Consolidate summaries across multiple documents.
  • Downloadable Summaries: Export summaries as PDF files.

Non-Functional Requirements:

  • Scalability: Supports 10,000+ concurrent users.
  • Performance: AI responses within 2-3 seconds.
  • Security: GDPR-compliant encryption for data.
  • Availability: 99.9% uptime with AWS infrastructure.
  • Usability: Responsive design for desktop and mobile.
  • Extensibility: Future support for additional features like video and audio processing.

User Stories

  • File Management:
    • "As a user, I want to upload multiple files at once to save time."
    • "As a user, I want to view previous versions of uploaded files for restoration."
  • Learning Features:
    • "As a user, I want quizzes that adjust difficulty based on my performance."
    • "As a user, I want flashcards generated for spaced repetition."
  • Accessibility and Convenience:
    • "As a user, I want to study on my mobile device."
    • "As a user with disabilities, I want screen reader support."

For the full list of user stories, please refer to our Issues page.


Challenges and Risks

  • Model Accuracy vs Latency: Balancing accuracy and response time for optimal performance.
  • Data Privacy: Ensuring robust encryption and compliance with privacy standards.

How to Contribute

We welcome contributions from the community! Here's how you can help:

  1. Fork this repository.
  2. Create a branch (git checkout -b feature-branch).
  3. Commit your changes (git commit -m "Add feature").
  4. Push to the branch (git push origin feature-branch).
  5. Open a Pull Request.

Please read our Contribution Guidelines for more details.


License

This project is licensed under the MIT License.


Contact

For questions or suggestions, please open an issue or contact us at eng.yahya.mohamed@gmail.com.

Happy Learning!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •