MTN: move mapie_v1/ conformity scores related code in mapie/, remove mapie_v1/_version.py (#676)

Author: Valentin-Laurent

mapie/classification.py

@@ -22,14 +22,13 @@
 from mapie.conformity_scores.sets.raps import RAPSConformityScore
 from mapie.conformity_scores.utils import (
     check_depreciated_size_raps, check_classification_conformity_score,
-    check_target
+    check_target, check_and_select_conformity_score,
 )
 from mapie.estimator.classifier import EnsembleClassifier
 from mapie.utils import (_check_alpha, _check_alpha_and_n_samples, _check_cv,
                          _check_estimator_classification, _check_n_features_in,
                          _check_n_jobs, _check_null_weight, _check_predict_params,
                          _check_verbose)
-from mapie_v1.conformity_scores._utils import check_and_select_conformity_score
 from mapie.utils import (
     _transform_confidence_level_to_alpha_list,
     _raise_error_if_fit_called_in_prefit_mode,

mapie/conformity_scores/utils.py

@@ -1,17 +1,53 @@
-from typing import Optional
+from typing import Optional, no_type_check
 import warnings
 
-from sklearn.utils.multiclass import (check_classification_targets,
-                                      type_of_target)
+from sklearn.utils.multiclass import (
+    check_classification_targets,
+    type_of_target,
+)
 
 from .regression import BaseRegressionScore
 from .classification import BaseClassificationScore
-from .bounds import AbsoluteConformityScore
-from .sets import LACConformityScore
+from .bounds import (
+    AbsoluteConformityScore,
+    GammaConformityScore,
+    ResidualNormalisedScore,
+)
+from .sets import (
+    LACConformityScore,
+    TopKConformityScore,
+    APSConformityScore,
+    RAPSConformityScore,
+)
 
 from numpy.typing import ArrayLike
 
 
+CONFORMITY_SCORES_STRING_MAP = {
+    BaseRegressionScore: {
+        "absolute": AbsoluteConformityScore,
+        "gamma": GammaConformityScore,
+        "residual_normalized": ResidualNormalisedScore,
+    },
+    BaseClassificationScore: {
+        "lac": LACConformityScore,
+        "top_k": TopKConformityScore,
+        "aps": APSConformityScore,
+        "raps": RAPSConformityScore,
+    },
+}
+
+
+@no_type_check  # Cumbersome to type
+def check_and_select_conformity_score(conformity_score, conformity_score_type):
+    if isinstance(conformity_score, conformity_score_type):
+        return conformity_score
+    elif conformity_score in CONFORMITY_SCORES_STRING_MAP[conformity_score_type]:
+        return CONFORMITY_SCORES_STRING_MAP[conformity_score_type][conformity_score]()
+    else:
+        raise ValueError("Invalid conformity_score parameter")
+
+
 def check_regression_conformity_score(
     conformity_score: Optional[BaseRegressionScore],
     sym: bool = True,

mapie/regression/regression.py

@@ -14,15 +14,17 @@
 from numpy.typing import ArrayLike, NDArray
 from mapie.conformity_scores import (BaseRegressionScore,
                                      ResidualNormalisedScore)
-from mapie.conformity_scores.utils import check_regression_conformity_score
+from mapie.conformity_scores.utils import (
+    check_regression_conformity_score,
+    check_and_select_conformity_score,
+)
 from mapie.estimator.regressor import EnsembleRegressor
 from mapie.subsample import Subsample
 from mapie.utils import (_check_alpha, _check_alpha_and_n_samples,
                          _check_cv, _check_estimator_fit_predict,
                          _check_n_features_in, _check_n_jobs, _check_null_weight,
                          _check_verbose, _get_effective_calibration_samples,
                          _check_predict_params)
-from mapie_v1.conformity_scores._utils import check_and_select_conformity_score
 from mapie.utils import (
     _transform_confidence_level_to_alpha_list,
     _check_if_param_in_allowed_values,

mapie_v1/__init__.py

@@ -0,0 +1,37 @@
+import pytest
+
+from mapie.conformity_scores.utils import (
+    check_and_select_conformity_score,
+)
+from mapie.conformity_scores.regression import BaseRegressionScore
+from mapie.conformity_scores.classification import BaseClassificationScore
+from mapie.conformity_scores.bounds import (
+    AbsoluteConformityScore,
+    GammaConformityScore,
+)
+from mapie.conformity_scores.sets import (
+    LACConformityScore,
+    TopKConformityScore,
+)
+
+
+class TestCheckAndSelectConformityScore:
+
+    @pytest.mark.parametrize(
+        "score, score_type, expected_class", [
+            (AbsoluteConformityScore(), BaseRegressionScore, AbsoluteConformityScore),
+            ("gamma", BaseRegressionScore, GammaConformityScore),
+            (LACConformityScore(), BaseClassificationScore, LACConformityScore),
+            ("top_k", BaseClassificationScore, TopKConformityScore),
+        ]
+    )
+    def test_with_valid_inputs(self, score, score_type, expected_class):
+        result = check_and_select_conformity_score(score, score_type)
+        assert isinstance(result, expected_class)
+
+    @pytest.mark.parametrize(
+        "score_type", [BaseRegressionScore, BaseClassificationScore]
+    )
+    def test_with_invalid_input(self, score_type):
+        with pytest.raises(ValueError):
+            check_and_select_conformity_score("I'm not a valid input :(", score_type)