ContextQMD
Back to Cs249r Book

SocratiQ AI Learning Companion

book/socratiQ/README.md

latest4.9 KB
Original Source

SocratiQ AI Learning Companion

** NOTE: SocratiQ will be open sourced soon

Welcome to SocratiQ (pronounced "Socratic"), an AI learning assistant seamlessly integrated throughout this resource. Inspired by the Socratic method of teaching—emphasizing thoughtful questions and answers to stimulate critical thinking—SocratiQ is part of our experiment with what we call Generative Learning. By combining interactive quizzes, personalized assistance, and real-time feedback, SocratiQ is meant to reinforce your understanding and help you create new connections.

About This Repository

Important Note: This repository contains the SocratiQ integration for this specific book/resource.

  • Full Widget Code: The complete SocratiQ widget codebase will be open-sourced in its own dedicated GitHub repository in the future.
  • Book-Specific Version: The source code version specifically used for this book will be placed in this directory in the future.
  • Stay Tuned: Please check back for updates as we continue to develop and release the codebase.

What is SocratiQ?

SocratiQ is an AI-powered learning companion designed to provide an interactive, personalized learning experience. Unlike traditional textbook study, SocratiQ offers:

  • Interactive Quizzes: AI-generated quizzes tailored to reinforce key concepts
  • Personalized Assistance: Context-aware explanations and help with challenging concepts
  • Real-time Feedback: Immediate responses and detailed explanations
  • Progress Tracking: Comprehensive dashboard with statistics, streaks, and achievement badges
  • Adaptive Learning: Content tailored to your academic level

Features

Quick Access

  • Keyboard Shortcut: Press Cmd/Ctrl + / to open SocratiQ anytime
  • URL Parameters: Control SocratiQ via URL:
    • Activate: ?socratiq=true
    • Deactivate: ?socratiq=false

Learning Features

1. AI-Generated Quizzes

  • Automatically generated at the end of major subsections
  • Typically 3-5 multiple-choice questions per quiz
  • Takes 1-2 minutes to complete
  • Immediate feedback with detailed explanations

2. Concept Assistance

  • Select any text from the textbook and ask for explanations
  • Reference sections, subsections, and keywords using @ symbol
  • Get suggestions for related content from the textbook
  • Adjust difficulty level of AI responses

3. Progress Tracking

  • Performance dashboard with quiz statistics
  • Learning streaks tracking
  • Achievement badges system:
    • 🎯 First Steps: Complete your first quiz
    • 🔢 On a Streak: Maintain a streak of perfect scores
    • 🏆 Quiz Medalist: Complete 10 quizzes
    • 🏆🏆 Quiz Champion: Complete 20 quizzes
    • 🏆🏆🏆 Quiz Legend: Complete 30 quizzes
    • 🏆🏆🏆🏆 x n Quiz AGI Super Human: Complete 40+ quizzes
  • PDF report generation with unique hash validation

4. Personalization

  • Set your academic level in Settings
  • Customize AI response difficulty
  • Save and load conversations

Technical Requirements

To use SocratiQ effectively, you'll need:

  • Chrome or Safari browser
  • JavaScript enabled
  • Stable internet connection

Data Storage

Important: All progress data is stored locally in your browser. Clearing your browser history or cache will erase your entire learning history, including quiz scores, streaks, and achievement badges.

Common Issues and Troubleshooting

  • SocratiQ isn't responding: Refresh the page
  • Quizzes don't load: Check your internet connection
  • Progress isn't saving: Ensure cookies are enabled

For persistent issues, please contact: vj[@]eecs.harvard.edu

Providing Feedback

Your feedback helps us improve SocratiQ. You can:

  • Report technical issues
  • Suggest improvements to quiz questions
  • Share thoughts about AI responses
  • Submit a GitHub issue

Research and Resources

Warning

About AI Responses: While SocratiQ uses advanced AI to generate quizzes and provide assistance, like all AI systems, it may occasionally provide imperfect or incomplete answers. However, we've designed and tested it to ensure it's effective for supporting your learning journey. If you're unsure about any response, refer to the textbook content or consult your instructor.

Status

SocratiQ is still a work in progress, and we welcome your feedback. This is an experimental feature exploring dynamic and personalized learning experiences through generative AI.

Note: This is an experimental feature. We are experimenting with the idea of creating a dynamic and personalized learning experience by harnessing the power of generative AI. We hope that this approach will transform how you interact with and absorb complex concepts.