QuizGenerator 0.4.2__py3-none-any.whl → 0.6.0__py3-none-any.whl

QuizGenerator/premade_questions/cst463/gradient_descent/gradient_calculation.py

@@ -2,11 +2,11 @@ from __future__ import annotations
 
 import abc
 import logging
-from typing import List
+from typing import List, Tuple
 import sympy as sp
 
-from QuizGenerator.contentast import ContentAST
-from QuizGenerator.question import Question, Answer, QuestionRegistry
+from QuizGenerator.contentast import ContentAST, AnswerTypes
+from QuizGenerator.question import Question, QuestionRegistry
 from .misc import generate_function, format_vector
 
 log = logging.getLogger(__name__)
@@ -39,6 +39,9 @@ class DerivativeQuestion(Question, abc.ABC):
     # Evaluate gradient at the specified point
     subs_map = dict(zip(self.variables, evaluation_point))
 
+    # Format evaluation point for label
+    eval_point_str = ", ".join([f"x_{i} = {evaluation_point[i]}" for i in range(self.num_variables)])
+
     # Create answer for each partial derivative
     for i in range(self.num_variables):
       answer_key = f"partial_derivative_{i}"
@@ -52,7 +55,9 @@ class DerivativeQuestion(Question, abc.ABC):
         raise ValueError("Complex number encountered - need to regenerate")
 
       # Use auto_float for Canvas compatibility with integers and decimals
-      self.answers[answer_key] = Answer.auto_float(answer_key, gradient_value)
+      # Label includes the partial derivative notation
+      label = f"∂f/∂x_{i} at ({eval_point_str})"
+      self.answers[answer_key] = AnswerTypes.Float(gradient_value, label=label)
 
   def _create_gradient_vector_answer(self) -> None:
     """Create a single gradient vector answer for PDF format."""
@@ -70,10 +75,12 @@ class DerivativeQuestion(Question, abc.ABC):
 
     # Format as vector for display using consistent formatting
     vector_str = format_vector(gradient_values)
-    self.answers["gradient_vector"] = Answer.string("gradient_vector", vector_str, pdf_only=True)
+    self.answers["gradient_vector"] = AnswerTypes.String(vector_str, pdf_only=True)
 
-  def get_body(self, **kwargs) -> ContentAST.Section:
+  def _get_body(self, **kwargs) -> Tuple[ContentAST.Section, List[ContentAST.Answer]]:
+    """Build question body and collect answers."""
     body = ContentAST.Section()
+    answers = []
 
     # Display the function
     body.add_element(
@@ -103,6 +110,8 @@ class DerivativeQuestion(Question, abc.ABC):
 
     # For Canvas: Use OnlyHtml to show individual partial derivatives
     for i in range(self.num_variables):
+      answer = self.answers[f"partial_derivative_{i}"]
+      answers.append(answer)
       body.add_element(
         ContentAST.OnlyHtml([
           ContentAST.Paragraph([
@@ -110,14 +119,20 @@ class DerivativeQuestion(Question, abc.ABC):
               f"\\left. {self._format_partial_derivative(i)} \\right|_{{{eval_point_str}}} = ",
               inline=True
             ),
-            ContentAST.Answer(self.answers[f"partial_derivative_{i}"])
+            answer
           ])
         ])
       )
 
+    return body, answers
+
+  def get_body(self, **kwargs) -> ContentAST.Section:
+    """Build question body (backward compatible interface)."""
+    body, _ = self._get_body(**kwargs)
     return body
 
-  def get_explanation(self, **kwargs) -> ContentAST.Section:
+  def _get_explanation(self, **kwargs) -> Tuple[ContentAST.Section, List[ContentAST.Answer]]:
+    """Build question explanation."""
     explanation = ContentAST.Section()
 
     # Show the function and its gradient
@@ -147,14 +162,14 @@ class DerivativeQuestion(Question, abc.ABC):
       partial_expr = self.gradient_function[i]
       partial_value = partial_expr.subs(subs_map)
 
