classifier-toolkit 0.5.0__tar.gz → 0.5.1__tar.gz

{classifier_toolkit-0.5.0 → classifier_toolkit-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: classifier-toolkit
-Version: 0.5.0
+Version: 0.5.1
 Project-URL: Documentation, https://supreme-adventure-jg5qkyr.pages.github.io/
 Author-email: "senih.yilmaz" <senih.yilmaz@qonto.com>, "jeremy.fraoua" <jeremy.fraoua@qonto.com>, "gauthier.marquand" <gauthier.marquand@qonto.com>, "arnaud.alepee" <arnaud.alepee@qonto.com>
 License-File: LICENSE

classifier_toolkit-0.5.1/classifier_toolkit/_typing.py

@@ -0,0 +1,6 @@
+"""Type aliases shared across the toolkit."""  # noqa: INP001
+
+from typing import Union
+
+#: A class label as found in ``y`` and ``model.classes_`` (e.g. ``pos_label``).
+ClassLabel = Union[str, int]

{classifier_toolkit-0.5.0 → classifier_toolkit-0.5.1}/classifier_toolkit/calibration/ovr_calibration.py

@@ -14,10 +14,9 @@ from typing import Dict, Optional, Sequence, Union
 
 import numpy as np
 
+from classifier_toolkit._typing import ClassLabel
 from classifier_toolkit.calibration.base import CalibrationError
 
-ClassLabel = Union[str, int]
-
 
 class OVRHistogramCalibrator:
     """Calibrate multiclass probabilities via One-vs-Rest histogram binning.

{classifier_toolkit-0.5.0 → classifier_toolkit-0.5.1}/classifier_toolkit/calibration/reliability.py

@@ -13,7 +13,7 @@ import matplotlib.pyplot as plt
 import numpy as np
 from sklearn.calibration import calibration_curve
 
-ClassLabel = Union[str, int]
+from classifier_toolkit._typing import ClassLabel
 
 
 def plot_reliability_curves(

{classifier_toolkit-0.5.0 → classifier_toolkit-0.5.1}/classifier_toolkit/eda/eda_toolkit.py

@@ -3,6 +3,8 @@ from typing import Any, Dict, List, Literal, Optional, Union
 
 import pandas as pd
 
+from classifier_toolkit._typing import ClassLabel
+
 from .bivariate_analysis import BivariateAnalysis
 from .feature_engineering import FeatureEngineering
 from .first_glance import FirstGlance
@@ -49,7 +51,7 @@ class EDAToolkit:
         id_column: Optional[str] = None,
         to_be_enc: Optional[List[str]] = None,
         warning_system: Optional[WarningSystem] = None,
-        pos_label: Optional[Union[str, int]] = None,
+        pos_label: Optional[ClassLabel] = None,
     ) -> None:
         """
         Initialize the EDAToolkit class with data and configuration settings.

{classifier_toolkit-0.5.0 → classifier_toolkit-0.5.1}/classifier_toolkit/eda/visualizations.py

@@ -1,7 +1,7 @@
 import colorsys
 import itertools
 import math
-from typing import List, Literal, Optional, Tuple, Union
+from typing import List, Literal, Optional, Tuple
 
 import matplotlib.pyplot as plt
 import numpy as np
@@ -16,6 +16,8 @@ from sklearn.preprocessing import MinMaxScaler
 from statsmodels.stats.outliers_influence import variance_inflation_factor
 from tqdm import tqdm
 
+from classifier_toolkit._typing import ClassLabel
+
 # The pos_label class is always drawn in this red; other classes cycle
 # through a palette with no reds/oranges, so it stays visually distinct.
 _POS_LABEL_COLOR = "#d62728"
@@ -39,7 +41,7 @@ class Visualizations:
         target_column: str,
         numerical_columns: List[str],
         categorical_columns: List[str],
-        pos_label: Optional[Union[str, int]] = None,
+        pos_label: Optional[ClassLabel] = None,
     ) -> None:
         """
         Initialize the Visualizations class with data and configuration.

{classifier_toolkit-0.5.0 → classifier_toolkit-0.5.1}/classifier_toolkit/explainability/base.py

@@ -6,13 +6,15 @@ from typing import Any, Optional, Union
 import numpy as np
 import pandas as pd
 
+from classifier_toolkit._typing import ClassLabel
+
 
 class ExplainabilityError(Exception):
     """Base exception for explainability errors."""
 
 
 def resolve_class_index(
-    classes: Optional[np.ndarray], label: Union[str, int], missing_reason: str
+    classes: Optional[np.ndarray], label: ClassLabel, missing_reason: str
 ) -> int:
     """Resolve a class label to its index in ``classes``.
 
