DaSPi 2.7.0__tar.gz → 2.8.0__tar.gz

{daspi-2.7.0 → daspi-2.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: DaSPi
-Version: 2.7.0
+Version: 2.8.0
 Summary: Visualize and analyze your data with DaSPi. This package is designed for users who want to find relevant influencing factors in processes and validate improvements.
 Author-Email: Reto Jäggli <reto@jaeggli.email>
 License: MIT

{daspi-2.7.0 → daspi-2.8.0}/daspi/config.py

@@ -44,6 +44,7 @@ from collections.abc import Generator
 from contextlib import _GeneratorContextManager, contextmanager
 from typing import Any, Literal
 
+from ._typing import EstimationStrategy
 from .strings import STR
 
 __all__ = ['CONFIG', 'Config']
@@ -101,7 +102,33 @@ class Config:
         """Set matplotlib style."""
         from .plotlib.appearance import style
         style.use(value)
-    
+
+    # Strategy property (delegates to DEFAULT)
+    @property
+    def strategy(self) -> EstimationStrategy:
+        """Default strategy used to determine control limits (process
+        spread) for the `stripes` methods."""
+        from .constants import DEFAULT
+        return DEFAULT.STRATEGY
+
+    @strategy.setter
+    def strategy(self, value: EstimationStrategy) -> None:
+        from .constants import DEFAULT
+        DEFAULT.STRATEGY = value
+
+    # Agreement property (delegates to DEFAULT)
+    @property
+    def agreement(self) -> float | int:
+        """Default tolerated process variation (agreement) for control
+        limits in the `stripes` methods."""
+        from .constants import DEFAULT
+        return DEFAULT.AGREEMENT
+
+    @agreement.setter
+    def agreement(self, value: float | int) -> None:
+        from .constants import DEFAULT
+        DEFAULT.AGREEMENT = value
+
     # Context managers
     def use_style(self, style_name: str) -> _GeneratorContextManager:
         """Context manager for temporary style change.
@@ -165,7 +192,8 @@ class Config:
         ----------
         **kwargs : Any
             Key-value pairs of settings to update. Valid keys are
-            'language', 'username', and 'style'
+            'language', 'username', 'style', 'strategy' and
+            'agreement'
         
         Raises
         ------
@@ -186,7 +214,8 @@ class Config:
             if not hasattr(self, key):
                 raise AttributeError(
                     f"Config has no setting '{key}'. "
-                    f"Valid settings: language, username, style"
+                    f"Valid settings: language, username, style, strategy, "
+                    f"agreement"
                 )
             setattr(self, key, value)
     
@@ -194,13 +223,15 @@ class Config:
         """Reset all settings to defaults.
         
         Sets language to 'en', username to the value from the
-        USERNAME environment variable (or 'user' if not set), and
-        style to 'daspi'.
+        USERNAME environment variable (or 'user' if not set), style
+        to 'daspi', strategy to 'eval' and agreement to 6.
         """
         from os import environ
         STR.language = 'en'
         STR.username = environ.get('USERNAME', 'user')
         self.style = 'daspi'
+        self.strategy = 'eval'
+        self.agreement = 6
 
 # Global configuration instance
 CONFIG = Config()

{daspi-2.7.0 → daspi-2.8.0}/daspi/constants.py

@@ -7,7 +7,7 @@ import matplotlib.pyplot as plt
 from patsy.desc import INTERCEPT
 from scipy.stats._continuous_distns import _distn_names
 
-from ._typing import LineStyle
+from ._typing import EstimationStrategy, LineStyle
 
 __all__ = [
     'ANOVA',
@@ -755,14 +755,16 @@ DIST = _Distribution_()
 selecting distributions throughout the DaSPi library."""
 
 
-@dataclass(frozen=True)
+@dataclass
 class _Default_:
     """Default values used throughout the DaSPi library, e.g. confidence 
     level, sequence lengths for kernel density estimation and LOWESS, 
     and quantile ranges.
     
     Don't instantiate this class directly. Use the `DEFAULT` constant 
-    instead."""
+    instead. Note that this class is not frozen (unlike the other
+    constant groups in this module) because `STRATEGY` and `AGREEMENT`
+    are meant to be changed at runtime via `daspi.CONFIG.configure()`."""
 
     CONFIDENCE_LEVEL: float = 0.95
     """Default confidence level. 95 % confidence interval is used very 
@@ -809,6 +811,16 @@ class _Default_:
     """Default smoothing factor (alpha) for the
     `ExponentialSmoothingLine` Plotter."""
 
+    STRATEGY: EstimationStrategy = 'eval'
+    """Default strategy used to determine control limits (process
+    spread) for the `stripes` methods. Change this via
+    `daspi.CONFIG.configure(strategy=...)`."""
+
+    AGREEMENT: float | int = 6
+    """Default tolerated process variation (agreement) for control
+    limits in the `stripes` methods. Change this via
+    `daspi.CONFIG.configure(agreement=...)`."""
+
     @property
     def MARKER(self) -> str:
         """Default marker for scatter plots."""

{daspi-2.7.0 → daspi-2.8.0}/daspi/plotlib/chart.py

@@ -1243,8 +1243,8 @@ class SingleChart(Chart):
             control_limits: bool = False, 
             spec_limits: SpecLimits = UNBOUNDED,
             confidence: float | None = None,
-            strategy: EstimationStrategy = 'norm',
-            agreement: float | int = 6,  # noqa: PYI041
+            strategy: EstimationStrategy | None = None,
+            agreement: float | int | None = None,  # noqa: PYI041
             **kwds,
             ) -> Self:
         """Plot location and spread width lines, specification limits 
@@ -1286,7 +1286,7 @@ class SingleChart(Chart):
             - `data`: The quantiles for the process variation tolerance 
             are read directly from the data.
             
-            Default is 'norm'.
+            If None, uses `daspi.CONFIG.strategy` (default 'eval').
         agreement : int or float, optional
             Specify the tolerated process variation for which the 
             control limits are to be calculated. 
@@ -1299,7 +1299,7 @@ class SingleChart(Chart):
             then interpreted as the acceptable proportion for the 
             spread, e.g. 0.9973 (which corresponds to ~ 6 sigma)
             
-            Default is 6 because SixSigma ;-)
+            If None, uses `daspi.CONFIG.agreement` (default 6).
         **kwds:
             Additional keyword arguments for configuring StripesFacets.
 
@@ -2054,8 +2054,8 @@ class JointChart(Chart):
             control_limits: bool | tuple[bool, ...] = False, 
             spec_limits: SpecLimits | tuple[SpecLimits, ...] = UNBOUNDED,
             confidence: float | None | tuple[float | None, ...] = None,
-            strategy: EstimationStrategy | tuple = 'norm',
-            agreement: float | int | tuple[int | float, ...] = 6,  # noqa: PYI041
+            strategy: EstimationStrategy | None | tuple = None,
+            agreement: float | int | None | tuple[int | float, ...] = None,  # noqa: PYI041
             **kwds) -> Self:
         """Plot location and spread width lines, specification limits 
         and/or confidence interval areas as stripes on each Axes. The
