shap.Explainer

class shap.Explainer(model, masker=None, link=CPUDispatcher(<function identity>), algorithm='auto', output_names=None, feature_names=None, linearize_link=True, seed=None, **kwargs)

使用 Shapley 值来解释任何机器学习模型或 Python 函数。

这是 SHAP 库的主要解释器接口。它接受模型和掩码器的任意组合，并返回一个可调用的子类对象，该对象实现了所选的特定估计算法。

__init__(model, masker=None, link=CPUDispatcher(<function identity>), algorithm='auto', output_names=None, feature_names=None, linearize_link=True, seed=None, **kwargs)

为传入的模型构建一个新的解释器。

参数:

modelobject or function

用户提供的函数或模型对象，它接受样本数据集并计算这些样本的模型输出。

maskerfunction, numpy.array, pandas.DataFrame, tokenizer, None, or a list of these for each model input

用于“掩盖”隐藏特征的函数，形式为 masked_args = masker(*model_args, mask=mask)。它接受与模型相同形式的输入，但仅针对带有二进制掩码的单个样本，然后返回一个可迭代的掩码样本。然后将使用模型函数评估这些掩码样本，并将输出进行平均。作为 SHAP 标准掩码的快捷方式，您可以传递背景数据矩阵而不是函数，该矩阵将用于掩码。SHAP 中提供了特定领域的掩码函数，例如用于图像的 shap.ImageMasker 和用于文本的 shap.TokenMasker。除了确定如何替换隐藏特征外，掩码器还可以约束用于解释模型的合作博弈规则。例如，shap.TabularMasker(data, hclustering=”correlation”) 将对博弈强制执行联盟的层次聚类（在这种特殊情况下，归因被称为 Owen 值）。

linkfunction

链接函数用于在模型输出单元和 SHAP 值单元之间进行映射。默认情况下它是 shap.links.identity，但 shap.links.logit 可能很有用，这样可以在概率单位中计算期望，而解释仍然在（更自然的加性）对数比单位中。有关链接函数如何工作的更多详细信息，请参阅广义线性模型的链接函数概述。

algorithm“auto”, “permutation”, “partition”, “tree”, or “linear”

用于估计 Shapley 值的算法。有许多不同的算法可用于估计 Shapley 值（以及约束博弈的相关值），这些算法各有优缺点，在不同的情况下更可取。默认情况下，“auto”选项尝试根据传入的模型和掩码器做出最佳选择，但始终可以通过传递特定算法的名称来覆盖此选择。所用算法的类型将决定此构造函数返回的子类对象的类型，如果您喜欢或需要更精细地控制其选项，也可以直接构建这些子类。

output_namesNone or list of strings

模型输出的名称。例如，如果模型是图像分类器，则 output_names 将是所有输出类别的名称。此参数是可选的。当 output_names 为 None 时，此解释器生成的 Explanation 对象将没有任何 output_names，这可能会影响下游绘图。

seed: None or int

用于重现性的种子

方法

__init__(model[, masker, link, algorithm, ...])	为传入的模型构建一个新的解释器。
explain_row(*row_args, max_evals, ...])	解释单行并返回元组 (row_values, row_expected_values, row_mask_shapes, main_effects)。
load(in_file[, model_loader, masker_loader, ...])	从给定的文件流加载 Explainer。
save(out_file[, model_saver, masker_saver])	将解释器写入给定的文件流。
supports_model_with_masker(model, masker)	确定此解释器是否可以处理给定的模型。

explain_row(*row_args, max_evals, main_effects, error_bounds, outputs, silent, **kwargs)

解释单行并返回元组 (row_values, row_expected_values, row_mask_shapes, main_effects)。

这是一个抽象方法，旨在由每个子类实现。

返回:

tuple

一个元组 (row_values, row_expected_values, row_mask_shapes)，其中 row_values 是每个样本的归因值数组，row_expected_values 是表示每个样本模型期望值的数组（或单个值）（除非存在固定输入，否则所有样本都相同，例如解释损失时的标签），row_mask_shapes 是所有输入形状的列表（因为 row_values 始终被展平），

classmethod load(in_file, model_loader=<bound method Model.load of <class 'shap.models._model.Model'>>, masker_loader=<bound method Serializable.load of <class 'shap.maskers._masker.Masker'>>, instantiate=True)

从给定的文件流加载 Explainer。

参数:

in_file用于从中加载对象的文件流。

save(out_file, model_saver='.save', masker_saver='.save')

将解释器写入给定的文件流。

static supports_model_with_masker(model, masker)

确定此解释器是否可以处理给定的模型。

这是一个抽象静态方法，旨在由每个子类实现。