adaptivetesting 1.1.2__tar.gz → 1.1.4__tar.gz

adaptivetesting-1.1.4/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Version 1.1.4
+- Bug Fix #43 (optimization interval in `maximize_posterior` function)
+
+# Version 1.1.3
+- Bug Fix #34 (numerical stability issue concerning the ability estimation and standard error calculation)
+
+# Version 1.1.2
+
+- The `ItemPool` class now correctly honors the `id` field of items. (#30, #31)
+- Examples and the readme file have been updated accordingly.

{adaptivetesting-1.1.2 → adaptivetesting-1.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: adaptivetesting
-Version: 1.1.2
+Version: 1.1.4
 Summary: adaptivetesting is a Python package that can be used to simulate and evaluate custom CAT scenarios as well as implement them in real-world testing scenarios from a single codebase
 Project-URL: Homepage, https://github.com/condecon/adaptivetesting
 Project-URL: Documentation, https://github.com/condecon/adaptivetesting/tree/main/docs

{adaptivetesting-1.1.2 → adaptivetesting-1.1.4}/adaptivetesting/math/estimators/__functions/__bayes.py

@@ -11,22 +11,25 @@ def maximize_posterior(
     c: np.ndarray,
     d: np.ndarray,
     response_pattern: np.ndarray,
-    prior: Prior
+    prior: Prior,
+    optimization_interval: tuple[float, float] = (-10, 10)
 ) -> float:
     """_summary_
 
     Args:
-        a (np.ndarray): _description_
-        
-        b (np.ndarray): _description_
+        a (np.ndarray): item parameter a
+    
+        b (np.ndarray): item parameter b
         
-        c (np.ndarray): _description_
+        c (np.ndarray): item parameter c
         
-        d (np.ndarray): _description_
+        d (np.ndarray): item parameter d
         
-        response_pattern (np.ndarray): _description_
+        response_pattern (np.ndarray): response pattern (simulated or user generated)
         
-        prior (Prior): _description_
+        prior (Prior): prior distribution
+
+        optimization_interval (Tuple[float, float]): interval used for the optimization function
 
     Returns:
         float: Bayes Modal estimator for the given parameters
@@ -35,7 +38,7 @@ def maximize_posterior(
         return likelihood(mu, a, b, c, d, response_pattern) * prior.pdf(mu)
     
     result: OptimizeResult = minimize_scalar(lambda mu: posterior(mu),
-                                             bounds=(-10, 10),
+                                             bounds=optimization_interval,
                                              method="bounded") # type: ignore
     
     if not result.success:

{adaptivetesting-1.1.2 → adaptivetesting-1.1.4}/adaptivetesting/math/estimators/__functions/__estimators.py

@@ -12,22 +12,50 @@ def probability_y1(mu: np.ndarray,
 
     Args:
         mu (np.ndarray): latent ability level
-        
         a (np.ndarray): item discrimination parameter
-        
         b (np.ndarray): item difficulty parameter
-        
         c (np.ndarray): pseudo guessing parameter
-        
         d (np.ndarray): inattention parameter
 
     Returns:
         np.ndarray: probability of getting the item correct
     """
+    # Compute the exponent safely
+    z = a * (mu - b)
+
+    # Use log-sum-exp trick for numerical stability
+    # For large positive z: exp(z)/(1+exp(z)) ≈ 1
+    # For large negative z: exp(z)/(1+exp(z)) ≈ exp(z)
+
+    # Clip z to prevent overflow in exp()
+    z_clipped = np.clip(z, -500, 500)  # exp(-500) and exp(500) are safe
+
+    # Compute the logistic function safely
+    # Use different formulas based on the sign of z for stability
+    result = np.empty_like(z_clipped)
+
+    # For large positive values, use alternative formula to avoid overflow
+    mask_positive = z_clipped > 20  # exp(20) is large but manageable
+    mask_negative = z_clipped < -20  # exp(-20) is very small
+    mask_medium = ~(mask_positive | mask_negative)
+
+    # Large positive z: 1/(1+exp(-z)) is more stable
+    result[mask_positive] = 1.0 / (1.0 + np.exp(-z_clipped[mask_positive]))
+
+    # Large negative z: exp(z)/(1+exp(z)) is stable
+    exp_z_neg = np.exp(z_clipped[mask_negative])
+    result[mask_negative] = exp_z_neg / (1.0 + exp_z_neg)
+
+    # Medium values: use standard formula
+    exp_z_med = np.exp(z_clipped[mask_medium])
+    result[mask_medium] = exp_z_med / (1.0 + exp_z_med)
+
+    # Apply the 4PL transformation
+    value = c + (d - c) * result
+
+    # Ensure probabilities are within valid range [c, d]
+    value = np.clip(value, c, d)
 
-    value = c + (d - c) * (np.exp(a * (mu - b))) / \
-        (1 + np.exp(a * (mu - b)))
-    
     return np.squeeze(value)
 
 
@@ -40,13 +68,13 @@ def probability_y0(mu: np.ndarray,
 
     Args:
             mu (np.ndarray): latent ability level
-            
+
             a (np.ndarray): item discrimination parameter
-            
+
             b (np.ndarray): item difficulty parameter
-            
+
             c (np.ndarray): pseudo guessing parameter
-            
+
             d (np.ndarray): inattention parameter
 
     Returns:
@@ -68,13 +96,13 @@ def likelihood(mu: np.ndarray,
 
     Args:
         mu (np.ndarray): ability level
-        
+
         a (np.ndarray): item discrimination parameter
-        
+
         b (np.ndarray): item difficulty parameter
-        
+
         c (np.ndarray): pseudo guessing parameter
-        
+
         d (np.ndarray): inattention parameter
 
     Returns:
@@ -88,7 +116,7 @@ def likelihood(mu: np.ndarray,
 
     terms = (probability_y1(mu, a, b, c, d)**response_pattern) * \
         (probability_y0(mu, a, b, c, d) ** (1 - response_pattern))
-    
+
     return -np.prod(terms)
 
 
@@ -100,14 +128,14 @@ def maximize_likelihood_function(a: np.ndarray,
                                  border: tuple[float, float] = (-10, 10)) -> float:
     """Find the ability value that maximizes the likelihood function.
     This function uses the minimize_scalar function from scipy and the "bounded" method.
-    
+
     Args:
         a (np.ndarray): item discrimination parameter
-        
+
         b (np.ndarray): item difficulty parameter
-        
+
         c (np.ndarray): pseudo guessing parameter
-        
+
         d (np.ndarray): inattention parameter
 
         response_pattern (np.ndarray): response pattern of the item
@@ -129,7 +157,7 @@ def maximize_likelihood_function(a: np.ndarray,
             "Response pattern is invalid. It consists of only one type of response.")
         raise AlgorithmException(
             "Response pattern is invalid. It consists of only one type of response.")
-    
+
     result: OptimizeResult = minimize_scalar(likelihood, args=(a, b, c, d, response_pattern),
                                              bounds=border, method='bounded') # type: ignore
 

{adaptivetesting-1.1.2 → adaptivetesting-1.1.4}/adaptivetesting/math/estimators/__test_information.py

@@ -13,27 +13,17 @@ def item_information_function(
         c: np.ndarray,
         d: np.ndarray
 ) -> np.ndarray:
-    """Calculate the information of a test item given the currently
-    estimated ability `mu`.
-
-    Args:
-        mu (np.ndarray): currently estimated ability
-        a (np.ndarray): _description_
-        b (np.ndarray): _description_
-        c (np.ndarray): _description_
-        d (np.ndarray): _description_
-
-    Returns:
-        np.ndarray: _description_
-    """
     p_y1 = probability_y1(mu, a, b, c, d)
 
+    # Clip probabilities
+    p_y1_clipped = np.clip(p_y1, 1e-10, 1 - 1e-10)
+
     def p_y1_grad(x: np.ndarray) -> np.ndarray:
-        # Central finite difference for gradient
-        h = 1e-5
+        # Use a more robust finite difference scheme
+        h = np.maximum(1e-8, 1e-8 * np.abs(x))  # Adaptive step size
         return (probability_y1(x + h, a, b, c, d) - probability_y1(x - h, a, b, c, d)) / (2 * h)
-    
-    product = (p_y1_grad(mu) ** 2) / (p_y1 * (1 - p_y1))
+
+    product = (p_y1_grad(mu) ** 2) / (p_y1_clipped * (1 - p_y1_clipped))
     information = np.sum(product)
     return information
 
@@ -59,7 +49,7 @@ def prior_information_function(prior: Prior,
         (score_values ** 2) * prior.pdf(x_vals),
         x_vals
     )
-    
+
     return information
 
 

{adaptivetesting-1.1.2 → adaptivetesting-1.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name="adaptivetesting"
-version="1.1.2"
+version="1.1.4"
 description="adaptivetesting is a Python package that can be used to simulate and evaluate custom CAT scenarios as well as implement them in real-world testing scenarios from a single codebase"
 readme = "README.md"
 authors = [

adaptivetesting-1.1.2/CHANGELOG.md

@@ -1,4 +0,0 @@
-# Version 1.1.2
-
-- The `ItemPool` class now correctly honors the `id` field of items. (#30, #31)
-- Examples and the readme file have been updated accordingly.