@@ -2096,7 +2096,7 @@ class JointChart(Chart):
             - `data`: The quantiles for the process variation tolerance 
             are read directly from the data.
             
-            Default is 'norm'.
+            If None, uses `daspi.CONFIG.strategy` (default 'eval').
         agreement : int | float | tuple[int | float, ...], optional
             Specify the tolerated process variation for which the 
             control limits are to be calculated. 
@@ -2109,7 +2109,7 @@ class JointChart(Chart):
             then interpreted as the acceptable proportion for the 
             spread, e.g. 0.9973 (which corresponds to ~ 6 sigma)
             
-            Default is 6 because SixSigma ;-)
+            If None, uses `daspi.CONFIG.agreement` (default 6).
         **kwds:
             Additional keyword arguments for configuring StripesFacets.
 
@@ -2515,8 +2515,8 @@ class MultivariateChart(SingleChart):
             control_limits: bool = False, 
             spec_limits: SpecLimits = UNBOUNDED,
             confidence: float | None = None,
-            strategy: EstimationStrategy = 'norm',
-            agreement: float | int = 6,  # noqa: PYI041
+            strategy: EstimationStrategy | None = None,
+            agreement: float | int | None = None,  # noqa: PYI041
             **kwds,
             ) -> Self:
         """Plot location and spread width lines, specification limits 
@@ -2558,7 +2558,7 @@ class MultivariateChart(SingleChart):
             - `data`: The quantiles for the process variation tolerance 
             are read directly from the data.
             
-            Default is 'norm'.
+            If None, uses `daspi.CONFIG.strategy` (default 'eval').
         agreement : int or float, optional
             Specify the tolerated process variation for which the 
             control limits are to be calculated. 
@@ -2571,7 +2571,7 @@ class MultivariateChart(SingleChart):
             then interpreted as the acceptable proportion for the 
             spread, e.g. 0.9973 (which corresponds to ~ 6 sigma)
             
-            Default is 6 because SixSigma ;-)
+            If None, uses `daspi.CONFIG.agreement` (default 6).
         **kwds:
             Additional keyword arguments for configuring StripesFacets.
 

{daspi-2.7.0 → daspi-2.8.0}/daspi/plotlib/facets.py

@@ -427,7 +427,8 @@ class StripesFacets:
           distribution. The variation tolerance is then calculated as 
           agreement * standard deviation
         - data: The quantiles for the process variation tolerance are
-          read directly from the data. by default 'norm'
+          read directly from the data. by default `daspi.CONFIG.strategy`
+          ('eval')
     
     agreement : float or int, optional
         Specify the tolerated process variation for which the control 
@@ -438,7 +439,8 @@ class StripesFacets:
         calculated from this.
         If float, the value must be between 0 and 1.This value is then 
         interpreted as the acceptable proportion for the spread, e.g. 
-        0.9973 (which corresponds to ~ 6 sigma) by default 6
+        0.9973 (which corresponds to ~ 6 sigma) by default
+        `daspi.CONFIG.agreement` (6)
     **kwds : dict, optional
         Additional keyword arguments to pass to the ProcessEstimator.
     """
