Merge pull request #271 from interpretml/gaugup/AddMoreDesiredRangeValidations

Add configuration validation for desired_range

Author: gaugup

dice_ml/explainer_interfaces/dice_KD.py

@@ -89,9 +89,6 @@ def _generate_counterfactuals(self, query_instance, total_CFs, desired_range=Non
 
         query_instance[self.data_interface.outcome_name] = test_pred
         desired_class = self.misc_init(stopping_threshold, desired_class, desired_range, test_pred)
-        if desired_range is not None:
-            if desired_range[0] > desired_range[1]:
-                raise ValueError("Invalid Range!")
 
         if desired_class == "opposite" and self.model.model_type == ModelTypes.Classifier:
             if self.num_output_nodes == 2:

dice_ml/explainer_interfaces/explainer_base.py

@@ -81,6 +81,14 @@ def _validate_counterfactual_configuration(
                 raise UserConfigValidationException(
                     'The desired_range parameter should be set for regression task')
 
+        if desired_range is not None:
+            if len(desired_range) != 2:
+                raise UserConfigValidationException(
+                    "The parameter desired_range needs to have two numbers in ascending order.")
+            if desired_range[0] > desired_range[1]:
+                raise UserConfigValidationException(
+                    "The range provided in desired_range should be in ascending order.")
+
     def generate_counterfactuals(self, query_instances, total_CFs,
                                  desired_class="opposite", desired_range=None,
                                  permitted_range=None, features_to_vary="all",
@@ -96,7 +104,8 @@ def generate_counterfactuals(self, query_instances, total_CFs,
         :param desired_class: Desired counterfactual class - can take 0 or 1. Default value
                               is "opposite" to the outcome class of query_instance for binary classification.
         :param desired_range: For regression problems. Contains the outcome range to
-                              generate counterfactuals in.
+                              generate counterfactuals in. This should be a list of two numbers in
+                              ascending order.
         :param permitted_range: Dictionary with feature names as keys and permitted range in list as values.
                                 Defaults to the range inferred from training data.
                                 If None, uses the parameters initialized in data_interface.

tests/test_dice_interface/test_explainer_base.py

@@ -510,6 +510,18 @@ def test_generate_counterfactuals_user_config_validations_regression(
             explainer_function(query_instances=sample_custom_query_1,
                                total_CFs=10)
 
+        with pytest.raises(
+                UserConfigValidationException,
+                match=r'The parameter desired_range needs to have two numbers in ascending order.'):
+            explainer_function(query_instances=sample_custom_query_1,
+                               total_CFs=10, desired_range=[1, 3, 4])
+
+        with pytest.raises(
+                UserConfigValidationException,
+                match=r'The range provided in desired_range should be in ascending order.'):
+            explainer_function(query_instances=sample_custom_query_1,
+                               total_CFs=10, desired_range=[4, 3])
+
     def test_global_feature_importance_error_conditions_with_insufficient_query_points(
             self, method,
             sample_custom_query_1,