API reference¶

This page documents the public Python interface.

Main objects¶

class shap_bpt.Explainer(fm, image_to_explain, num_explained_classes, balance_area=False, verbose=False)[source]¶

Bases: object

empty_mask(dtype=<class 'numpy.bool'>)[source]¶

explain_instance(max_evals, method='BPT', bpt=None, batch_size=64, verbose_plot=False, pbar=None, min_area=1, max_weight=None)[source]¶

init_axisaligned()[source]¶

init_bpt(bpt)[source]¶

predict_masked(masks)[source]¶

Core utilities¶

shap_bpt.build_bpt_from_image(image, use_lab=True, **kwargs)[source]¶

shap_bpt.plot_owen_values(explainer, shap_values, class_names, names=None)[source]¶

Data structures¶

class shap_bpt.BPT[source]¶

from_bpt_builder(bpt_builder)[source]¶

load_from_file(bpt_fname)[source]¶

print_tree(index=None, lvl=0)[source]¶