process-improve 1.3.2__tar.gz → 1.3.3__tar.gz

{process_improve-1.3.2 → process_improve-1.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: process-improve
-Version: 1.3.2
+Version: 1.3.3
 Summary: Designed Experiments; Latent Variables (PCA, PLS, multivariate methods with missing data); Process Monitoring; Batch data analysis.
 Keywords: Designed Experiments,Latent Variables,PCA,PLS,Multivariate Data Analysis,Batch data analysis
 Author: Kevin Dunn

{process_improve-1.3.2 → process_improve-1.3.3}/process_improve/batch/preprocessing.py

@@ -23,7 +23,7 @@ def determine_scaling(
 
     Parameters
     ----------
-    dict_df : dict[str, pd.DataFrame]
+    batches : dict[str, pd.DataFrame]
         Batch data, in the standard format.
 
     Returns

{process_improve-1.3.2 → process_improve-1.3.3}/process_improve/experiments/designs_utils.py

@@ -185,8 +185,10 @@ def build_design_result(  # noqa: PLR0913
         Number of full replicates.
     blocks : int or None
         Number of blocks (None = no blocking).
-    random_seed : int
-        Seed for reproducible randomization.
+    random_seed : int or None
+        Seed for reproducible randomization. When ``None`` the original run
+        order of *coded_matrix* is preserved (used for designs whose run order
+        is part of the solution, e.g. split-plot optimal designs).
     generators : list[str] or None
         Generator strings (fractional factorials).
     defining_relation : list[str] or None

{process_improve-1.3.2 → process_improve-1.3.3}/process_improve/monitoring/control_charts.py

@@ -57,7 +57,7 @@ class ControlChart:
         self.style = style.strip()
         self.variant = variant.strip().lower()
 
-        # Will be calculated by the self.fit_limits() function
+        # Will be calculated by the self.calculate_limits() function
         self.target = None
         self._given_target = None
         self._given_s = None

{process_improve-1.3.2 → process_improve-1.3.3}/process_improve/multivariate/methods.py

@@ -1840,13 +1840,24 @@ def ellipse_coordinates(  # noqa: PLR0913
     Parameters
     ----------
     score_horiz : int
-        [description]
+        1-based index of the score to plot on the horizontal axis. Must satisfy
+        ``1 <= score_horiz <= n_components``.
     score_vert : int
-        [description]
+        1-based index of the score to plot on the vertical axis. Must satisfy
+        ``1 <= score_vert <= n_components``.
     conf_level : float
         The `conf_level` confidence value: e.g. 0.95 is for the 95% confidence limit.
     n_points : int, optional
         Number of points to use in the ellipse; by default 100.
+    n_components : int
+        Number of components `A` in the fitted model. Required to look up the
+        Hotelling's T^2 limit and to bound `score_horiz`/`score_vert`.
+    scaling_factor_for_scores : pd.Series
+        Per-component standard deviations of the scores (``model.scaling_factor_for_scores_``).
+        Used to scale the ellipse axes.
+    n_rows : int
+        Number of rows `N` in the data used to fit the model. Required to compute the
+        Hotelling's T^2 limit; must be strictly positive.
 
     Returns
     -------

{process_improve-1.3.2 → process_improve-1.3.3}/process_improve/univariate/metrics.py

@@ -68,7 +68,7 @@ def t_value_cdf(z: float, v: float) -> float:
 
     100% fractional area is always at :math:`+\infty`:
 
-    >>> t_value(np.inf, v)
+    >>> t_value_cdf(np.inf, v)
     1.0
 
     See also

{process_improve-1.3.2 → process_improve-1.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "process-improve"
-version = "1.3.2"
+version = "1.3.3"
 description = 'Designed Experiments; Latent Variables (PCA, PLS, multivariate methods with missing data); Process Monitoring; Batch data analysis.'
 readme = "README.md"
 license = "MIT"