ScoringExplainer 类

定义评分模型。

如果在original_explainer传递转换,这些转换将传递到评分解释器,它将预期原始数据,默认情况下,原始特征将返回重要性。 如果在此处传递 feature_maps (不打算在 转换时使用),解释器将期望转换的数据,并且默认情况下,转换后的数据将返回重要性。 无论哪种情况,都可以通过在解释器解释方法上将get_raw显式设置为 True 或 False 来指定输出。

初始化 ScoringExplainer。

如果在original_explainer传递转换,这些转换将传递到评分解释器,它将预期原始数据,默认情况下,原始特征将返回重要性。 如果在此处传递 feature_maps (不打算在 转换时使用),解释器将期望转换的数据,并且默认情况下,转换后的数据将返回重要性。 无论哪种情况,都可以通过在解释器解释方法上将get_raw显式设置为 True 或 False 来指定输出。

构造函数

ScoringExplainer(original_explainer, feature_maps=None, raw_features=None, engineered_features=None, **kwargs)

参数

名称 说明
original_explainer
必需
<xref:interpret_community.common.base_explainer.BaseExplainer>

训练时解释器最初用于解释模型。

feature_maps

从原始特征映射到生成的特征的列表。 列表可以是 numpy 数组或稀疏矩阵,其中每个数组项(raw_index,generated_index)是每个原始生成的特征对的权重。 其他条目设置为零。 对于 [t1, t2, ..., tn] 从原始特征生成生成的特征的序列,特征映射列表对应于原始到生成的映射,顺序与 t1、t2 等相同。如果从 t1 到 tn 的总体原始特征映射可用,则可以传递单个元素列表中的该功能映射。

默认值: None
raw_features

如果原始解释器计算工程特征的解释,则可以指定原始特征的特征名称的可选列表。

默认值: None
engineered_features

如果原始解释器传递了转换,并且仅计算原始特征的重要性,则可以指定工程特征的特征名称的可选列表。

默认值: None
original_explainer
必需
<xref:interpret_community.common.base_explainer.BaseExplainer>

训练时解释器最初用于解释模型。

feature_maps
必需

从原始特征映射到生成的特征的列表。 列表可以是 numpy 数组或稀疏矩阵,其中每个数组项(raw_index,generated_index)是每个原始生成的特征对的权重。 其他条目设置为零。 对于 [t1, t2, ..., tn] 从原始特征生成生成的特征的序列,特征映射列表对应于原始到生成的映射,顺序与 t1、t2 等相同。如果从 t1 到 tn 的总体原始特征映射可用,则可以传递单个元素列表中的该功能映射。

raw_features
必需

如果原始解释器计算工程特征的解释,则可以指定原始特征的特征名称的可选列表。

engineered_features
必需

如果原始解释器传递了转换,并且仅计算原始特征的重要性,则可以指定工程特征的特征名称的可选列表。

方法

explain

使用模型进行评分以近似地估计数据的特征重要性值。

fit

实现适合 scikit-learn 管道接口所需的虚拟方法。

predict

使用 TreeExplainer 和树模型进行评分以获取数据的特征重要性值。

包装 .explain() 函数。

explain

使用模型进行评分以近似地估计数据的特征重要性值。

abstract explain(evaluation_examples, get_raw)

参数

名称 说明
evaluation_examples
必需

特征向量示例(# 示例 x # 特征)的矩阵,用于解释模型的输出。

get_raw
必需

如果为 True,将返回原始特征的重要性值。 如果为 False,则返回工程特征的重要性值。 如果未指定且 转换 传递到原始解释器中,将返回原始重要性值。 如果未指定且 feature_maps 传递到评分解释器中,则会返回工程的重要性值。

返回

类型 说明

对于具有单个输出(如回归)的模型,此方法返回特征重要性值的矩阵。 对于具有矢量输出的模型,此函数返回此类矩阵的列表,每个输出对应一个。 此矩阵的维度为 (# 示例 x # 特征)。

fit

实现适合 scikit-learn 管道接口所需的虚拟方法。

fit(X, y=None)

参数

名称 说明
X
必需

训练数据。

y

训练目标。

默认值: None

predict

使用 TreeExplainer 和树模型进行评分以获取数据的特征重要性值。

包装 .explain() 函数。

predict(evaluation_examples)

参数

名称 说明
evaluation_examples
必需

特征向量示例(# 示例 x # 特征)的矩阵,用于解释模型的输出。

返回

类型 说明

对于具有单个输出(如回归)的模型,这将返回特征重要性值的矩阵。 对于具有矢量输出的模型,此函数返回此类矩阵的列表,每个输出对应一个。 此矩阵的维度为 (# 示例 x # 特征)。

属性

engineered_features

在解释调用时获取与 get_raw=False 参数对应的工程特征名称。

如果原始解释器具有传递给它的转换,则需要使用 engineered_features 参数将工程特征传递给评分解释器构造函数。 否则,如果将特征映射传递给评分解释器,则工程特征将与特征相同。

返回

类型 说明
list[str],

工程特征名称,如果未向用户提供任何名称,则为 None。

features

获取功能名称。

如果未在解释调用中指定get_raw,则返回默认功能名称。

返回

类型 说明
list[str],

功能名称;如果用户未提供任何名称,则为 None。

raw_features

在解释调用时获取与 get_raw=True 参数对应的原始特征名称。

如果原始解释器没有传递给它的转换,并且feature_maps传递给评分解释器,则需要使用 raw_features 参数将原始特征名称传递到评分解释器构造函数中。 否则,原始特征将与特征相同。

返回

类型 说明
list[str],

原始功能名称;如果没有用户提供任何名称,则为 None。