scoring_explainer 包

定义用于求特征重要性近似值的评分模型。

DeepScoringExplainer

定义基于 DeepExplainer 的评分模型。

如果原始解释器使用的是 SHAP DeepExplainer 并且没有传入初始化数据,则将重用原始解释器的核心。 如果原始解释器使用了其他方法或在 initialization_examples 下传入了新的初始化数据,则会创建新的解释器。

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

KernelScoringExplainer

定义基于 KernelExplainer 的评分模型。

如果原始解释器使用的是 SHAP KernelExplainer 并且没有传入初始化数据,则将重用原始解释器的核心。 如果原始解释器使用了其他方法或在 initialization_examples 下传入了新的初始化数据,则会创建新的解释器。

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

LinearScoringExplainer

定义基于 LinearExplainer 的评分模型。

如果原始解释器使用的是 SHAP LinearExplainer 并且没有传入初始化数据,则将重用原始解释器的核心。 如果原始解释器使用了其他方法或在 initialization_examples 下传入了新的初始化数据,则会创建新的解释器。

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

ScoringExplainer

定义评分模型。

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

TreeScoringExplainer

定义基于 TreeExplainer 的评分模型。

如果原始解释器使用的是 SHAP TreeExplainer,则重用原始解释器的核心。 如果原始解释器使用了另一种方法,将创建新的解释器。

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

函数

load

从磁盘加载评分解释器。

load(directory)

参数

directory
str
必需

存储序列化解释器时所依据的目录。 假设 scoring_explainer.pkl 在目录的顶层可用。

返回

从磁盘加载的说明中的评分解释器。

返回类型

save

将评分解释器保存到磁盘。

save(scoring_explainer, directory='.', exist_ok=False)

参数

scoring_explainer
必需

要保存的评分解释器对象。 解释器将写入 [directory]/scoring_explainer.pkl。

directory
str
默认值: .

序列化解释器应存储到的目录。 如果目录不存在,则会创建该目录。

exist_ok
bool
默认值: False

如果(状态为 False),如果给定的目录已存在,则会引发警告。 如果为 True,则使用当前目录,并且将覆盖任何重叠的内容。

返回

评分解释器 pickle 文件的路径。

返回类型

str