wildboar.explain.counterfactual#
Counterfactual explanations.
The wildboar.explain.counterfactual module includes numerous
methods for generating counterfactual explanations.
Classes#
Fit a counterfactual explainer to a k-nearest neighbors classifier. |
|
Native guide counterfactual explanations. |
|
An algorithm designed to generate counterfactual explanations. |
|
Model agnostic approach for constructing counterfactual explanations. |
|
Counterfactual explanations for shapelet forest classifiers. |
Functions#
|
Compute a single counterfactual example for each sample. |
|
Compute the proximity of the counterfactuals. |
- class wildboar.explain.counterfactual.KNeighborsCounterfactual(method='auto', random_state=None)[source]#
Fit a counterfactual explainer to a k-nearest neighbors classifier.
- Parameters:
- method{“auto”, “mean”, “medoid”}, optional
The method for generating counterfactuals. If ‘auto’, counterfactuals are generated using k-means if possible and k-medoids otherwise. If ‘mean’, counterfactuals are always generated using k-means, which fails if the estimator is fitted with a metric other than ‘euclidean’, ‘dtw’ or ‘wdtw. If ‘medoid’, counterfactuals are generated using k-medoids.
Added in version 1.2.
- random_stateint or RandomState, optional
If int, random_state is the seed used by the random number generator.
If RandomState instance, random_state is the random number generator.
If None, the random number generator is the RandomState instance used by np.random.
- Attributes:
- explainer_dict
The explainer for each label
References
- Karlsson, I., Rebane, J., Papapetrou, P., & Gionis, A. (2020).
Locally and globally explainable time series tweaking. Knowledge and Information Systems, 62(5), 1671-1700.
- fit_explain(estimator, x=None, y=None, **kwargs)[source]#
Fit and return the explanation.
- Parameters:
- estimatorEstimator
The estimator to explain.
- xtime-series, optional
The input time series.
- yarray-like of shape (n_samples, ), optional
The labels.
- **kwargsdict, optional
Optional extra arguments.
- Returns:
- ndarray
The explanation.
- get_metadata_routing()[source]#
Get metadata routing of this object.
Please check User Guide on how the routing mechanism works.
- Returns:
- routingMetadataRequest
A
MetadataRequestencapsulating routing information.
- get_params(deep=True)[source]#
Get parameters for this estimator.
- Parameters:
- deepbool, default=True
If True, will return the parameters for this estimator and contained subobjects that are estimators.
- Returns:
- paramsdict
Parameter names mapped to their values.
- plot(x=None, y=None, ax=None)[source]#
Plot the explanation.
- Parameters:
- xarray-like, optional
Optional imput samples.
- yarray-like, optional
Optional target labels.
- axAxes, optional
Optional axes to plot to.
- Returns:
- Axes
The axes object.
- score(x, y)[source]#
Score the counterfactual explainer in terms of closeness of fit.
- Parameters:
- xarray-like of shape (n_samples, n_timestep)
The samples.
- yarray-like of shape (n_samples, )
The desired counterfactal label.
- Returns:
- float
The proximity.
- set_params(**params)[source]#
Set the parameters of this estimator.
The method works on simple estimators as well as on nested objects (such as
Pipeline). The latter have parameters of the form<component>__<parameter>so that it’s possible to update each component of a nested object.- Parameters:
- **paramsdict
Estimator parameters.
- Returns:
- selfestimator instance
Estimator instance.
- class wildboar.explain.counterfactual.NativeGuideCounterfactual(*, metric='euclidean', metric_params=None, importance='interval', target='predict', window=2, max_iter=100, random_state=None, n_jobs=None)[source]#
Native guide counterfactual explanations.
Counterfactual explanations are constructed by replacing parts of the explained sample with the most important region from the closest sample of the desired class.
- Parameters:
- metricstr or callable, optional
The distance metric
See
_METRICS.keys()for a list of supported metrics.- metric_paramsdict, optional
Parameters to the metric.
Read more about the parameters in the User guide.
- importance{“interval”}, array-like or callable, optional
The importance assigned to the time steps.
If “interval”, use
IntervalImportanceto assign the importance of the time steps.If array-like, an array of shape (n_timestep, ).
If callable, a function
f(x, y), where x and y are the time series and label being explained. The return value is a ndarray of shape (n_timestep, ).
- target{“predict”} or float, optional
The target evaluation of counterfactuals:
if ‘predict’ the counterfactual prediction must return the correct label.
if float, the counterfactual prediction probability must exceed target value.
- windowint, optional
The window parameter. Only used if importance=”interval”.
- max_iterint, optional
The maximum number of iterations.
- random_stateRandomState or int, optional
Pseudo-random number for consistency between different runs.
- n_jobsint, optional
The number of parallel jobs.
- Attributes:
- target_TargetEvaluator
The target evaluator.
- importance_Importance
The importance.
- estimator_Estimator
The estimator.
- clasess_ndarray
The classes known to the explainer.
Notes
The current implementation uses the
IntervalImportanceas the default method for assigning importances and selecting the time points where to grow the replacement. Unfortunately this method assigns the same score for each sample, that is, it provides a model level interpretation of the importance of each time step. To exactly replicate the work by Delaney (2021), you have to supply your own importance function. The default recommendation by the original authors is to use GradCAM.References
- Delaney, E., Greene, D., Keane, M.T. (2021)
Instance-Based Counterfactual Explanations for Time Series Classification. Case-Based Reasoning Research and Development, vol. 12877, pp. 32–47. Springer International Publishing, Cham Science.
Examples
>>> from wildboar.datasets import load_gun_point >>> from wildboar.distance import KNeighborsClassifier >>> from wildboar.explain.counterfactual import NativeGuideCounterfactual >>> X_train, X_test, y_train, y_test = load_gun_point(merge_train_test=False) >>> clf = KNeighborsClassifier(n_neighbors=1) >>> clf.fit(X_train, y_train) >>> ngc = NativeGuideCounterfactual(window=1, target=0.51) >>> ngc.fit(clf, X_train, y_train) >>> X_test[1:3] array([2., 2.], dtype=float32) >>> cf = nfc.explain(X_test[1:3], [1, 1]) # Desired label is [1, 1] >>> clf.predict(cf) array([1., 1.], dtype=float32)
- fit_explain(estimator, x=None, y=None, **kwargs)[source]#
Fit and return the explanation.
- Parameters:
- estimatorEstimator
The estimator to explain.
- xtime-series, optional
The input time series.
- yarray-like of shape (n_samples, ), optional
The labels.
- **kwargsdict, optional
Optional extra arguments.
- Returns:
- ndarray
The explanation.
- get_metadata_routing()[source]#
Get metadata routing of this object.
Please check User Guide on how the routing mechanism works.
- Returns:
- routingMetadataRequest
A
MetadataRequestencapsulating routing information.
- get_params(deep=True)[source]#
Get parameters for this estimator.
- Parameters:
- deepbool, default=True
If True, will return the parameters for this estimator and contained subobjects that are estimators.
- Returns:
- paramsdict
Parameter names mapped to their values.
- plot(x=None, y=None, ax=None)[source]#
Plot the explanation.
- Parameters:
- xarray-like, optional
Optional imput samples.
- yarray-like, optional
Optional target labels.
- axAxes, optional
Optional axes to plot to.
- Returns:
- Axes
The axes object.
- score(x, y)[source]#
Score the counterfactual explainer in terms of closeness of fit.
- Parameters:
- xarray-like of shape (n_samples, n_timestep)
The samples.
- yarray-like of shape (n_samples, )
The desired counterfactal label.
- Returns:
- float
The proximity.
- set_params(**params)[source]#
Set the parameters of this estimator.
The method works on simple estimators as well as on nested objects (such as
Pipeline). The latter have parameters of the form<component>__<parameter>so that it’s possible to update each component of a nested object.- Parameters:
- **paramsdict
Estimator parameters.
- Returns:
- selfestimator instance
Estimator instance.
- class wildboar.explain.counterfactual.NiceCounterfactual(n_neighbors=1, *, reward='compactness', metric='euclidean', metric_params=None, verbose=0)[source]#
An algorithm designed to generate counterfactual explanations.
As described by Brughmans (2024), it is designed for tabular data, addressing key requirements for real-life deployments:
Provides explanations for all predictions.
Compatible with any classification model, including non-differentiable ones.
Efficient in runtime.
Offers multiple counterfactual explanations with varying characteristics.
The algorithm leverages information from a nearest unlike neighbor to iteratively incorporating timesteps from this neighbor into the instance being explained.
- Parameters:
- n_neighborsint, optional
The number of neighbors.
- rewardstr or callable, optional
The reward function to optimize the counterfactual explanations. Can be a string specifying one of the predefined reward functions or a custom callable. The callable is a function f(original, current, current_pred, candidates, candidate_preds) that returns a ndarray of scores for each candidate.
- metricstr, optional
The distance metric to use for calculating proximity between instances. Must be one of the supported metrics.
- metric_paramsdict, optional
Additional parameters to pass to the distance metric function.
- verboseint, optional
Increase feedback. No feedback (0) and some feedback (1).
- explain(X, y)[source]#
Explain the predictions for the given data.
- Parameters:
- Xarray-like
The input data for which explanations are to be generated.
- yarray-like
The target values corresponding to the input data.
- fit(estimator, X, y)[source]#
Fit the counterfactual explanation model.
- Parameters:
- estimatorobject
The estimator object to be validated and used for fitting.
- Xarray-like of shape (n_samples, n_features)
The input samples.
- yarray-like of shape (n_samples,)
The target values.
- Returns:
- self
Returns the instance itself.
- fit_explain(estimator, x=None, y=None, **kwargs)[source]#
Fit and return the explanation.
- Parameters:
- estimatorEstimator
The estimator to explain.
- xtime-series, optional
The input time series.
- yarray-like of shape (n_samples, ), optional
The labels.
- **kwargsdict, optional
Optional extra arguments.
- Returns:
- ndarray
The explanation.
- get_metadata_routing()[source]#
Get metadata routing of this object.
Please check User Guide on how the routing mechanism works.
- Returns:
- routingMetadataRequest
A
MetadataRequestencapsulating routing information.
- get_params(deep=True)[source]#
Get parameters for this estimator.
- Parameters:
- deepbool, default=True
If True, will return the parameters for this estimator and contained subobjects that are estimators.
- Returns:
- paramsdict
Parameter names mapped to their values.
- plot(x=None, y=None, ax=None)[source]#
Plot the explanation.
- Parameters:
- xarray-like, optional
Optional imput samples.
- yarray-like, optional
Optional target labels.
- axAxes, optional
Optional axes to plot to.
- Returns:
- Axes
The axes object.
- score(x, y)[source]#
Score the counterfactual explainer in terms of closeness of fit.
- Parameters:
- xarray-like of shape (n_samples, n_timestep)
The samples.
- yarray-like of shape (n_samples, )
The desired counterfactal label.
- Returns:
- float
The proximity.
- set_params(**params)[source]#
Set the parameters of this estimator.
The method works on simple estimators as well as on nested objects (such as
Pipeline). The latter have parameters of the form<component>__<parameter>so that it’s possible to update each component of a nested object.- Parameters:
- **paramsdict
Estimator parameters.
- Returns:
- selfestimator instance
Estimator instance.
- class wildboar.explain.counterfactual.PrototypeCounterfactual(metric='euclidean', *, r=1.0, g=0.05, max_iter=100, step_size='adaptive', n_prototypes='auto', target='predict', method='sample', sampling_temperature=1.0, optimizer='greedy', beam_width=5, n_branches=3, refine=['path', 'global'], refine_iter=5, min_shapelet_size=0.0, max_shapelet_size=1.0, n_shapelets=1000, k_best_shapelets=10, random_state=None, n_jobs=None)[source]#
Model agnostic approach for constructing counterfactual explanations.
This method generates counterfactual explanations by iteratively moving a sample toward prototypes of the target class until the classifier’s prediction changes. The movement is guided by the selected metric (Euclidean or DTW-based), and the process can be optimized using different search strategies.
- Parameters:
- metric{‘euclidean’, ‘dtw’, ‘wdtw’}, optional
The distance metric used to compute the movement direction toward prototypes.
‘euclidean’: Standard Euclidean distance. Fast but sensitive to temporal misalignment.
‘dtw’: Dynamic Time Warping. Handles temporal shifts but slower.
‘wdtw’: Weighted DTW with penalty for large warping. Balances flexibility and stability.
- rfloat, optional
The Sakoe-Chiba warping window size as a fraction of the time series length. Only used when
metric='dtw'ormetric='wdtw'. A value of 1.0 allows unrestricted warping, while smaller values constrain the warping path to stay close to the diagonal. Default is 1.0.- gfloat, optional
The penalty parameter for weighted DTW. Only used when
metric='wdtw'. Controls how much large warpings are penalized. Larger values result in behavior closer to Euclidean distance. Default is 0.05.- max_iterint, optional
Maximum number of iterations for the optimization process. The search terminates when this limit is reached, even if no valid counterfactual has been found. Default is 100.
- step_size{“adaptive”} or float, optional
Controls how far the sample moves toward the prototype at each step.
‘adaptive’: Automatically estimates an appropriate step size using a Lipschitz-based estimate of the distance to the decision boundary. This typically leads to faster convergence.
float: Uses a fixed step size computed as
step_size * mean_dist, wheremean_distis the mean positive pairwise distance in the training data. For example,step_size=0.2moves 20% of the typical inter-sample spacing per iteration.
Default is ‘adaptive’.
- n_prototypesint, float, or {‘auto’}, optional
The number of prototypes to consider when selecting movement targets.
‘auto’: Automatically determines the number based on dataset size.
int: Uses exactly this many prototypes per class.
float: Uses this fraction of training samples per class as prototypes.
Default is ‘auto’.
- sampling_temperaturefloat, optional
Temperature parameter for prototype sampling when
methodis ‘nearest’ or ‘nearest_shapelet’. Controls the randomness of prototype selection using softmax weighting:exp(-distance / temperature).High values (e.g., 10.0): More uniform sampling across prototypes.
Low values (e.g., 0.1): Greedy selection of nearest prototypes.
1.0: Balanced sampling weighted by distance.
Default is 1.0.
- targetfloat or {‘predict’}, optional
Defines when a counterfactual is considered successful.
‘predict’: The counterfactual is valid when the classifier’s predicted probability for the target class becomes the argmax.
float (0.5-1.0): The counterfactual is valid when the predicted probability for the target class exceeds this threshold. Higher values produce more confident counterfactuals but may require larger modifications.
Default is ‘predict’.
- method{‘sample’, ‘shapelet’, ‘nearest’, ‘nearest_shapelet’, ‘discriminative_shapelet’}, optional
Strategy for selecting prototypes to move toward.
‘sample’: Uniformly samples a prototype from all training samples of the target class.
‘shapelet’: Samples a shapelet (subsequence) from a randomly selected prototype. Produces more localized changes.
‘nearest’: Samples from the k-nearest prototypes to the current sample, weighted by distance and temperature.
‘nearest_shapelet’: Combines ‘nearest’ and ‘shapelet’ - samples shapelets from nearby prototypes.
‘discriminative_shapelet’: Uses shapelets that are most discriminative between classes, based on Cohen’s d effect size.
Default is ‘sample’.
- optimizer{‘greedy’, ‘best_first’, ‘beam’}, optional
Search strategy for finding counterfactuals.
‘greedy’: At each step, commits to a single move. Fast but may get stuck in local optima.
‘best_first’: Explores the most promising states first using a priority queue. More thorough but slower.
‘beam’: Maintains multiple candidate solutions in parallel, keeping the top
beam_widthcandidates at each step. Balances exploration and efficiency.
Default is ‘greedy’.
- beam_widthint, optional
Number of candidate solutions to maintain when
optimizer='beam'. Larger values explore more of the search space but increase computation time. Default is 5.- n_branchesint, optional
Number of different moves to try from each state during expansion. Only used when
optimizeris ‘best_first’ or ‘beam’. Higher values increase diversity but slow down the search. Default is 3.- refinestr, list, callable, or None, optional
Refinement strategy applied after finding a valid counterfactual to minimize the distance from the original sample while maintaining validity.
None: No refinement. Returns the counterfactual as-is.
‘path’: Backtracks along the search path to find the minimal modification that still produces a valid counterfactual.
‘global’: Nudges the counterfactual back toward the original sample in small steps until validity is lost.
callable: Custom refinement function with signature
(cf, x_original, y_target, path, target_evaluator) -> cf_refined.list: Applies multiple refinements in sequence (e.g.,
['path', 'global']).
Default is
['path', 'global'].- refine_iterint, optional
Maximum number of iterations for each built-in refinement strategy. Higher values may produce closer counterfactuals but increase computation time. Ignored for custom callable refinements. Default is 5.
- min_shapelet_sizefloat, optional
Minimum shapelet length as a fraction of the time series length. Only used when
methodis ‘shapelet’, ‘nearest_shapelet’, or ‘discriminative_shapelet’. Default is 0.0 (no minimum).- max_shapelet_sizefloat, optional
Maximum shapelet length as a fraction of the time series length. Only used when
methodis ‘shapelet’, ‘nearest_shapelet’, or ‘discriminative_shapelet’. Default is 1.0 (full length).- n_shapeletsint, optional
Number of candidate shapelets to extract during shapelet discovery. Only used when
method='discriminative_shapelet'. More candidates increase the chance of finding discriminative patterns but slow down fitting. Default is 1000.- k_best_shapeletsint, optional
Number of top-scoring shapelets to retain per class. Only used when
method='discriminative_shapelet'. Shapelets are ranked by Cohen’s d effect size. Default is 10.- random_stateint, RandomState instance, or None, optional
Controls randomness for reproducibility. Pass an int for reproducible results across multiple function calls. Default is None.
- n_jobsint or None, optional
Number of parallel jobs for shapelet extraction. Only used when
method='discriminative_shapelet'. None means 1 job, -1 means using all processors. Default is None.
- Attributes:
- estimator_object
The fitted estimator for which counterfactuals are computed.
- classes_ndarray of shape (n_classes,)
The unique class labels from the training data.
- partitions_dict
Dictionary mapping each class label to its corresponding PrototypeSampler instance containing the prototypes for that class.
- target_TargetEvaluator
The evaluator used to determine if a candidate counterfactual is valid (either PredictEvaluator or ProbabilityEvaluator depending on the
targetparameter).
References
- Samsten, Isak (2020).
Model agnostic time series counterfactuals
- fit_explain(estimator, x=None, y=None, **kwargs)[source]#
Fit and return the explanation.
- Parameters:
- estimatorEstimator
The estimator to explain.
- xtime-series, optional
The input time series.
- yarray-like of shape (n_samples, ), optional
The labels.
- **kwargsdict, optional
Optional extra arguments.
- Returns:
- ndarray
The explanation.
- get_metadata_routing()[source]#
Get metadata routing of this object.
Please check User Guide on how the routing mechanism works.
- Returns:
- routingMetadataRequest
A
MetadataRequestencapsulating routing information.
- get_params(deep=True)[source]#
Get parameters for this estimator.
- Parameters:
- deepbool, default=True
If True, will return the parameters for this estimator and contained subobjects that are estimators.
- Returns:
- paramsdict
Parameter names mapped to their values.
- plot(x=None, y=None, ax=None)[source]#
Plot the explanation.
- Parameters:
- xarray-like, optional
Optional imput samples.
- yarray-like, optional
Optional target labels.
- axAxes, optional
Optional axes to plot to.
- Returns:
- Axes
The axes object.
- score(x, y)[source]#
Score the counterfactual explainer in terms of closeness of fit.
- Parameters:
- xarray-like of shape (n_samples, n_timestep)
The samples.
- yarray-like of shape (n_samples, )
The desired counterfactal label.
- Returns:
- float
The proximity.
- set_params(**params)[source]#
Set the parameters of this estimator.
The method works on simple estimators as well as on nested objects (such as
Pipeline). The latter have parameters of the form<component>__<parameter>so that it’s possible to update each component of a nested object.- Parameters:
- **paramsdict
Estimator parameters.
- Returns:
- selfestimator instance
Estimator instance.
- class wildboar.explain.counterfactual.ShapeletForestCounterfactual(*, cost='euclidean', aggregation='mean', epsilon=1.0, batch_size=0.1, max_paths=1.0, verbose=False, random_state=None)[source]#
Counterfactual explanations for shapelet forest classifiers.
- Parameters:
- cost{“euclidean”, “cosine”, “manhattan”} or callable, optional
The cost function to determine the goodness of counterfactual.
- aggregationcallable, optional
The aggregation function for the cost of multivariate counterfactuals.
- epsilonfloat, optional
Control the degree of change from the decision threshold.
- batch_sizefloat, optional
Batch size when evaluating the cost and predictions of counterfactual candidates. The default setting is to evaluate all counterfactual samples.
Changed in version 1.1: The default value changed to 0.1
- max_pathsfloat, optional
Sample a fraction of the positive prediction paths.
Added in version 1.1: Add support for subsampling prediction paths.
- verbosebool, optional
Print information to stdout during execution.
- random_stateRandomState or int, optional
Pseudo-random number for consistency between different runs.
- Attributes:
- paths_dict
A dictionary of prediction paths per label
Warning
Only shapelet forests fit with the Euclidean distance is supported i.e.,
metric="euclidean"Notes
This implementation only supports the reversible algorithm described by Karlsson (2020)
References
- Karlsson, I., Rebane, J., Papapetrou, P., & Gionis, A. (2020).
Locally and globally explainable time series tweaking. Knowledge and Information Systems, 62(5), 1671-1700.
- Karlsson, I., Rebane, J., Papapetrou, P., & Gionis, A. (2018).
Explainable time series tweaking via irreversible and reversible temporal transformations. In 2018 IEEE International Conference on Data Mining (ICDM)
- fit_explain(estimator, x=None, y=None, **kwargs)[source]#
Fit and return the explanation.
- Parameters:
- estimatorEstimator
The estimator to explain.
- xtime-series, optional
The input time series.
- yarray-like of shape (n_samples, ), optional
The labels.
- **kwargsdict, optional
Optional extra arguments.
- Returns:
- ndarray
The explanation.
- get_metadata_routing()[source]#
Get metadata routing of this object.
Please check User Guide on how the routing mechanism works.
- Returns:
- routingMetadataRequest
A
MetadataRequestencapsulating routing information.
- get_params(deep=True)[source]#
Get parameters for this estimator.
- Parameters:
- deepbool, default=True
If True, will return the parameters for this estimator and contained subobjects that are estimators.
- Returns:
- paramsdict
Parameter names mapped to their values.
- plot(x=None, y=None, ax=None)[source]#
Plot the explanation.
- Parameters:
- xarray-like, optional
Optional imput samples.
- yarray-like, optional
Optional target labels.
- axAxes, optional
Optional axes to plot to.
- Returns:
- Axes
The axes object.
- score(x, y)[source]#
Score the counterfactual explainer in terms of closeness of fit.
- Parameters:
- xarray-like of shape (n_samples, n_timestep)
The samples.
- yarray-like of shape (n_samples, )
The desired counterfactal label.
- Returns:
- float
The proximity.
- set_params(**params)[source]#
Set the parameters of this estimator.
The method works on simple estimators as well as on nested objects (such as
Pipeline). The latter have parameters of the form<component>__<parameter>so that it’s possible to update each component of a nested object.- Parameters:
- **paramsdict
Estimator parameters.
- Returns:
- selfestimator instance
Estimator instance.
- wildboar.explain.counterfactual.counterfactuals(estimator, x, y, *, train_x=None, train_y=None, method='best', proximity=None, random_state=None, method_args=None)[source]#
Compute a single counterfactual example for each sample.
- Parameters:
- estimatorobject
The estimator used to compute the counterfactual example.
- xarray-like of shape (n_samples, n_timestep)
The data samples to fit counterfactuals to.
- yarray-like broadcast to shape (n_samples,)
The desired label of the counterfactual.
- train_xarray-like of shape (n_samples, n_timestep), optional
Training samples if required by the explainer.
- train_yarray-like of shape (n_samples, ), optional
Training labels if required by the explainer.
- methodstr or BaseCounterfactual, optional
The method to generate counterfactual explanations
if ‘best’, infer the most appropriate counterfactual explanation method based on the estimator.
Changed in version 1.1.0.
if str, select counterfactual explainer from named collection. See
_COUNTERFACTUALS.keys()for a list of valid values.if, BaseCounterfactual use the supplied counterfactual.
- proximitystr, callable, list or dict, optional
The scoring function to determine the similarity between the counterfactual sample and the original sample.
- random_stateRandomState or int, optional
The pseudo random number generator to ensure stable result.
- method_argsdict, optional
Optional arguments to the counterfactual explainer.
Added in version 1.1.0.
- Returns:
- x_counterfactualsndarray of shape (n_samples, n_timestep)
The counterfactual example.
- validndarray of shape (n_samples,)
Indicator matrix for valid counterfactuals.
- scorendarray of shape (n_samples,) or dict, optional
Return score of the counterfactual transform, if
scoringis not None.
- wildboar.explain.counterfactual.proximity(x_true, x_counterfactuals, metric='normalized_euclidean', metric_params=None)[source]#
Compute the proximity of the counterfactuals.
- Parameters:
- x_truearray-like of shape (n_samples, n_timestep)
The true samples.
- x_counterfactualsarray-like of shape (n_samples, n_timestep)
The counterfactual samples.
- metricstr or callable, optional
The distance metric
See
_METRICS.keys()for a list of supported metrics.- metric_paramsdict, optional
Parameters to the metric.
Read more about the parameters in the User guide.
- Returns:
- ndarray
The scores.