v0.5.8
Overview
Getting Started
Algorithm overview
Saving and loading
Roadmap
Methods
Accumulated Local Effects
Anchors
Contrastive Explanation Method
Counterfactual Instances
Counterfactuals Guided by Prototypes
Integrated Gradients
Kernel SHAP
Measuring the linearity of machine learning models
Trust Scores
Tree SHAP
Examples
Accumulated Local Effects for predicting house prices
Accumulated Local Effects for classifying flowers
Anchor explanations for income prediction
Anchor explanations on the Iris dataset
Anchor explanations for movie sentiment
Anchor explanations for ImageNet
Anchor explanations for fashion MNIST
Contrastive Explanations Method (CEM) applied to MNIST
Contrastive Explanations Method (CEM) applied to Iris dataset
Counterfactual instances on MNIST
Counterfactuals guided by prototypes on MNIST
Counterfactuals guided by prototypes on Boston housing dataset
Counterfactual explanations with one-hot encoded categorical variables
Counterfactual explanations with ordinally encoded categorical variables
Kernel SHAP explanation for SVM models
Kernel SHAP explanation for multinomial logistic regression models
Handling categorical variables with KernelSHAP
KernelSHAP: combining preprocessor and predictor
Distributed KernelSHAP
Linearity measure applied to Iris
Linearity measure applied to fashion MNIST
Trust Scores applied to Iris
Trust Scores applied to MNIST
Explaining Tree Models with Interventional Feature Perturbation Tree SHAP
Explaining Tree Models with Path-Dependent Feature Perturbation Tree SHAP
Integrated gradients for a ResNet model trained on Imagenet dataset
Integrated gradients for MNIST
Integrated gradients for text classification on the IMDB dataset
API reference
API reference
Alibi
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
_
__attrs_post_init__() (alibi.api.interfaces.Explanation method)
__call__() (alibi.explainers.anchor_tabular.RemoteSampler method)
(alibi.explainers.anchor_tabular.TabularSampler method)
__getattr__() (alibi.utils.distributed.DistributedExplainer method)
(alibi.utils.distributed.PoolCollection method)
__getitem__() (alibi.api.interfaces.Explanation method)
__init__() (alibi.confidence.LinearityMeasure method)
(alibi.confidence.model_linearity.LinearityMeasure method)
(alibi.confidence.TrustScore method)
(alibi.confidence.trustscore.TrustScore method)
(alibi.explainers.ALE method)
(alibi.explainers.ale.ALE method)
(alibi.explainers.anchor_base.AnchorBaseBeam method)
(alibi.explainers.anchor_explanation.AnchorExplanation method)
(alibi.explainers.anchor_image.AnchorImage method)
(alibi.explainers.anchor_tabular.AnchorTabular method)
(alibi.explainers.anchor_tabular.TabularSampler method)
(alibi.explainers.anchor_text.AnchorText method)
(alibi.explainers.anchor_text.Neighbors method)
(alibi.explainers.AnchorImage method)
(alibi.explainers.AnchorTabular method)
(alibi.explainers.AnchorText method)
(alibi.explainers.CEM method)
(alibi.explainers.cem.CEM method)
(alibi.explainers.cfproto.CounterFactualProto method)
(alibi.explainers.CounterFactual method)
(alibi.explainers.counterfactual.CounterFactual method)
(alibi.explainers.CounterFactualProto method)
(alibi.explainers.integrated_gradients.IntegratedGradients method)
(alibi.explainers.IntegratedGradients method)
(alibi.explainers.KernelShap method)
(alibi.explainers.shap_wrappers.KernelExplainerWrapper method)
(alibi.explainers.shap_wrappers.KernelShap method)
(alibi.explainers.shap_wrappers.TreeShap method)
(alibi.explainers.TreeShap method)
(alibi.tests.utils.MockPredictor method)
(alibi.utils.discretizer.Discretizer method)
(alibi.utils.distributed.ActorPool method)
(alibi.utils.distributed.DistributedExplainer method)
(alibi.utils.distributed.PoolCollection method)
A
abdm() (in module alibi.utils.distance)
actor_index() (alibi.utils.distributed.DistributedExplainer property)
ActorPool (class in alibi.utils.distributed)
adaptive_grid() (in module alibi.explainers.ale)
add_names_to_exp() (alibi.explainers.anchor_tabular.AnchorTabular method)
(alibi.explainers.AnchorTabular method)
ALE (class in alibi.explainers)
(class in alibi.explainers.ale)
ale_num() (in module alibi.explainers.ale)
alibi (module)
alibi.api (module)
alibi.api.defaults (module)
alibi.api.interfaces (module)
alibi.confidence (module)
alibi.confidence.model_linearity (module)
alibi.confidence.trustscore (module)
alibi.datasets (module)
alibi.explainers (module)
alibi.explainers.ale (module)
alibi.explainers.anchor_base (module)
alibi.explainers.anchor_explanation (module)
alibi.explainers.anchor_image (module)
alibi.explainers.anchor_tabular (module)
alibi.explainers.anchor_text (module)
alibi.explainers.cem (module)
alibi.explainers.cfproto (module)
alibi.explainers.counterfactual (module)
alibi.explainers.integrated_gradients (module)
alibi.explainers.shap_wrappers (module)
alibi.saving (module)
alibi.tests (module)
alibi.tests.utils (module)
alibi.utils (module)
alibi.utils.approximation_methods (module)
alibi.utils.data (module)
alibi.utils.discretizer (module)
alibi.utils.distance (module)
alibi.utils.distributed (module)
alibi.utils.distributions (module)
alibi.utils.download (module)
alibi.utils.gradients (module)
alibi.utils.mapping (module)
alibi.utils.tf (module)
alibi.utils.wrappers (module)
alibi.version (module)
AlibiPrettyPrinter (class in alibi.api.interfaces)
anchor_beam() (alibi.explainers.anchor_base.AnchorBaseBeam method)
AnchorBaseBeam (class in alibi.explainers.anchor_base)
AnchorExplanation (class in alibi.explainers.anchor_explanation)
AnchorImage (class in alibi.explainers)
(class in alibi.explainers.anchor_image)
AnchorTabular (class in alibi.explainers)
(class in alibi.explainers.anchor_tabular)
AnchorText (class in alibi.explainers)
(class in alibi.explainers.anchor_text)
approximation_parameters() (in module alibi.utils.approximation_methods)
argmax_grad() (in module alibi.utils.tf)
ArgmaxTransformer (class in alibi.utils.wrappers)
argmin_grad() (in module alibi.utils.tf)
assert_message_in_logs() (in module alibi.tests.utils)
attack() (alibi.explainers.CEM method)
(alibi.explainers.cem.CEM method)
(alibi.explainers.cfproto.CounterFactualProto method)
(alibi.explainers.CounterFactualProto method)
B
batch() (in module alibi.utils.distributed)
bins() (alibi.utils.discretizer.Discretizer method)
bisect_fun() (in module alibi.explainers.ale)
build_explanation() (alibi.explainers.ALE method)
(alibi.explainers.ale.ALE method)
(alibi.explainers.anchor_image.AnchorImage method)
(alibi.explainers.anchor_tabular.AnchorTabular method)
(alibi.explainers.anchor_text.AnchorText method)
(alibi.explainers.AnchorImage method)
(alibi.explainers.AnchorTabular method)
(alibi.explainers.AnchorText method)
(alibi.explainers.integrated_gradients.IntegratedGradients method)
(alibi.explainers.IntegratedGradients method)
(alibi.explainers.KernelShap method)
(alibi.explainers.shap_wrappers.KernelShap method)
(alibi.explainers.shap_wrappers.TreeShap method)
(alibi.explainers.TreeShap method)
build_lookups() (alibi.explainers.anchor_tabular.RemoteSampler method)
(alibi.explainers.anchor_tabular.TabularSampler method)
Bunch (class in alibi.utils.data)
C
CEM (class in alibi.explainers)
(class in alibi.explainers.cem)
check_ray() (in module alibi.utils.distributed)
cityblock_batch() (in module alibi.utils.distance)
compare_labels() (alibi.explainers.anchor_image.AnchorImage method)
(alibi.explainers.anchor_tabular.TabularSampler method)
(alibi.explainers.anchor_text.AnchorText method)
(alibi.explainers.AnchorImage method)
(alibi.explainers.AnchorText method)
compute_beta() (alibi.explainers.anchor_base.AnchorBaseBeam static method)
concatenate_minibatches() (in module alibi.utils.distributed)
CounterFactual (class in alibi.explainers)
(class in alibi.explainers.counterfactual)
CounterFactualProto (class in alibi.explainers)
(class in alibi.explainers.cfproto)
coverage() (alibi.explainers.anchor_explanation.AnchorExplanation method)
create_explainer_handles() (alibi.utils.distributed.PoolCollection static method)
create_parallel_pool() (alibi.utils.distributed.DistributedExplainer method)
D
default() (alibi.saving.NumpyEncoder method)
DEFAULT_DATA_ALE (in module alibi.api.defaults)
DEFAULT_DATA_ANCHOR (in module alibi.api.defaults)
DEFAULT_DATA_ANCHOR_IMG (in module alibi.api.defaults)
DEFAULT_DATA_CEM (in module alibi.api.defaults)
DEFAULT_DATA_CF (in module alibi.api.defaults)
DEFAULT_DATA_CFP (in module alibi.api.defaults)
DEFAULT_DATA_INTGRAD (in module alibi.api.defaults)
DEFAULT_DATA_KERNEL_SHAP (in module alibi.api.defaults)
DEFAULT_DATA_TREE_SHAP (in module alibi.api.defaults)
default_meta() (in module alibi.api.interfaces)
DEFAULT_META_ALE (in module alibi.api.defaults)
DEFAULT_META_ANCHOR (in module alibi.api.defaults)
DEFAULT_META_CEM (in module alibi.api.defaults)
DEFAULT_META_CF (in module alibi.api.defaults)
DEFAULT_META_CFP (in module alibi.api.defaults)
DEFAULT_META_INTGRAD (in module alibi.api.defaults)
DEFAULT_META_KERNEL_SHAP (in module alibi.api.defaults)
DEFAULT_META_TREE_SHAP (in module alibi.api.defaults)
default_target_fcn() (in module alibi.utils.distributed)
deferred_init() (alibi.explainers.anchor_tabular.TabularSampler method)
discretize() (alibi.utils.discretizer.Discretizer method)
Discretizer (class in alibi.utils.discretizer)
DISTRIBUTED_OPTS (in module alibi.explainers.shap_wrappers)
DistributedAnchorBaseBeam (class in alibi.explainers.anchor_base)
DistributedAnchorTabular (class in alibi.explainers)
(class in alibi.explainers.anchor_tabular)
DistributedExplainer (class in alibi.utils.distributed)
dlow_bernoulli() (alibi.explainers.anchor_base.AnchorBaseBeam static method)
draw_samples() (alibi.explainers.anchor_base.AnchorBaseBeam method)
(alibi.explainers.anchor_base.DistributedAnchorBaseBeam method)
dup_bernoulli() (alibi.explainers.anchor_base.AnchorBaseBeam static method)
E
examples() (alibi.explainers.anchor_explanation.AnchorExplanation method)
explain() (alibi.api.interfaces.Explainer method)
(alibi.explainers.ALE method)
(alibi.explainers.ale.ALE method)
(alibi.explainers.anchor_image.AnchorImage method)
(alibi.explainers.anchor_tabular.AnchorTabular method)
(alibi.explainers.anchor_tabular.DistributedAnchorTabular method)
(alibi.explainers.anchor_text.AnchorText method)
(alibi.explainers.AnchorImage method)
(alibi.explainers.AnchorTabular method)
(alibi.explainers.AnchorText method)
(alibi.explainers.CEM method)
(alibi.explainers.cem.CEM method)
(alibi.explainers.cfproto.CounterFactualProto method)
(alibi.explainers.CounterFactual method)
(alibi.explainers.counterfactual.CounterFactual method)
(alibi.explainers.CounterFactualProto method)
(alibi.explainers.DistributedAnchorTabular method)
(alibi.explainers.integrated_gradients.IntegratedGradients method)
(alibi.explainers.IntegratedGradients method)
(alibi.explainers.KernelShap method)
(alibi.explainers.shap_wrappers.KernelShap method)
(alibi.explainers.shap_wrappers.TreeShap method)
(alibi.explainers.TreeShap method)
Explainer (class in alibi.api.interfaces)
Explanation (class in alibi.api.interfaces)
F
features() (alibi.explainers.anchor_explanation.AnchorExplanation method)
fetch_adult() (in module alibi.datasets)
fetch_fashion_mnist() (in module alibi.datasets)
fetch_imagenet() (in module alibi.datasets)
fetch_movie_sentiment() (in module alibi.datasets)
filter_by_distance_knn() (alibi.confidence.TrustScore method)
(alibi.confidence.trustscore.TrustScore method)
filter_by_probability_knn() (alibi.confidence.TrustScore method)
(alibi.confidence.trustscore.TrustScore method)
find_similar_words() (alibi.explainers.anchor_text.AnchorText method)
(alibi.explainers.AnchorText method)
fit() (alibi.api.interfaces.FitMixin method)
(alibi.confidence.LinearityMeasure method)
(alibi.confidence.model_linearity.LinearityMeasure method)
(alibi.confidence.TrustScore method)
(alibi.confidence.trustscore.TrustScore method)
(alibi.explainers.anchor_tabular.AnchorTabular method)
(alibi.explainers.anchor_tabular.DistributedAnchorTabular method)
(alibi.explainers.AnchorTabular method)
(alibi.explainers.CEM method)
(alibi.explainers.cem.CEM method)
(alibi.explainers.cfproto.CounterFactualProto method)
(alibi.explainers.CounterFactual method)
(alibi.explainers.counterfactual.CounterFactual method)
(alibi.explainers.CounterFactualProto method)
(alibi.explainers.DistributedAnchorTabular method)
(alibi.explainers.KernelShap method)
(alibi.explainers.shap_wrappers.KernelShap method)
(alibi.explainers.shap_wrappers.TreeShap method)
(alibi.explainers.TreeShap method)
FitMixin (class in alibi.api.interfaces)
from_json() (alibi.api.interfaces.Explanation class method)
G
gauss_legendre_builders() (in module alibi.utils.approximation_methods)
gen_category_map() (in module alibi.utils.data)
generate_superpixels() (alibi.explainers.anchor_image.AnchorImage method)
(alibi.explainers.AnchorImage method)
get_anchor_metadata() (alibi.explainers.anchor_base.AnchorBaseBeam method)
get_explanation() (alibi.explainers.shap_wrappers.KernelExplainerWrapper method)
(alibi.utils.distributed.DistributedExplainer method)
(alibi.utils.distributed.PoolCollection method)
get_features_index() (alibi.explainers.anchor_tabular.TabularSampler method)
get_gradients() (alibi.explainers.CEM method)
(alibi.explainers.cem.CEM method)
(alibi.explainers.cfproto.CounterFactualProto method)
(alibi.explainers.CounterFactualProto method)
get_init_stats() (alibi.explainers.anchor_base.AnchorBaseBeam method)
get_next() (alibi.utils.distributed.ActorPool method)
get_next_unordered() (alibi.utils.distributed.ActorPool method)
get_percentiles() (alibi.utils.discretizer.Discretizer static method)
get_quantiles() (in module alibi.explainers.ale)
H
handle_unk_features() (alibi.explainers.anchor_tabular.TabularSampler method)
has_next() (alibi.utils.distributed.ActorPool method)
I
IntegratedGradients (class in alibi.explainers)
(class in alibi.explainers.integrated_gradients)
invert_permutation() (in module alibi.utils.distributed)
issorted() (in module alibi.tests.utils)
K
KERNEL_SHAP_PARAMS (in module alibi.api.defaults)
KernelExplainerWrapper (class in alibi.explainers.shap_wrappers)
KernelShap (class in alibi.explainers)
(class in alibi.explainers.shap_wrappers)
kl_bernoulli() (in module alibi.utils.distributions)
kllucb() (alibi.explainers.anchor_base.AnchorBaseBeam method)
L
left (alibi.utils.approximation_methods.Riemann attribute)
linearity_measure() (in module alibi.confidence)
(in module alibi.confidence.model_linearity)
LinearityMeasure (class in alibi.confidence)
(class in alibi.confidence.model_linearity)
load() (alibi.api.interfaces.Explainer class method)
load_cats() (in module alibi.datasets)
load_explainer() (in module alibi.saving)
loss_fn() (alibi.explainers.CEM method)
(alibi.explainers.cem.CEM method)
(alibi.explainers.cfproto.CounterFactualProto method)
(alibi.explainers.CounterFactualProto method)
M
map() (alibi.utils.distributed.ActorPool method)
map_unordered() (alibi.utils.distributed.ActorPool method)
methdispatch() (in module alibi.utils.wrappers)
middle (alibi.utils.approximation_methods.Riemann attribute)
minimum_satisfied() (in module alibi.explainers.ale)
MockPredictor (class in alibi.tests.utils)
multidim_scaling() (in module alibi.utils.distance)
mvdm() (in module alibi.utils.distance)
N
names() (alibi.explainers.anchor_explanation.AnchorExplanation method)
Neighbors (class in alibi.explainers.anchor_text)
neighbors() (alibi.explainers.anchor_text.Neighbors method)
not_raises() (in module alibi.tests.utils)
num_grad_batch() (in module alibi.utils.gradients)
num_to_ord() (in module alibi.utils.mapping)
NumpyEncoder (class in alibi.saving)
O
ohe_to_ord() (in module alibi.utils.mapping)
ohe_to_ord_shape() (in module alibi.utils.mapping)
one_hot_grad() (in module alibi.utils.tf)
ord_to_num() (in module alibi.utils.mapping)
ord_to_ohe() (in module alibi.utils.mapping)
order_result() (in module alibi.utils.distributed)
overlay_mask() (alibi.explainers.anchor_image.AnchorImage method)
(alibi.explainers.AnchorImage method)
P
perturb() (alibi.explainers.CEM method)
(alibi.explainers.cem.CEM method)
(in module alibi.utils.gradients)
perturb_sentence() (alibi.explainers.anchor_text.AnchorText method)
(alibi.explainers.AnchorText method)
perturbation() (alibi.explainers.anchor_image.AnchorImage method)
(alibi.explainers.anchor_tabular.TabularSampler method)
(alibi.explainers.AnchorImage method)
plot_ale() (in module alibi.explainers)
(in module alibi.explainers.ale)
PoolCollection (class in alibi.utils.distributed)
precision() (alibi.explainers.anchor_explanation.AnchorExplanation method)
predict() (alibi.tests.utils.MockPredictor method)
Predictor (class in alibi.utils.wrappers)
propose_anchors() (alibi.explainers.anchor_base.AnchorBaseBeam method)
R
rank_by_importance() (in module alibi.explainers.shap_wrappers)
remote_explainer_index() (alibi.utils.distributed.PoolCollection property)
RemoteSampler (class in alibi.explainers.anchor_tabular)
replace_features() (alibi.explainers.anchor_tabular.TabularSampler method)
reset_predictor() (alibi.api.interfaces.Explainer method)
(alibi.explainers.ALE method)
(alibi.explainers.ale.ALE method)
(alibi.explainers.anchor_image.AnchorImage method)
(alibi.explainers.anchor_tabular.AnchorTabular method)
(alibi.explainers.anchor_tabular.DistributedAnchorTabular method)
(alibi.explainers.anchor_text.AnchorText method)
(alibi.explainers.AnchorImage method)
(alibi.explainers.AnchorTabular method)
(alibi.explainers.AnchorText method)
(alibi.explainers.CEM method)
(alibi.explainers.cem.CEM method)
(alibi.explainers.cfproto.CounterFactualProto method)
(alibi.explainers.CounterFactual method)
(alibi.explainers.counterfactual.CounterFactual method)
(alibi.explainers.CounterFactualProto method)
(alibi.explainers.DistributedAnchorTabular method)
(alibi.explainers.integrated_gradients.IntegratedGradients method)
(alibi.explainers.IntegratedGradients method)
(alibi.explainers.KernelShap method)
(alibi.explainers.shap_wrappers.KernelShap method)
(alibi.explainers.shap_wrappers.TreeShap method)
(alibi.explainers.TreeShap method)
ResourceError
return_attribute() (alibi.explainers.shap_wrappers.KernelExplainerWrapper method)
(alibi.utils.distributed.DistributedExplainer method)
Riemann (class in alibi.utils.approximation_methods)
riemann_builders() (in module alibi.utils.approximation_methods)
right (alibi.utils.approximation_methods.Riemann attribute)
round_grad() (in module alibi.utils.tf)
S
sampler() (alibi.explainers.anchor_image.AnchorImage method)
(alibi.explainers.anchor_text.AnchorText method)
(alibi.explainers.AnchorImage method)
(alibi.explainers.AnchorText method)
save() (alibi.api.interfaces.Explainer method)
save_explainer() (in module alibi.saving)
score() (alibi.confidence.LinearityMeasure method)
(alibi.confidence.model_linearity.LinearityMeasure method)
(alibi.confidence.TrustScore method)
(alibi.confidence.trustscore.TrustScore method)
(alibi.explainers.cfproto.CounterFactualProto method)
(alibi.explainers.CounterFactualProto method)
select_critical_arms() (alibi.explainers.anchor_base.AnchorBaseBeam method)
set_actor_index() (alibi.utils.distributed.DistributedExplainer method)
set_data_type() (alibi.explainers.anchor_text.AnchorText method)
(alibi.explainers.AnchorText method)
set_instance_label() (alibi.explainers.anchor_tabular.RemoteSampler method)
(alibi.explainers.anchor_tabular.TabularSampler method)
set_n_covered() (alibi.explainers.anchor_tabular.RemoteSampler method)
(alibi.explainers.anchor_tabular.TabularSampler method)
set_sampler_perturbation() (alibi.explainers.anchor_text.AnchorText method)
(alibi.explainers.AnchorText method)
set_words_and_pos() (alibi.explainers.anchor_text.AnchorText method)
(alibi.explainers.AnchorText method)
spacy_model() (in module alibi.utils.download)
submit() (alibi.utils.distributed.ActorPool method)
sum_categories() (in module alibi.explainers.shap_wrappers)
T
TabularSampler (class in alibi.explainers.anchor_tabular)
to_json() (alibi.api.interfaces.Explanation method)
to_sample() (alibi.explainers.anchor_base.AnchorBaseBeam static method)
trapezoid (alibi.utils.approximation_methods.Riemann attribute)
TREE_SHAP_PARAMS (in module alibi.api.defaults)
TreeShap (class in alibi.explainers)
(class in alibi.explainers.shap_wrappers)
TrustScore (class in alibi.confidence)
(class in alibi.confidence.trustscore)
U
UNK (alibi.explainers.anchor_text.AnchorText attribute)
(alibi.explainers.AnchorText attribute)
update_state() (alibi.explainers.anchor_base.AnchorBaseBeam method)
Read the Docs
v: v0.5.8
Versions
latest
stable
v0.5.8
v0.5.7
v0.5.6
v0.5.5
v0.5.4
v0.5.3
v0.5.2
v0.5.1
v0.5.0
v0.4.0
v0.3.2
v0.3.1
v0.3.0
v0.2.3
v0.2.2
v0.2.1
v0.2.0
v0.1.0
alexcoca-kernelshap
Downloads
On Read the Docs
Project Home
Builds