docstring fixes in new explainers

Signed-off-by: Giridhar Ganapavarapu <[email protected]>

Author: gganapavarapu

aix360/algorithms/nncontrastive/nncontrastive.py

@@ -363,7 +363,7 @@ def get_params(self, *argv, **kwargs) -> dict:
         return self._config.copy()
 
     def explain_instance(self, x, **kwargs):
-        """Explain the model prediction for an instance (local explanation).
+        """Explain (local explanation) the model prediction for provided instance(s).
 
         Args:
             x (Union[pd.DataFrame, np.ndarray]): input instance to be explained.
@@ -372,6 +372,11 @@ def explain_instance(self, x, **kwargs):
             neighbors (int): Number of neighbors
                 Overrides neighbors parameter provided in the initializer.
 
+        Returns:
+            Union(List[dict], dict): explanation object
+                Dictionary or list of dictionaries with keys: features,
+                categorical_features, query, neighbors, distances.
+
         """
         if not self.is_fitted:
             raise RuntimeError(

aix360/algorithms/tsice/tsice.py

@@ -309,7 +309,7 @@ def explain_instance(
             explain_params: Arbitrary explainer parameters.
 
         Returns:
-            Dict: explanation object
+            dict: explanation object
                 Dictionary with data_x, feature_names, feature_values, signed_impact, total_impact,
                 current_forecast, current_feature_values, perturbations and forecasts_on_perturbations.
 

aix360/algorithms/tslime/tslime.py

@@ -153,7 +153,7 @@ def explain_instance(self, ts: tsFrame, **explain_params):
             explain_params: Arbitrary explainer parameters.
 
         Returns:
-            Dict: explanation object
+            dict: explanation object
                 Dictionary with keys: input_data, history_weights, model_prediction,
                 surrogate_prediction, x_perturbations, y_perturbations.
         """

aix360/algorithms/tssaliency/tssaliency.py

@@ -106,7 +106,7 @@ def explain_instance(self, ts: tsFrame, **explain_params):
             explain_params: Arbitrary explainer parameters.
 
         Returns:
-            Dict: explanation object
+            dict: explanation object
                 Dictionary with input_data, saliency, feature_names, timestamps, base_value,
                 instance_prediction, base_value_prediction.
         """