shap.LinearExplainer

class shap.LinearExplainer(model, masker, link=CPUDispatcher(<function identity>), nsamples=1000, feature_perturbation=None, **kwargs)

为线性模型计算 SHAP 值，可选择性地考虑特征间的相关性。

此方法为线性模型计算 SHAP 值，并且可以考虑输入特征之间的相关性。假设特征独立会导致介入式 SHAP 值，对于线性模型，第 i 个特征的介入式 SHAP 值为 coef[i] * (x[i] - X.mean(0)[i])。如果我们考虑相关性，那么就可以避免由共线性引起的任何问题，并在相关特征之间分配贡献。考虑相关性在计算上可能具有挑战性，但 LinearExplainer 使用抽样来估计一个变换，然后该变换可用于解释模型的任何预测。

参数:

model(coef, intercept) 或 sklearn.linear_model.*

用户提供的线性模型，可以是参数对或 sklearn 对象。

masker函数、numpy.array、pandas.DataFrame、(mean, cov) 元组、shap.maskers.Masker

一个可调用的 Python 对象，用于“掩盖”隐藏特征，形式为 masker(binary_mask, x)。它接受单个输入样本和二进制掩码，并返回一个掩盖样本的矩阵。这些掩盖样本将使用模型函数进行评估，然后对输出进行平均。

作为 SHAP 标准掩盖方法的快捷方式，您可以传递一个背景数据矩阵而不是一个函数，该矩阵将用于掩盖。

您还可以提供一个 (mean, covariance) 元组，或者直接传入一个用于表格数据的掩码器（即 maskers.Independent、maskers.Impute 或 maskers.Partition）。

data(mean, cov)、numpy.array、pandas.DataFrame、iml.DenseData 或 scipy.csr_matrix

用于计算条件期望的背景数据集。请注意，只使用数据集的均值和协方差。这意味着传递原始数据矩阵只是直接传递均值和协方差的一种便捷替代方法。

nsamplesint

在估计用于考虑特征相关性的变换矩阵时使用的样本数。

feature_perturbationNone（默认值）、“interventional”或“correlation_dependent”

已弃用：此选项现已弃用，推荐使用适当的表格掩码器，并将在未来版本中移除。

我们有两种计算 SHAP 值的方式，即完全条件 SHAP 值或介入式 SHAP 值。

• 对于介入式 SHAP 值，我们打破模型中特征之间的任何依赖结构，从而揭示如果我们介入并改变某些输入，模型的行为会如何。Independent 和 Partition 掩码器使用此方法。

• 对于完全条件 SHAP 值，我们尊重输入特征之间的相关性，因此如果模型依赖于一个输入，但该输入与另一个输入相关，那么两者都会因模型的行为而获得一些贡献。Impute 掩码器使用此方法。

介入式选项“忠于模型”，意味着它只会将贡献归因于模型实际使用的特征，而相关性选项“忠于数据”，因为它只考虑模型在尊重输入数据中的相关性时的行为。对于稀疏情况，仅支持介入式选项。

示例

请参阅线性解释器示例

__init__(model, masker, link=CPUDispatcher(<function identity>), nsamples=1000, feature_perturbation=None, **kwargs)

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

参数:

model对象或函数

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

masker函数、numpy.array、pandas.DataFrame、分词器、None 或针对每个模型输入的这些类型的列表

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

link函数

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

algorithm“auto”、“permutation”、“partition”、“tree”或“linear”

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

output_namesNone 或字符串列表

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

seed: None 或 int

用于可复现性的种子

方法

__init__(model, masker[, link, nsamples, ...])	为传递的模型构建一个新的解释器。
explain_row(*row_args, max_evals, ...)	解释单行并返回元组 (row_values, row_expected_values, row_mask_shapes)。
load(in_file[, model_loader, masker_loader, ...])	从给定的文件流加载一个解释器。
save(out_file[, model_saver, masker_saver])	将解释器写入给定的文件流。
shap_values(X)	为一组样本估计 SHAP 值。
supports_model_with_masker(model, masker)	确定我们是否可以解析给定的模型。

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

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

classmethod load(in_file, model_loader=None, masker_loader=None, instantiate=True)

从给定的文件流加载一个解释器。

参数:

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

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

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

shap_values(X)

为一组样本估计 SHAP 值。

参数:

Xnumpy.array、pandas.DataFrame 或 scipy.csr_matrix

一个样本矩阵（# 样本数 x # 特征数），用于解释模型的输出。

返回:

np.array

估计的 SHAP 值，通常形状为 (# 样本数 x # 特征数)。

每一行的总和等于该样本的模型输出与模型输出期望值（存储为解释器的 expected_value 属性）之间的差值。

返回数组的形状取决于模型输出的数量

• 一个输出：形状为 (#num_samples, *X.shape[1:]) 的数组。

• 多个输出：形状为 (#num_samples, *X.shape[1:], #num_outputs) 的数组。

在 0.45.0 版本中更改: 具有多个输出的模型的返回类型从列表更改为 np.ndarray。

static supports_model_with_masker(model, masker)

确定我们是否可以解析给定的模型。