@@ -87,7 +89,7 @@ class ShapResult:
         """
         return self.values.ndim == 3 and self.values.shape[-1] > 2
 
-    def class_index_for_label(self, label: Union[str, int]) -> int:
+    def class_index_for_label(self, label: ClassLabel) -> int:
         """Resolve a class label to its index along the trailing class axis.
 
         Raises
@@ -109,7 +111,7 @@ class ShapResult:
             return self.values[..., class_index]
         return self.values
 
-    def values_for_label(self, label: Union[str, int]) -> np.ndarray:
+    def values_for_label(self, label: ClassLabel) -> np.ndarray:
         """Return a 2D SHAP matrix for the given class label.
 
         For binary results, ``label`` is ignored: the positive-class 2D matrix

{classifier_toolkit-0.5.0 → classifier_toolkit-0.5.1}/classifier_toolkit/explainability/misclassification.py

@@ -7,6 +7,7 @@ from typing import Literal, Optional, Union
 import numpy as np
 import pandas as pd
 
+from classifier_toolkit._typing import ClassLabel
 from classifier_toolkit.explainability.base import ExplainabilityError
 from classifier_toolkit.explainability.plots import plot_waterfall
 from classifier_toolkit.explainability.tree_explainer import TreeSHAPExplainer
@@ -80,7 +81,7 @@ class MisclassificationAnalyzer:
         explainer: TreeSHAPExplainer,
         feature_names: Sequence[str],
         threshold: float = 0.5,
-        pos_label: Optional[Union[str, int]] = None,
+        pos_label: Optional[ClassLabel] = None,
         prediction_rule: Optional[PredictionRule] = None,
     ) -> None:
         if prediction_rule not in (None, "threshold", "argmax"):

{classifier_toolkit-0.5.0 → classifier_toolkit-0.5.1}/classifier_toolkit/explainability/plots.py

@@ -9,6 +9,7 @@ import numpy as np
 import pandas as pd
 import shap
 
+from classifier_toolkit._typing import ClassLabel
 from classifier_toolkit.explainability.base import ShapResult
 
 
@@ -54,7 +55,7 @@ def plot_summary(
 
 def plot_pos_label_summary(
     shap_result: ShapResult,
-    pos_label: Union[str, int],
+    pos_label: ClassLabel,
     max_display: int = 20,
     show: bool = True,
 ) -> None:

{classifier_toolkit-0.5.0 → classifier_toolkit-0.5.1}/classifier_toolkit/explainability/toolkit.py

@@ -6,6 +6,7 @@ from typing import Optional, Union
 import numpy as np
 import pandas as pd
 
+from classifier_toolkit._typing import ClassLabel
 from classifier_toolkit.explainability.base import ExplainabilityError, ShapResult
 from classifier_toolkit.explainability.interactions import (
     analyze_shap_interactions,
@@ -53,7 +54,7 @@ class ExplainabilityToolkit:
         categorical_features: Optional[Sequence[str]] = None,
         cat_features: Optional[list[str]] = None,
         threshold: float = 0.5,
-        pos_label: Optional[Union[str, int]] = None,
+        pos_label: Optional[ClassLabel] = None,
         prediction_rule: Optional[PredictionRule] = None,
     ) -> None:
         self.model = model

{classifier_toolkit-0.5.0 → classifier_toolkit-0.5.1}/classifier_toolkit/explainability/tree_explainer.py

@@ -7,6 +7,7 @@ import numpy as np
 import pandas as pd
 import shap
 
+from classifier_toolkit._typing import ClassLabel
 from classifier_toolkit.explainability.base import (
     ExplainabilityError,
     ShapResult,
@@ -92,7 +93,7 @@ class TreeSHAPExplainer:
         classes = getattr(self.model, "classes_", None)
         return np.asarray(classes) if classes is not None else None
 
-    def class_index_for_label(self, label: Union[str, int]) -> int:
+    def class_index_for_label(self, label: ClassLabel) -> int:
         """Resolve a class label to its index along the trailing class axis.
 
         Raises
@@ -167,7 +168,7 @@ class TreeSHAPExplainer:
     def explain_observation_for_label(
         self,
         X: Union[pd.DataFrame, pd.Series],
-        label: Union[str, int],
+        label: ClassLabel,
     ):
         """Single-row SHAP explanation restricted to one class (waterfall-ready).