@@ -476,16 +478,16 @@ class StripesFacets:
         control_limits: bool = False,
         spec_limits: SpecLimits = UNBOUNDED,
         confidence: float | None = None,
-        strategy: EstimationStrategy = 'norm',
-        agreement: float | int = 6,  # noqa: PYI041
+        strategy: EstimationStrategy | None = None,
+        agreement: float | int | None = None,  # noqa: PYI041
         **kwds) -> None:
         self.single_axes = single_axes
         self._confidence = confidence
         self.estimation = ProcessEstimator(
             samples=target,
             spec_limits=spec_limits,
-            strategy=strategy,
-            agreement=agreement,
+            strategy=strategy if strategy is not None else DEFAULT.STRATEGY,
+            agreement=agreement if agreement is not None else DEFAULT.AGREEMENT,
             **kwds)
         self.target_on_y = target_on_y
         self.stripes = {s.identity: s for s in (stripes or [])}

{daspi-2.7.0 → daspi-2.8.0}/daspi/plotlib/plotter.py

@@ -6808,8 +6808,8 @@ class SpreadWidth(ErrorBar):
             source: DataFrame,
             target: str,
             feature: str = '',
-            strategy: EstimationStrategy = 'norm',
-            agreement: float | int = 6, # noqa: PYI041
+            strategy: EstimationStrategy | None = None,
+            agreement: float | int | None = None, # noqa: PYI041
             possible_dists: tuple[str | rv_continuous, ...] = DIST.COMMON,
             show_center: bool = True,
             kind: Literal['mean', 'median'] = 'mean',
