Repository navigation
Expand file tree
/
Copy pathpriority_engine.py
More file actions
454 lines (372 loc) · 10.7 KB
/
Copy pathpriority_engine.py
File metadata and controls
454 lines (372 loc) · 10.7 KB
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
import numpy as np
from scipy.optimize import minimize
def calculate_required_grade(
current_grade,
target_grade,
assessment_weight,
grading_mode="percentage"
):
"""
Calculate the exam grade required to reach
a target course grade.
In points mode, current_grade is the cumulative number
of course points already earned. In percentage mode, it
is the average across coursework completed before the exam.
"""
if not 0 <= current_grade <= 100:
raise ValueError(
"Current grade must be between 0 and 100."
)
if not 0 <= target_grade <= 100:
raise ValueError(
"Target grade must be between 0 and 100."
)
if not 0 < assessment_weight <= 100:
raise ValueError(
"Exam weight must be greater than 0."
)
if grading_mode not in {"points", "percentage"}:
raise ValueError(
"Grading mode must be points or percentage."
)
completed_points_available = 100 - assessment_weight
if (
grading_mode == "points"
and current_grade > completed_points_available
):
raise ValueError(
"Points earned so far cannot exceed "
f"{completed_points_available:g} when the exam "
f"is worth {assessment_weight:g}%."
)
assessment_ratio = assessment_weight / 100
if grading_mode == "points":
completed_contribution = current_grade
else:
completed_ratio = 1 - assessment_ratio
completed_contribution = (
current_grade * completed_ratio
)
required_grade = (
target_grade - completed_contribution
) / assessment_ratio
maximum_achievable_grade = (
completed_contribution
+ 100 * assessment_ratio
)
minimum_possible_grade = (
completed_contribution
)
required_grade = round(required_grade, 1)
maximum_achievable_grade = round(
maximum_achievable_grade,
1
)
minimum_possible_grade = round(
minimum_possible_grade,
1
)
if required_grade <= 0:
return {
"required_grade": 0.0,
"maximum_achievable_grade":
maximum_achievable_grade,
"minimum_possible_grade":
minimum_possible_grade,
"status": "secured",
"message": (
"The target is already secured even with "
"a score of 0% on this exam."
)
}
if required_grade > 100:
return {
"required_grade": required_grade,
"maximum_achievable_grade":
maximum_achievable_grade,
"minimum_possible_grade":
minimum_possible_grade,
"status": "not_possible",
"message": (
f"Reaching this target would require "
f"{required_grade}%. Even with 100% on "
f"the exam, the highest achievable "
f"course grade is "
f"{maximum_achievable_grade}%."
)
}
if required_grade <= 75:
return {
"required_grade": required_grade,
"maximum_achievable_grade":
maximum_achievable_grade,
"minimum_possible_grade":
minimum_possible_grade,
"status": "within_reach",
"message": (
f"A score of {required_grade}% is needed "
"to reach the target grade."
)
}
if required_grade <= 90:
return {
"required_grade": required_grade,
"maximum_achievable_grade":
maximum_achievable_grade,
"minimum_possible_grade":
minimum_possible_grade,
"status": "challenging",
"message": (
f"A score of {required_grade}% is needed. "
"The target is achievable but requires "
"a strong exam result."
)
}
return {
"required_grade": required_grade,
"maximum_achievable_grade":
maximum_achievable_grade,
"minimum_possible_grade":
minimum_possible_grade,
"status": "high_risk",
"message": (
f"A score of {required_grade}% is needed. "
"The target is possible, but there is very "
"little margin for lost marks."
)
}
def calculate_priority(
current_grade,
target_grade,
assessment_weight,
days_remaining,
confidence,
credit_hours
):
"""Calculate a course priority score from 0 to 100."""
grade_gap = max(
target_grade - current_grade,
0
) / 100
weight_score = assessment_weight / 100
urgency_score = 1 / (
1 + days_remaining / 7
)
confidence_need = (
5 - confidence
) / 4
credit_score = credit_hours / 4
priority_score = (
grade_gap * 0.30
+ weight_score * 0.25
+ urgency_score * 0.25
+ confidence_need * 0.15
+ credit_score * 0.05
)
return round(priority_score * 100, 2)
def create_priority_explanation(course):
"""
Explain the main reasons behind a course's
calculated priority.
"""
reasons = []
assessment_name = course.get(
"assessment_name",
"The exam"
)
grade_gap = (
course["target_grade"]
- course["current_grade"]
)
if course.get("grading_mode") == "points":
if grade_gap > 0:
reasons.append(
f"{grade_gap:g} more course points are needed "
"to reach the target"
)
else:
reasons.append(
"the points already earned meet the target"
)
elif grade_gap >= 15:
reasons.append(
f"a {grade_gap:g}-point gap remains "
"between the current and target grade"
)
elif grade_gap > 0:
reasons.append(
f"the target is {grade_gap:g} points above "
"the current grade"
)
else:
reasons.append(
"the current grade already meets the target"
)
if course["days_remaining"] <= 3:
reasons.append(
f"{assessment_name} is due in only "
f"{course['days_remaining']} days"
)
elif course["days_remaining"] <= 7:
reasons.append(
f"{assessment_name} is due within one week"
)
if course["assessment_weight"] >= 30:
reasons.append(
f"{assessment_name} contributes "
f"{course['assessment_weight']:g}% "
"of the course grade"
)
if course["confidence"] <= 2:
reasons.append(
"the reported confidence level is low"
)
if len(reasons) == 1:
reasons.append(
"its combined urgency and course weight "
"still affect the recommendation"
)
return (
"This course received its priority because "
+ ", and ".join(reasons)
+ "."
)
def rank_courses(courses):
"""
Calculate and rank courses from highest
to lowest priority.
"""
ranked_courses = []
for course in courses:
score = calculate_priority(
current_grade=course["current_grade"],
target_grade=course["target_grade"],
assessment_weight=course[
"assessment_weight"
],
days_remaining=course["days_remaining"],
confidence=course["confidence"],
credit_hours=course["credit_hours"]
)
feasibility = calculate_required_grade(
current_grade=course["current_grade"],
target_grade=course["target_grade"],
assessment_weight=course[
"assessment_weight"
],
grading_mode=course.get(
"grading_mode",
"percentage"
)
)
course_result = course.copy()
course_result["priority_score"] = score
course_result["required_grade"] = (
feasibility["required_grade"]
)
course_result["maximum_achievable_grade"] = (
feasibility[
"maximum_achievable_grade"
]
)
course_result["minimum_possible_grade"] = (
feasibility[
"minimum_possible_grade"
]
)
course_result["feasibility_status"] = (
feasibility["status"]
)
course_result["feasibility_message"] = (
feasibility["message"]
)
course_result["priority_explanation"] = (
create_priority_explanation(course)
)
ranked_courses.append(course_result)
return sorted(
ranked_courses,
key=lambda course: course["priority_score"],
reverse=True
)
def allocate_study_hours(
ranked_courses,
total_hours
):
"""
Allocate limited study hours using
constrained optimization.
"""
if total_hours <= 0:
raise ValueError(
"Total study hours must be greater than zero."
)
if not ranked_courses:
return []
priority_scores = np.array([
max(course["priority_score"], 0.01)
for course in ranked_courses
])
number_of_courses = len(ranked_courses)
starting_hours = np.full(
number_of_courses,
total_hours / number_of_courses
)
def objective(hours):
utility = (
priority_scores * np.log1p(hours)
)
return -np.sum(utility)
constraints = {
"type": "eq",
"fun": lambda hours: (
np.sum(hours) - total_hours
)
}
bounds = [
(0, total_hours)
for _ in ranked_courses
]
result = minimize(
objective,
starting_hours,
method="SLSQP",
bounds=bounds,
constraints=constraints
)
if not result.success:
raise RuntimeError(
"Study-hour optimization failed."
)
rounded_hours = np.round(
result.x,
1
)
rounding_difference = round(
total_hours - np.sum(rounded_hours),
1
)
highest_priority_index = np.argmax(
priority_scores
)
rounded_hours[
highest_priority_index
] = round(
float(
rounded_hours[highest_priority_index]
+ rounding_difference
),
1
)
allocations = []
for course, hours in zip(
ranked_courses,
rounded_hours
):
course_result = course.copy()
course_result["recommended_hours"] = round(
float(hours),
1
)
allocations.append(course_result)
return allocations