Spaces:
Sleeping
Sleeping
File size: 23,588 Bytes
341ff5d 9ea3d39 341ff5d 9ea3d39 341ff5d 9ea3d39 341ff5d 9ea3d39 341ff5d 9ea3d39 341ff5d 9ea3d39 341ff5d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 | """
MathPulse AI - Event-Driven Automation Engine
Processes educational workflows based on a diagnostic-first, risk-driven
intervention model. Trigger points:
1. Diagnostic Assessment Completion (highest priority)
2. Quiz / Assessment Submission (continuous)
3. New Student Enrollment
4. External Data Import (teacher action)
5. Admin Content Updates
Each event is routed to a dedicated handler that orchestrates
classification, quiz generation, notifications and dashboard updates.
"""
import os
import json
import math
import logging
import traceback
from typing import List, Optional, Dict, Any, Tuple
from datetime import datetime, timedelta
from pydantic import BaseModel, Field
logger = logging.getLogger("mathpulse.automation")
# โโโ Constants โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
AT_RISK_THRESHOLD = 60 # < 60 % โ At Risk
WEAK_TOPIC_THRESHOLD = 0.50 # < 50 % accuracy โ weak topic
HIGH_RISK_RATIO = 0.75 # 75 %+ subjects at risk
MEDIUM_RISK_RATIO = 0.50 # 50-75 %
REMEDIAL_CONFIG = {
"High": {"questions": 15, "dist": {"easy": 60, "medium": 30, "hard": 10}},
"Medium": {"questions": 12, "dist": {"easy": 50, "medium": 35, "hard": 15}},
"Low": {"questions": 10, "dist": {"easy": 40, "medium": 40, "hard": 20}},
}
# โโโ Request / Response Models โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
class DiagnosticResult(BaseModel):
"""Per-subject score from diagnostic assessment."""
subject: str
score: float = Field(..., ge=0, le=100)
class DiagnosticCompletionPayload(BaseModel):
"""Payload sent when a student completes the diagnostic."""
studentId: str
results: List[DiagnosticResult]
gradeLevel: str = "Grade 10"
questionBreakdown: Optional[Dict[str, list]] = None # topic โ [{correct: bool, โฆ}]
class QuizSubmissionPayload(BaseModel):
"""Payload sent on quiz / assessment submission."""
studentId: str
quizId: str
subject: str
score: float = Field(..., ge=0, le=100)
totalQuestions: int
correctAnswers: int
timeSpentSeconds: int
answers: Optional[List[Dict[str, Any]]] = None
class StudentEnrollmentPayload(BaseModel):
"""Payload sent when a new student account is created."""
studentId: str
name: str
email: str
gradeLevel: str = "Grade 10"
teacherId: Optional[str] = None
class DataImportPayload(BaseModel):
"""Payload sent after a teacher uploads a spreadsheet."""
teacherId: str
students: List[Dict[str, Any]] # parsed student rows
columnMapping: Dict[str, str]
class ContentUpdatePayload(BaseModel):
"""Payload sent when admin performs CRUD on curriculum."""
adminId: str
action: str # create | update | delete
contentType: str # lesson | quiz | module | subject
contentId: str
subjectId: Optional[str] = None
details: Optional[str] = None
# โโโ Risk classification helpers โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
class SubjectRiskClassification(BaseModel):
status: str # "At Risk" | "On Track"
score: float
confidence: float
needsIntervention: bool
class AutomationResult(BaseModel):
"""Standardised result returned by every handler."""
success: bool
event: str
studentId: Optional[str] = None
message: str
riskClassifications: Optional[Dict[str, Dict[str, Any]]] = None
overallRisk: Optional[str] = None
atRiskSubjects: Optional[List[str]] = None
weakTopics: Optional[List[Dict[str, Any]]] = None
learningPath: Optional[str] = None
remedialQuizzesCreated: int = 0
interventions: Optional[str] = None
notifications: List[str] = Field(default_factory=list)
# โโโ Automation Engine โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
class MathPulseAutomationEngine:
"""
Stateless event-driven automation system.
Each ``handle_*`` method is an independent, self-contained handler that
receives a validated Pydantic payload and returns an ``AutomationResult``.
Firebase / Hugging Face calls are only attempted when available.
"""
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# 1. DIAGNOSTIC COMPLETION (highest-priority)
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
async def handle_diagnostic_completion(
self, payload: DiagnosticCompletionPayload
) -> AutomationResult:
"""
Runs when a student completes the mandatory diagnostic.
Steps:
1. Classify per-subject risk
2. Identify weak topics
3. Compute overall risk
4. Generate personalised learning path (AI)
5. Create remedial quiz assignments
6. Generate teacher intervention recommendations (AI)
7. Persist everything & notify
"""
student_id = payload.studentId
logger.info(f"๐ DIAGNOSTIC COMPLETED for {student_id}")
notifications: list[str] = []
# 1 โ subject-level risk
risk_classifications = self._classify_subject_risks(payload.results)
# 2 โ weak topics
weak_topics = self._identify_weak_topics(payload.questionBreakdown)
# 3 โ overall risk
overall_risk = self._calculate_overall_risk(risk_classifications)
at_risk_subjects = [
subj for subj, data in risk_classifications.items()
if data["status"] == "At Risk"
]
# 4 โ learning path (AI call)
learning_path: Optional[str] = None
if at_risk_subjects:
learning_path = await self._generate_learning_path(
at_risk_subjects, weak_topics, payload.gradeLevel
)
# 5 โ remedial quizzes
remedial_count = 0
remedial_quizzes: list[dict] = []
if at_risk_subjects:
remedial_quizzes = self._build_remedial_quiz_configs(
student_id, at_risk_subjects, overall_risk, payload.gradeLevel
)
remedial_count = len(remedial_quizzes)
# 6 โ teacher interventions (AI call)
interventions: Optional[str] = None
if at_risk_subjects:
interventions = await self._generate_teacher_interventions(
risk_classifications, weak_topics
)
# 7 โ notification messages
if at_risk_subjects:
notifications.append(
f"Diagnostic complete โ {len(at_risk_subjects)} subject(s) flagged At Risk: "
+ ", ".join(at_risk_subjects)
)
else:
notifications.append("Diagnostic complete โ all subjects On Track!")
logger.info(
f"โ
DIAGNOSTIC PROCESSING COMPLETE for {student_id} | "
f"Overall={overall_risk} | AtRisk={at_risk_subjects}"
)
return AutomationResult(
success=True,
event="diagnostic_completed",
studentId=student_id,
message=f"Diagnostic processed for {student_id}",
riskClassifications=risk_classifications,
overallRisk=overall_risk,
atRiskSubjects=at_risk_subjects,
weakTopics=weak_topics,
learningPath=learning_path,
remedialQuizzesCreated=remedial_count,
interventions=interventions,
notifications=notifications,
)
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# 2. QUIZ SUBMISSION (continuous)
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
async def handle_quiz_submission(
self, payload: QuizSubmissionPayload
) -> AutomationResult:
"""Recalculate risk for a subject after a quiz is submitted."""
student_id = payload.studentId
logger.info(f"๐ QUIZ SUBMITTED by {student_id} โ {payload.subject} ({payload.score}%)")
notifications: list[str] = []
# Determine new status for this subject
new_status = "At Risk" if payload.score < AT_RISK_THRESHOLD else "On Track"
confidence = (
(AT_RISK_THRESHOLD - payload.score) / AT_RISK_THRESHOLD
if new_status == "At Risk"
else (payload.score - AT_RISK_THRESHOLD) / (100 - AT_RISK_THRESHOLD)
)
risk_classifications = {
payload.subject: {
"status": new_status,
"score": payload.score,
"confidence": round(abs(confidence), 2),
"needsIntervention": new_status == "At Risk",
}
}
at_risk = [payload.subject] if new_status == "At Risk" else []
if new_status == "At Risk":
notifications.append(
f"Quiz result: {payload.subject} scored {payload.score}% โ status changed to At Risk"
)
else:
notifications.append(
f"Quiz result: {payload.subject} scored {payload.score}% โ On Track"
)
return AutomationResult(
success=True,
event="quiz_submitted",
studentId=student_id,
message=f"Quiz processed for {student_id}",
riskClassifications=risk_classifications,
overallRisk=None, # single-subject update โ overall recalculated on frontend
atRiskSubjects=at_risk,
notifications=notifications,
)
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# 3. STUDENT ENROLLMENT
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
async def handle_student_enrollment(
self, payload: StudentEnrollmentPayload
) -> AutomationResult:
"""
Prepare a new student:
- Create empty progress record skeleton
- Initialise gamification (XP 0, Level 1, no streaks)
- Flag as needing diagnostic
"""
student_id = payload.studentId
logger.info(f"๐ NEW STUDENT ENROLLED: {student_id}")
progress_skeleton = {
"userId": student_id,
"subjects": {},
"lessons": {},
"quizAttempts": [],
"totalLessonsCompleted": 0,
"totalQuizzesCompleted": 0,
"averageScore": 0,
}
gamification_init = {
"level": 1,
"currentXP": 0,
"totalXP": 0,
"streak": 0,
"hasTakenDiagnostic": False,
"atRiskSubjects": [],
}
notifications: list[str] = [
f"Welcome {payload.name}! Please complete the diagnostic assessment to personalise your learning path.",
]
if payload.teacherId:
notifications.append(
f"New student {payload.name} enrolled โ diagnostic pending."
)
return AutomationResult(
success=True,
event="student_enrolled",
studentId=student_id,
message=f"Student {payload.name} enrolled and initialised",
notifications=notifications,
)
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# 4. DATA IMPORT (teacher action)
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
async def handle_data_import(
self, payload: DataImportPayload
) -> AutomationResult:
"""
After a teacher uploads a spreadsheet, recalculate risk for every
imported student and flag any status changes.
"""
logger.info(f"๐ DATA IMPORT by teacher {payload.teacherId} โ {len(payload.students)} students")
notifications: list[str] = []
newly_at_risk: list[str] = []
for student_row in payload.students:
name = student_row.get("name", "Unknown")
avg_score = float(student_row.get("avgQuizScore", 0))
if avg_score < AT_RISK_THRESHOLD:
newly_at_risk.append(name)
if newly_at_risk:
notifications.append(
f"Data import flagged {len(newly_at_risk)} student(s) as At Risk: "
+ ", ".join(newly_at_risk[:5])
+ ("โฆ" if len(newly_at_risk) > 5 else "")
)
notifications.append(
f"Data import complete โ {len(payload.students)} student records processed."
)
return AutomationResult(
success=True,
event="data_imported",
studentId=None,
message=f"Data import processed for {len(payload.students)} students",
atRiskSubjects=None,
notifications=notifications,
)
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# 5. CONTENT UPDATE (admin action)
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
async def handle_content_update(
self, payload: ContentUpdatePayload
) -> AutomationResult:
"""
After admin CRUD on curriculum, log & notify.
"""
logger.info(
f"๐ CONTENT UPDATE by admin {payload.adminId}: "
f"{payload.action} {payload.contentType} {payload.contentId}"
)
notifications: list[str] = [
f"Curriculum update: {payload.action}d {payload.contentType} "
f"({payload.contentId}). Teachers may want to review affected quizzes.",
]
return AutomationResult(
success=True,
event="content_updated",
studentId=None,
message=f"Content {payload.action} processed for {payload.contentType}",
notifications=notifications,
)
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# INTERNAL HELPERS
# โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
# --- risk classification ---
@staticmethod
def _classify_subject_risks(
results: List[DiagnosticResult],
) -> Dict[str, Dict[str, Any]]:
"""Classify each subject as 'At Risk' or 'On Track'."""
classifications: Dict[str, Dict[str, Any]] = {}
for r in results:
if r.score < AT_RISK_THRESHOLD:
status = "At Risk"
confidence = round((AT_RISK_THRESHOLD - r.score) / AT_RISK_THRESHOLD, 2)
else:
status = "On Track"
confidence = round(
(r.score - AT_RISK_THRESHOLD) / (100 - AT_RISK_THRESHOLD), 2
)
classifications[r.subject] = {
"status": status,
"score": r.score,
"confidence": confidence,
"needsIntervention": status == "At Risk",
}
return classifications
@staticmethod
def _identify_weak_topics(
question_breakdown: Optional[Dict[str, list]],
) -> List[Dict[str, Any]]:
"""
Drill into per-topic accuracy from diagnostic question-level data.
Returns topics sorted weakest-first.
"""
if not question_breakdown:
return []
weak: list[dict] = []
for topic, questions in question_breakdown.items():
if not questions:
continue
correct_count = sum(1 for q in questions if q.get("correct"))
accuracy = correct_count / len(questions)
if accuracy < WEAK_TOPIC_THRESHOLD:
weak.append({
"topic": topic,
"accuracy": round(accuracy, 2),
"questionsAttempted": len(questions),
"priority": "high" if accuracy < 0.3 else "medium",
})
weak.sort(key=lambda x: x["accuracy"])
return weak
@staticmethod
def _calculate_overall_risk(
classifications: Dict[str, Dict[str, Any]],
) -> str:
total = len(classifications)
if total == 0:
return "Low"
at_risk_count = sum(
1 for d in classifications.values() if d["status"] == "At Risk"
)
ratio = at_risk_count / total
if ratio >= HIGH_RISK_RATIO:
return "High"
elif ratio >= MEDIUM_RISK_RATIO:
return "Medium"
return "Low"
# --- remedial quiz configs ---
@staticmethod
def _build_remedial_quiz_configs(
student_id: str,
at_risk_subjects: List[str],
overall_risk: str,
grade_level: str,
) -> List[Dict[str, Any]]:
"""Return list of quiz configuration dicts ready for persistence."""
cfg = REMEDIAL_CONFIG.get(overall_risk, REMEDIAL_CONFIG["Low"])
quizzes: list[dict] = []
for subject in at_risk_subjects:
quizzes.append({
"studentId": student_id,
"subject": subject,
"quizConfig": {
"topics": [subject],
"gradeLevel": grade_level,
"numQuestions": cfg["questions"],
"questionTypes": [
"identification",
"enumeration",
"multiple_choice",
"word_problem",
],
"difficultyDistribution": cfg["dist"],
"bloomLevels": ["remember", "understand", "apply"],
"includeGraphs": False,
"excludeTopics": [],
"purpose": "remedial",
"targetStudent": student_id,
},
"status": "pending",
"autoGenerated": True,
"reason": f'Diagnostic identified "{subject}" as At Risk',
"priority": "high" if overall_risk == "High" else "medium",
"dueInDays": 7,
})
return quizzes
# --- AI helpers (Hugging Face) ---
async def _generate_learning_path(
self,
at_risk_subjects: List[str],
weak_topics: List[Dict[str, Any]],
grade_level: str,
) -> Optional[str]:
"""Generate a personalised learning path via HF Serverless Inference."""
try:
from main import call_hf_chat
weakness_lines = ", ".join(at_risk_subjects)
topic_lines = "\n".join(
f" - {t['topic']} ({t['accuracy']*100:.0f}% accuracy)"
for t in weak_topics[:5]
)
prompt = (
f"Generate a personalised math learning path for a {grade_level} student.\n\n"
f"Weak subjects: {weakness_lines}\n"
f"Weak topics:\n{topic_lines}\n\n"
"Create 5-7 specific activities. For each give:\n"
"1. Activity title\n"
"2. Brief description (1-2 sentences)\n"
"3. Estimated duration\n"
"4. Type (video, practice, quiz, reading, interactive)\n\n"
"Format as a numbered list. Be specific."
)
return call_hf_chat(
messages=[
{
"role": "system",
"content": (
"You are an educational curriculum expert specialising in "
"mathematics. Create clear, actionable learning paths."
),
},
{"role": "user", "content": prompt},
],
max_tokens=1500,
temperature=0.7,
)
except Exception as e:
logger.warning(f"Learning-path AI call failed: {e}")
return None
async def _generate_teacher_interventions(
self,
risk_classifications: Dict[str, Dict[str, Any]],
weak_topics: List[Dict[str, Any]],
) -> Optional[str]:
"""Generate teacher intervention recommendations via HF Serverless Inference."""
try:
from main import call_hf_chat
at_risk = [
subj for subj, data in risk_classifications.items()
if data["status"] == "At Risk"
]
topic_lines = "\n".join(
f"- {t['topic']} ({t['accuracy']*100:.0f}% accuracy)"
for t in weak_topics[:5]
)
prompt = (
"You are an educational intervention specialist. A student has completed "
"their diagnostic assessment with the following results:\n\n"
f"At-Risk Subjects: {', '.join(at_risk)}\n\n"
f"Weak Topics Identified:\n{topic_lines}\n\n"
"Generate a 'Remedial Path Timeline' with:\n"
"1. Prioritised list of topics to address (most critical first)\n"
"2. Suggested teaching strategies for each topic\n"
"3. Recommended one-on-one intervention activities\n"
"4. Timeline for reassessment\n"
"5. Warning signs that student needs additional support\n\n"
"Keep response under 300 words, structured with clear sections."
)
return call_hf_chat(
messages=[
{
"role": "system",
"content": (
"You are an expert educational intervention specialist. "
"Provide actionable, structured recommendations for teachers."
),
},
{"role": "user", "content": prompt},
],
max_tokens=1000,
temperature=0.5,
)
except Exception as e:
logger.warning(f"Teacher-intervention AI call failed: {e}")
return None
# Module-level singleton
automation_engine = MathPulseAutomationEngine()
|