@@ -6824,8 +6824,8 @@ class SpreadWidth(ErrorBar):
             **kwds) -> None:
         self._kind = 'mean'
         self.kind = kind
-        self.strategy = strategy
-        self.agreement = agreement
+        self.strategy = strategy if strategy is not None else DEFAULT.STRATEGY
+        self.agreement = agreement if agreement is not None else DEFAULT.AGREEMENT
         self.possible_dists = possible_dists
         
         super().__init__(
@@ -7812,8 +7812,8 @@ class CapabilityConfidenceInterval(ConfidenceInterval):
         `ProcessEstimator` class. Possible keword arguments are (default
         is None):
         - error_values: tuple[float, ...] = (),
-        - strategy: EstimationStrategy = 'norm',
-        - agreement: float | int = 6,
+        - strategy: EstimationStrategy = `daspi.CONFIG.strategy` (default 'eval'),
+        - agreement: float | int = `daspi.CONFIG.agreement` (default 6),
         - possible_dists: tuple[str | rv_continuous, ...] = DIST.COMMON
     
     **kwds:

{daspi-2.7.0 → daspi-2.8.0}/daspi/plotlib/precast.py

@@ -1248,10 +1248,11 @@ class ProcessCapabilityAnalysisCharts(JointChart):
             strategy: Literal['norm', 'fit', 'data'] = 'norm',
             dist: rv_continuous | str = 'norm',
             error_values: tuple[float, ...] = (),
-            agreement: float | int = 6, # noqa: PYI041
+            agreement: float | int | None = None, # noqa: PYI041
             possible_dists: tuple[str | rv_continuous, ...] = DIST.COMMON,
             stretch_figsize: bool | float | tuple[float, float] = False,
             ) -> None:
