ExplanationClient 类

定义上传和下载说明的客户端。

创建用于与说明和运行历史记录交互的客户端。

继承

builtins.object

ExplanationClient

构造函数

ExplanationClient(service_context, experiment_name, run_id, _run=None, datastore_name=None)

参数

名称	说明
service_context 必需	<xref:ServiceContext> 服务信息的容器。
run_id 必需	str 表示运行的 GUID。
_run	Run 运行。 如果传入，将忽略其他参数。 默认值: None
service_context 必需	<xref:ServiceContext> 服务信息的容器。
run_id 必需	str 表示运行的 GUID。
_run 必需	Run 运行。 如果传入，将忽略 run_id 。
datastore_name	str 用于上传的数据存储的名称 (默认为工作区存储) 默认值: None
experiment_name 必需

方法

download_model_explanation	下载已存储在运行历史记录中的模型说明。
from_run	在给定运行时，使用工厂方法创建客户端。
from_run_id	在给定运行 ID 时，使用工厂方法创建客户端。
list_model_explanations	返回所有可用模型说明的元数据字典。
upload_model_explanation	将模型说明信息上传到运行历史记录。

download_model_explanation

下载已存储在运行历史记录中的模型说明。

download_model_explanation(explanation_id=None, top_k=None, comment=None, raw=None, engineered=None)

参数

名称	说明
explanation_id	str 如果已指定，则尝试使用给定的说明 ID 从运行下载资产。 如果未指定，则返回最近上传的说明。 默认值: None
top_k	int 如果已指定，将返回的已排序数据限定为最重要的特征和值。 如果情况如此，global_importance_values 和 per_class_values 将包含前 k 个排序值，而不是未排序值的一般完整列表。 默认值: None
comment	str 一个字符串，用于根据上传说明所使用的字符串来筛选说明。 需要完全匹配。 如果多个说明共享此字符串，则会返回最新的说明。 默认值: None
raw	bool 或 None 如果为 True 或 False，将根据说明的特征是否为原始特征来对其进行筛选。 如果未指定任何内容，将不会应用此筛选器。 默认值: None
engineered	bool 或 None 如果为 True 或 False，将根据说明的特征是否为工程特征来对其进行筛选。 如果未指定任何内容，将不会应用此筛选器。 默认值: None

返回

类型	说明
<xref:interpret_community.explanation.explanation.BaseExplanation>	上传到运行历史记录时的说明

from_run

在给定运行时，使用工厂方法创建客户端。

from_run(run, datastore_name=None)

参数

名称	说明
cls 必需	ExplanationClient ExplanationClient 类。
run 必需	Run 运行说明将附加到其中。
datastore_name	str 用于上传的数据存储的名称 (默认为工作区存储) 默认值: None

返回

类型	说明
ExplanationClient	ExplanationClient 的实例。

from_run_id

在给定运行 ID 时，使用工厂方法创建客户端。

from_run_id(workspace, experiment_name, run_id, datastore_name=None)

参数

名称	说明
cls 必需	ExplanationClient ExplanationClient 类。
workspace 必需	Workspace 表示工作区的对象。
experiment_name 必需	str 试验名称。
run_id 必需	str 表示运行的 GUID。
datastore_name	str 用于上传的数据存储的名称 (默认为工作区存储) 默认值: None

返回

类型	说明
ExplanationClient	ExplanationClient 的实例。

list_model_explanations

返回所有可用模型说明的元数据字典。

list_model_explanations(comment=None, raw=None, engineered=None)

参数

名称	说明
comment	str 一个字符串，用于根据上传说明所使用的字符串来筛选说明。 需要完全匹配。 默认值: None
raw	bool 或 None 如果为 True 或 False，将根据说明的特征是否为原始特征来对其进行筛选。 如果未指定任何内容，将不会应用此筛选器。 默认值: None
engineered	bool 或 None 如果为 True 或 False，将根据说明的特征是否为工程特征来对其进行筛选。 如果未指定任何内容，将不会应用此筛选器。 默认值: None

返回

类型	说明
dict	按上传时间排序的说明元数据（例如 ID、数据类型、说明方法、模型类型和上传时间）的字典

upload_model_explanation

将模型说明信息上传到运行历史记录。

upload_model_explanation(explanation, max_num_blocks=None, block_size=None, top_k=None, comment=None, init_dataset_id=None, eval_dataset_id=None, ys_pred_dataset_id=None, ys_pred_proba_dataset_id=None, upload_datasets=False, model_id=None, true_ys=None, visualization_points=5000) -> None

参数

名称	说明
explanation 必需	<xref:interpret_community.explanation.explanation.BaseExplanation> 要保存的说明信息。
max_num_blocks	int 要存储的块的最大数量。 默认值: None
block_size	int 在项目存储中存储的摘要的每个块的大小。 默认值: None
top_k	int 说明中存储的重要特征数量。 如果已指定，将仅返回/存储与前 K 个最重要特征对应的名称和值。 如果情况如此，global_importance_values 和 per_class_values 将包含前 k 个排序值，而不是未排序值的一般完整列表。 默认值: None
comment	str 用于标识说明的可选字符串。 列出说明时会显示此字符串，这样就可以标识已上传的说明。 默认值: None
init_dataset_id	str 数据集服务中的初始化（后台）数据集的 ID（如果可用）。 用于将说明链接到数据集。 默认值: None
eval_dataset_id	str 数据集服务中的评估数据集的 ID（如果可用）。 用于将说明链接到数据集。 默认值: None
ys_pred_dataset_id	str 数据集服务中的预测值数据集的 ID（如果可用）。 默认值: None
ys_pred_proba_dataset_id	str 数据集服务中的预测概率值数据集的 ID（如果可用）。 默认值: None
upload_datasets	bool 如果设置为 True 且未传入任何数据集 ID，评估数据集将作为 Dataset 对象上传到 Azure 存储。 这将允许将说明链接到 Web 视图中的数据集。 默认值: False
model_id	str MMS 模型 ID。 默认值: None
true_ys	list | <xref:pandas.Dataframe> | ndarray 评估示例的 true 标签。 默认值: None
visualization_points	int 或 list[int] 如果设置为整数，这将成为可用于 Web UI 中可视化项的点数的上限。 如果设置为整数列表，这些整数将用作索引，用于选择 Web UI 中要进行可视化的点（原始数据和说明）示例。 如果未计划查看 Web UI 中的说明，可以将此参数设置为 0，并且不会进行额外的计算或存储。 整数或列表长度的上限值当前为 20000。 如果传入更大的整数或更长的列表，则函数将失败。 目的是限制输入 Web UI 的数据量，以维持性能。 如果进行更多评估，可能会提高此限制。 默认值: 5000

属性

run

从说明客户端获取运行。

返回

类型	说明
Run	运行对象。