shap.explainers.other.Maple

class shap.explainers.other.Maple(model, data)

简单地将 MAPLE 封装到通用的 SHAP 接口中。

参数:

model函数

用户提供的函数，该函数接收一个样本矩阵（# 样本数 x # 特征数）并为这些样本计算模型输出。输出可以是一个向量（# 样本数）或一个矩阵（# 样本数 x # 模型输出数）。

datanumpy.array

背景数据集。

__init__(model, data)

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

参数:

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__(模型, 数据)	为传递的模型构建一个新的解释器。
attributions(X[, multiply_by_input])	计算 MAPLE 系数归因。
explain_row(*row_args, max_evals, ...)	解释单行数据并返回元组 (row_values, row_expected_values, row_mask_shapes, main_effects)。
load(in_file[, model_loader, masker_loader, ...])	从给定的文件流加载一个解释器。
save(out_file[, model_saver, masker_saver])	将解释器写入给定的文件流。
supports_model_with_masker(model, masker)	判断此解释器是否能处理给定的模型。

属性

model
masker
output_names
feature_names
link
linearize_link

attributions(X, multiply_by_input=False)

计算 MAPLE 系数归因。

参数:

multiply_by_input布尔值

如果为真，则将学习到的系数乘以以均值为中心的输入。这使得这些值与 SHAP 值大致可比。

explain_row(*row_args: Any, max_evals: int | Literal['auto'], main_effects: bool, error_bounds: bool, outputs: Any, silent: bool, **kwargs: Any) → dict[str, Any]

解释单行数据并返回元组 (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: Any, model_loader: Callable[..., Any] | None = None, masker_loader: Callable[..., Any] | None = None, instantiate: bool = True) → Explainer | dict[str, Any]

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

参数:

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

save(out_file: Any, model_saver: str | Callable[..., Any] = '.save', masker_saver: str | Callable[..., Any] = '.save') → None

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

static supports_model_with_masker(model: Any, masker: Any) → bool

判断此解释器是否能处理给定的模型。

这是一个抽象的静态方法，需要由每个子类实现。