+        agreement = agreement if agreement is not None else DEFAULT.AGREEMENT
         assert not spec_limits.both_unbounded, (
             'At least one specification limit must not be None')
         assert strategy in ('norm', 'fit', 'data'), (

{daspi-2.7.0 → daspi-2.8.0}/daspi/statistics/estimation.py

@@ -1487,7 +1487,7 @@ class LocationDispersionEstimator(DistributionEstimator):
     _sem: float | None
     _lcl: float | None
     _ucl: float | None
-    _strategy: EstimationStrategy 
+    _strategy: EstimationStrategy | None
     _agreement: int | float
     _k: float
     _evaluate: Callable | None
@@ -1497,8 +1497,8 @@ class LocationDispersionEstimator(DistributionEstimator):
     def __init__(
             self,
             samples: NumericSample1D, 
-            strategy: EstimationStrategy = 'norm',
-            agreement: int | float = 6,  # noqa: PYI041
+            strategy: EstimationStrategy | None = None,
+            agreement: int | float | None = None,  # noqa: PYI041
             possible_dists: tuple[str | rv_continuous, ...] = DIST.COMMON,
             evaluate: Callable | None = None,
             nan_policy: Literal['propagate', 'raise', 'omit'] = 'omit',
@@ -1519,10 +1519,9 @@ class LocationDispersionEstimator(DistributionEstimator):
         self._ucl = None
         self._q_low = None
         self._q_upp = None
-        self._strategy = 'norm'
-        self.strategy = strategy
+        self._strategy = strategy
         self._agreement = -1
-        self.agreement = agreement
+        self.agreement = agreement if agreement is not None else DEFAULT.AGREEMENT
         self._evaluate = evaluate
         self._attrs_describe = (
             'n_samples',
@@ -1636,7 +1635,7 @@ class LocationDispersionEstimator(DistributionEstimator):
         return self._q_upp
 
     @property
-    def strategy(self) -> Literal['eval', 'fit', 'norm', 'data']:
+    def strategy(self) -> Literal['fit', 'norm', 'data']:
         """Strategy used to determine the control limits. The control 
         limits can also be interpreted as the process range.
 
@@ -1650,7 +1649,16 @@ class LocationDispersionEstimator(DistributionEstimator):
             distribution. The variation tolerance is then calculated as 
             agreement * standard deviation
             - data: The quantiles for the process variation tolerance 
-            are read directly from the samples."""
+            are read directly from the samples.
+
+        Getting this value never returns 'eval' or None: if unset, it
+        resolves to `DEFAULT.STRATEGY`, and if that is (or resolves to)
+        'eval', `evaluate()` is run immediately and its result ('fit',
+        'norm' or 'data') is stored and returned instead."""
+        if self._strategy is None:
+            self._strategy = DEFAULT.STRATEGY
+        if self._strategy == 'eval':
+            self._strategy = self.evaluate()
         return self._strategy
     @strategy.setter
     def strategy(self, strategy: EstimationStrategy) -> None:
@@ -1817,10 +1825,7 @@ class LocationDispersionEstimator(DistributionEstimator):
     
     def _calculate_control_limits_(self) -> tuple[float, float]:
         """Calculate the control limits according to given strategy
-        
-        - `eval`: first evaluate the strategy according to evaluate 
-            method. Then the limits are calculated using one of the 
-            following points.
+
         - `fit`: first fit samples to a distribution and then calculate
             quantile for this distribution according to given agreement.
         - `norm`: The control limits are calculated from the mean plus 
@@ -1829,15 +1834,16 @@ class LocationDispersionEstimator(DistributionEstimator):
         - `data`: The quantiles are calculated directly from the sample
             according the given agreement
 
+        Note that `strategy` is never 'eval' here: the `strategy`
+        property resolves 'eval' to one of 'fit', 'norm' or 'data' via
+        `evaluate()` before returning.
+
         Returns
         -------
         lcl, ucl : float
             control limits also known as process range.
         """
         match self.strategy:
-            case 'eval':
-                self.strategy = self.evaluate()
-                lcl, ucl = self._calculate_control_limits_()
             case 'fit':
                 lcl = float(self.dist.ppf(self.q_low, *self.shape_params))
                 ucl = float(self.dist.ppf(self.q_upp, *self.shape_params))
@@ -2017,8 +2023,8 @@ class ProcessEstimator(LocationDispersionEstimator):
             samples: NumericSample1D, 
             spec_limits: SpecLimits | Specification,
             error_values: tuple[float, ...] = (),
-            strategy: EstimationStrategy = 'norm',
-            agreement: float | int = 6,  # noqa: PYI041
+            strategy: EstimationStrategy | None = None,
+            agreement: float | int | None = None,  # noqa: PYI041
             possible_dists: tuple[str | rv_continuous, ...] = DIST.COMMON,
             evaluate: Callable | None = None,
             nan_policy: Literal['propagate', 'raise', 'omit'] = 'omit',

{daspi-2.7.0 → daspi-2.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "DaSPi"
-version = "2.7.0"
+version = "2.8.0"
 description = "Visualize and analyze your data with DaSPi. This package is designed for users who want to find relevant influencing factors in processes and validate improvements."
 authors = [
     { name = "Reto Jäggli", email = "reto@jaeggli.email" },

{daspi-2.7.0 → daspi-2.8.0}/tests/statistics_estimation_test.py

@@ -543,7 +543,8 @@ class TestProcessEstimator:
 
     def test_describe_with_nan_values(self) -> None:
         data = [1.0, np.nan, 3.0, 4.0, np.nan]
-        estimator = ProcessEstimator(data, SpecLimits(lower=1.5, upper=3.5))
+        estimator = ProcessEstimator(
+            data, SpecLimits(lower=1.5, upper=3.5), strategy='norm')
         result = estimator.describe()
         assert not np.isnan(result.loc['mean'][0])
         assert not np.isnan(result.loc['std'][0])