-      # Use Answer.accepted_strings for clean numerical formatting
+      # Use ContentAST.Answer.accepted_strings for clean numerical formatting
       try:
         numerical_value = float(partial_value)
       except (TypeError, ValueError):
         numerical_value = float(partial_value.evalf())
 
       # Get clean string representation
-      clean_value = sorted(Answer.accepted_strings(numerical_value), key=lambda s: len(s))[0]
+      clean_value = sorted(ContentAST.Answer.accepted_strings(numerical_value), key=lambda s: len(s))[0]
 
       explanation.add_element(
         ContentAST.Paragraph([
@@ -165,6 +180,11 @@ class DerivativeQuestion(Question, abc.ABC):
         ])
       )
 
+    return explanation, []
+
+  def get_explanation(self, **kwargs) -> ContentAST.Section:
+    """Build question explanation (backward compatible interface)."""
+    explanation, _ = self._get_explanation(**kwargs)
     return explanation
 
 
@@ -264,7 +284,8 @@ class DerivativeChain(DerivativeQuestion):
     f = sp.Function('f')
     self.equation = sp.Eq(f(*self.variables), self.function)
 
-  def get_explanation(self, **kwargs) -> ContentAST.Section:
+  def _get_explanation(self, **kwargs) -> Tuple[ContentAST.Section, List[ContentAST.Answer]]:
+    """Build question explanation."""
     explanation = ContentAST.Section()
 
     # Show the composed function structure
@@ -348,14 +369,14 @@ class DerivativeChain(DerivativeQuestion):
       partial_expr = self.gradient_function[i]
       partial_value = partial_expr.subs(subs_map)
 
-      # Use Answer.accepted_strings for clean numerical formatting
+      # Use ContentAST.Answer.accepted_strings for clean numerical formatting
       try:
         numerical_value = float(partial_value)
       except (TypeError, ValueError):
         numerical_value = float(partial_value.evalf())
 
       # Get clean string representation
-      clean_value = sorted(Answer.accepted_strings(numerical_value), key=lambda s: len(s))[0]
+      clean_value = sorted(ContentAST.Answer.accepted_strings(numerical_value), key=lambda s: len(s))[0]
 
       explanation.add_element(
         ContentAST.Paragraph([
@@ -366,4 +387,9 @@ class DerivativeChain(DerivativeQuestion):
         ])
       )
 
+    return explanation, []
+
+  def get_explanation(self, **kwargs) -> ContentAST.Section:
+    """Build question explanation (backward compatible interface)."""
+    explanation, _ = self._get_explanation(**kwargs)
     return explanation

QuizGenerator/premade_questions/cst463/gradient_descent/gradient_descent_questions.py

@@ -6,8 +6,8 @@ import math
 from typing import List, Tuple, Callable, Union, Any
 import sympy as sp
 
-from QuizGenerator.contentast import ContentAST
-from QuizGenerator.question import Question, Answer, QuestionRegistry
+from QuizGenerator.contentast import ContentAST, AnswerTypes
+from QuizGenerator.question import Question, QuestionRegistry
 from QuizGenerator.mixins import TableQuestionMixin, BodyTemplatesMixin
 
 from .misc import generate_function, format_vector
@@ -15,6 +15,11 @@ from .misc import generate_function, format_vector
 log = logging.getLogger(__name__)
 
 
+# Note: This file does not use ContentAST.Answer wrappers - it uses TableQuestionMixin
+# which handles answer display through create_answer_table(). The answers are created
+# with labels embedded at creation time in refresh().
+
+
 class GradientDescentQuestion(Question, abc.ABC):
   def __init__(self, *args, **kwargs):
     kwargs["topic"] = kwargs.get("topic", Question.Topic.ML_OPTIMIZATION)
