反馈

ExplanationClient 类

  • 参考

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

继承
builtins.object
ExplanationClient

构造函数

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

参数

service_context
<xref:ServiceContext>
必需

服务信息的容器。

run_id
str
必需

表示运行的 GUID。

_run
Run
必需

运行。 如果传入，将忽略其他参数。

_run
默认值: None

方法

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
默认值: None

如果已指定，则尝试使用给定的说明 ID 从运行下载资产。 如果未指定，则返回最近上传的说明。

top_k
int
默认值: None

如果已指定，将返回的已排序数据限定为最重要的特征和值。 如果情况如此，global_importance_values 和 per_class_values 将包含前 k 个排序值，而不是未排序值的一般完整列表。

comment
str
默认值: None

一个字符串，用于根据上传说明所使用的字符串来筛选说明。 需要完全匹配。 如果多个说明共享此字符串，则会返回最新的说明。

raw
bool 或 None
默认值: None

如果为 True 或 False，将根据说明的特征是否为原始特征来对其进行筛选。 如果未指定任何内容，将不会应用此筛选器。

engineered
bool 或 None
默认值: None

如果为 True 或 False，将根据说明的特征是否为工程特征来对其进行筛选。 如果未指定任何内容，将不会应用此筛选器。

返回

上传到运行历史记录时的说明

返回类型

<xref:BaseExplanation>

from_run

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

from_run(run)

参数

cls
ExplanationClient
必需

ExplanationClient 类。

run
Run
必需

运行说明将附加到其中。

返回

ExplanationClient 的实例。

返回类型

ExplanationClient

from_run_id

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

from_run_id(workspace, experiment_name, run_id)

参数

cls
ExplanationClient
必需

ExplanationClient 类。

workspace
Workspace
必需

表示工作区的对象。

experiment_name
str
必需

试验名称。

run_id
str
必需

表示运行的 GUID。

返回

ExplanationClient 的实例。

返回类型

ExplanationClient

list_model_explanations

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

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

参数

comment
str
默认值: None

一个字符串，用于根据上传说明所使用的字符串来筛选说明。 需要完全匹配。

raw
bool 或 None
默认值: None

如果为 True 或 False，将根据说明的特征是否为原始特征来对其进行筛选。 如果未指定任何内容，将不会应用此筛选器。

engineered
bool 或 None
默认值: None

如果为 True 或 False，将根据说明的特征是否为工程特征来对其进行筛选。 如果未指定任何内容，将不会应用此筛选器。

返回

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

返回类型

dict

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)

参数

explanation
<xref:interpret_community.explanation.explanation.BaseExplanation>
必需

要保存的说明信息。

max_num_blocks
int
默认值: None

要存储的块的最大数量。

block_size
int
默认值: None

在项目存储中存储的摘要的每个块的大小。

top_k
int
默认值: None

说明中存储的重要特征数量。 如果已指定，将仅返回/存储与前 K 个最重要特征对应的名称和值。 如果情况如此，global_importance_values 和 per_class_values 将包含前 k 个排序值，而不是未排序值的一般完整列表。

comment
str
默认值: None

用于标识说明的可选字符串。 列出说明时会显示此字符串，这样就可以标识已上传的说明。

init_dataset_id
str
默认值: None

数据集服务中的初始化（后台）数据集的 ID（如果可用）。 用于将说明链接到数据集。

eval_dataset_id
str
默认值: None

数据集服务中的评估数据集的 ID（如果可用）。 用于将说明链接到数据集。

ys_pred_dataset_id
str
默认值: None

数据集服务中的预测值数据集的 ID（如果可用）。

ys_pred_proba_dataset_id
str
默认值: None

数据集服务中的预测概率值数据集的 ID（如果可用）。

upload_datasets
bool
默认值: False

如果设置为 True 且未传入任何数据集 ID，评估数据集将作为 Dataset 对象上传到 Azure 存储。 这将允许将说明链接到 Web 视图中的数据集。

model_id
str
默认值: None

MMS 模型 ID。

true_ys
<xref:<xref:list | pandas.Dataframe | numpy.ndarray>>
默认值: None

评估示例的 true 标签。

visualization_points
int 或 list[int]
默认值: 5000

如果设置为整数，这将成为可用于 Web UI 中可视化项的点数的上限。 如果设置为整数列表，这些整数将用作索引，用于选择 Web UI 中要进行可视化的点（原始数据和说明）示例。 如果未计划查看 Web UI 中的说明，可以将此参数设置为 0，并且不会进行额外的计算或存储。

整数或列表长度的上限值当前为 20000。 如果传入更大的整数或更长的列表，则函数将失败。 目的是限制输入 Web UI 的数据量，以维持性能。 如果进行更多评估，可能会提高此限制。

属性

run

从说明客户端获取运行。

返回

运行对象。

返回类型

Run