@@ -86,30 +91,32 @@ class GradientDescentWalkthrough(GradientDescentQuestion, TableQuestionMixin, Bo
     
     # Set up answers
     self.answers = {}
-    
+
     # Answers for each step
     for i, result in enumerate(self.gradient_descent_results):
       step = result['step']
-      
+
       # Location answer
       location_key = f"answer__location_{step}"
-      self.answers[location_key] = Answer.vector_value(location_key, list(result['location']))
-      
+      self.answers[location_key] = AnswerTypes.Vector(list(result['location']), label=f"Location at step {step}")
+
       # Gradient answer
       gradient_key = f"answer__gradient_{step}"
-      self.answers[gradient_key] = Answer.vector_value(gradient_key, list(result['gradient']))
-      
+      self.answers[gradient_key] = AnswerTypes.Vector(list(result['gradient']), label=f"Gradient at step {step}")
+
       # Update answer
       update_key = f"answer__update_{step}"
-      self.answers[update_key] = Answer.vector_value(update_key, list(result['update']))
+      self.answers[update_key] = AnswerTypes.Vector(list(result['update']), label=f"Update at step {step}")
   
-  def get_body(self, **kwargs) -> ContentAST.Section:
+  def _get_body(self, **kwargs) -> Tuple[ContentAST.Section, List[ContentAST.Answer]]:
+    """Build question body and collect answers."""
     body = ContentAST.Section()
-    
+    answers = []
+
     # Introduction
     objective = "minimize" if self.minimize else "maximize"
     sign = "-" if self.minimize else "+"
-    
+
     body.add_element(
       ContentAST.Paragraph(
         [
@@ -122,7 +129,7 @@ class GradientDescentWalkthrough(GradientDescentQuestion, TableQuestionMixin, Bo
         ]
       )
     )
-    
+
     # Create table data - use ContentAST.Equation for proper LaTeX rendering in headers
     headers = [
       "n",
@@ -131,36 +138,49 @@ class GradientDescentWalkthrough(GradientDescentQuestion, TableQuestionMixin, Bo
       ContentAST.Equation("\\alpha \\cdot \\nabla f", inline=True)
     ]
     table_rows = []
-    
+
     for i in range(self.num_steps):
       step = i + 1
       row = {"n": str(step)}
-      
+
       if step == 1:
-        
+
         # Fill in starting location for first row with default formatting
         row["location"] = f"{format_vector(self.starting_point)}"
         row[headers[2]] = f"answer__gradient_{step}"  # gradient column
         row[headers[3]] = f"answer__update_{step}"  # update column
+        # Collect answers for this step (no location answer for step 1)
+        answers.append(self.answers[f"answer__gradient_{step}"])
+        answers.append(self.answers[f"answer__update_{step}"])
       else:
         # Subsequent rows - all answer fields
         row["location"] = f"answer__location_{step}"
         row[headers[2]] = f"answer__gradient_{step}"  # gradient column
         row[headers[3]] = f"answer__update_{step}"  # update column
+        # Collect all answers for this step
+        answers.append(self.answers[f"answer__location_{step}"])
+        answers.append(self.answers[f"answer__gradient_{step}"])
+        answers.append(self.answers[f"answer__update_{step}"])
       table_rows.append(row)
-    
+
     # Create the table using mixin
     gradient_table = self.create_answer_table(
       headers=headers,
       data_rows=table_rows,
       answer_columns=["location", headers[2], headers[3]]  # Use actual header objects
     )
-    
+
     body.add_element(gradient_table)
-    
+
+    return body, answers
+
+  def get_body(self, **kwargs) -> ContentAST.Section:
+    """Build question body (backward compatible interface)."""
+    body, _ = self._get_body(**kwargs)
     return body
   
-  def get_explanation(self, **kwargs) -> ContentAST.Section:
+  def _get_explanation(self, **kwargs) -> Tuple[ContentAST.Section, List[ContentAST.Answer]]:
+    """Build question explanation."""
     explanation = ContentAST.Section()
 
     explanation.add_element(
@@ -201,7 +221,7 @@ class GradientDescentWalkthrough(GradientDescentQuestion, TableQuestionMixin, Bo
         ]
       )
     )
-    
+
     # Add completed table showing all solutions
     explanation.add_element(
       ContentAST.Paragraph(
@@ -210,7 +230,7 @@ class GradientDescentWalkthrough(GradientDescentQuestion, TableQuestionMixin, Bo
         ]
       )
     )
-    
+
     # Create filled solution table
     solution_headers = [
       "n",
@@ -218,31 +238,31 @@ class GradientDescentWalkthrough(GradientDescentQuestion, TableQuestionMixin, Bo
       ContentAST.Equation("\\nabla f", inline=True),
       ContentAST.Equation("\\alpha \\cdot \\nabla f", inline=True)
     ]
-    
+
     solution_rows = []
     for i, result in enumerate(self.gradient_descent_results):
       step = result['step']
       row = {"n": str(step)}
-      
+
       row["location"] = f"{format_vector(result['location'])}"
       row[solution_headers[2]] = f"{format_vector(result['gradient'])}"
       row[solution_headers[3]] = f"{format_vector(result['update'])}"
-    
+
       solution_rows.append(row)
-    
+
     # Create solution table (non-answer table, just display)
     solution_table = self.create_answer_table(
       headers=solution_headers,
       data_rows=solution_rows,
       answer_columns=[]  # No answer columns since this is just for display
     )
-    
+
     explanation.add_element(solution_table)
-    
+
     # Step-by-step explanation
     for i, result in enumerate(self.gradient_descent_results):
       step = result['step']
-      
+
       explanation.add_element(
         ContentAST.Paragraph(
           [
@@ -250,7 +270,7 @@ class GradientDescentWalkthrough(GradientDescentQuestion, TableQuestionMixin, Bo
           ]
         )
       )
-      
+
       explanation.add_element(
         ContentAST.Paragraph(
           [
@@ -258,7 +278,7 @@ class GradientDescentWalkthrough(GradientDescentQuestion, TableQuestionMixin, Bo
           ]
         )
       )
-      
+
       explanation.add_element(
         ContentAST.Paragraph(
           [
@@ -266,7 +286,7 @@ class GradientDescentWalkthrough(GradientDescentQuestion, TableQuestionMixin, Bo
           ]
         )
       )
-      
+
       explanation.add_element(
         ContentAST.Paragraph(
           [
@@ -278,13 +298,13 @@ class GradientDescentWalkthrough(GradientDescentQuestion, TableQuestionMixin, Bo
           ]
         )
       )
-      
+
       if step < len(self.gradient_descent_results):
         # Calculate next location for display
         current_loc = result['location']
         update = result['update']
         next_loc = [current_loc[j] - update[j] for j in range(len(current_loc))]
-        
+
         explanation.add_element(
           ContentAST.Paragraph(
             [
@@ -292,7 +312,7 @@ class GradientDescentWalkthrough(GradientDescentQuestion, TableQuestionMixin, Bo
             ]
           )
         )
-    
+
     function_values = [r['function_value'] for r in self.gradient_descent_results]
     explanation.add_element(
       ContentAST.Paragraph(
@@ -301,5 +321,10 @@ class GradientDescentWalkthrough(GradientDescentQuestion, TableQuestionMixin, Bo
         ]
       )
     )
-    
+
+    return explanation, []
+
+  def get_explanation(self, **kwargs) -> ContentAST.Section:
+    """Build question explanation (backward compatible interface)."""
+    explanation, _ = self._get_explanation(**kwargs)
     return explanation

QuizGenerator/premade_questions/cst463/gradient_descent/loss_calculations.py

@@ -6,13 +6,16 @@ import math
 import numpy as np
 from typing import List, Tuple, Dict, Any
 
-from QuizGenerator.contentast import ContentAST
-from QuizGenerator.question import Question, Answer, QuestionRegistry
+from QuizGenerator.contentast import ContentAST, AnswerTypes
+from QuizGenerator.question import Question, QuestionRegistry
 from QuizGenerator.mixins import TableQuestionMixin, BodyTemplatesMixin
 
 log = logging.getLogger(__name__)
 
 
+# Note: This file migrates to the _get_body()/_get_explanation() pattern
+
+
 class LossQuestion(Question, TableQuestionMixin, BodyTemplatesMixin, abc.ABC):
   """Base class for loss function calculation questions."""
 
@@ -70,14 +73,15 @@ class LossQuestion(Question, TableQuestionMixin, BodyTemplatesMixin, abc.ABC):
 
     # Individual loss answers
     for i in range(self.num_samples):
-      self.answers[f"loss_{i}"] = Answer.float_value(f"loss_{i}", self.individual_losses[i])
+      self.answers[f"loss_{i}"] = AnswerTypes.Float(self.individual_losses[i], label=f"Sample {i + 1} loss")
 
     # Overall loss answer
-    self.answers["overall_loss"] = Answer.float_value("overall_loss", self.overall_loss)
+    self.answers["overall_loss"] = AnswerTypes.Float(self.overall_loss, label="Overall loss")
 
-  def get_body(self) -> ContentAST.Element:
-    """Generate the question body with data table."""
+  def _get_body(self, **kwargs) -> Tuple[ContentAST.Element, List[ContentAST.Answer]]:
+    """Build question body and collect answers."""
     body = ContentAST.Section()
+    answers = []
 
     # Question description
     body.add_element(ContentAST.Paragraph([
@@ -85,15 +89,25 @@ class LossQuestion(Question, TableQuestionMixin, BodyTemplatesMixin, abc.ABC):
       f"and the overall {self._get_loss_function_short_name()}."
     ]))
 
-    # Data table
+    # Data table (contains individual loss answers)
     body.add_element(self._create_data_table())
 
+    # Collect individual loss answers
+    for i in range(self.num_samples):
+      answers.append(self.answers[f"loss_{i}"])
+
     # Overall loss question
     body.add_element(ContentAST.Paragraph([
       f"Overall {self._get_loss_function_short_name()}: "
     ]))
-    body.add_element(ContentAST.Answer(self.answers["overall_loss"]))
+    answers.append(self.answers["overall_loss"])
+    body.add_element(self.answers["overall_loss"])
+
+    return body, answers
 
+  def get_body(self, **kwargs) -> ContentAST.Element:
+    """Build question body (backward compatible interface)."""
+    body, _ = self._get_body(**kwargs)
     return body
 
   @abc.abstractmethod
@@ -101,8 +115,8 @@ class LossQuestion(Question, TableQuestionMixin, BodyTemplatesMixin, abc.ABC):
     """Create the data table with answer fields."""
     pass
 
-  def get_explanation(self) -> ContentAST.Element:
-    """Generate detailed explanation of the loss calculations."""
+  def _get_explanation(self, **kwargs) -> Tuple[ContentAST.Element, List[ContentAST.Answer]]:
+    """Build question explanation."""
     explanation = ContentAST.Section()
 
     explanation.add_element(ContentAST.Paragraph([
@@ -121,6 +135,11 @@ class LossQuestion(Question, TableQuestionMixin, BodyTemplatesMixin, abc.ABC):
     # Overall loss calculation
     explanation.add_element(self._create_overall_loss_explanation())
 
+    return explanation, []
+
+  def get_explanation(self, **kwargs) -> ContentAST.Element:
+    """Build question explanation (backward compatible interface)."""
+    explanation, _ = self._get_explanation(**kwargs)
     return explanation
 
   @abc.abstractmethod

QuizGenerator/premade_questions/cst463/gradient_descent/misc.py

@@ -2,7 +2,7 @@
 from typing import List, Tuple, Callable, Union, Any
 import sympy as sp
 
-from QuizGenerator.misc import Answer
+from QuizGenerator.contentast import ContentAST
 
 def generate_function(rng, num_variables: int, max_degree: int, use_quadratic: bool = True) -> tuple[Any, sp.Expr, sp.MutableDenseMatrix, sp.Equality]:
   """
@@ -61,7 +61,7 @@ def format_vector(vec: List[float]) -> str:
   
   vector_string = ', '.join(
     [
-      sorted(Answer.accepted_strings(v), key=lambda s: len(s))[0]
+      sorted(ContentAST.Answer.accepted_strings(v), key=lambda s: len(s))[0]
       for v in vec
     ]
   )