ExplanationClient 類別

定義上傳和下載說明的用戶端。

建立用來與說明和執行歷程記錄互動的用戶端。

繼承

builtins.object

ExplanationClient

建構函式

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

參數

名稱	Description
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	使用指定執行的 Factory 方法建立用戶端。
from_run_id	使用指定執行識別碼的 Factory 方法建立用戶端。
list_model_explanations	傳回所有可用模型說明的元資料字典。
upload_model_explanation	上傳模型說明資訊以執行歷程記錄。

download_model_explanation

下載已儲存在執行歷程記錄中的模型說明。

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

參數

名稱	Description
explanation_id	str 如果指定，會嘗試使用指定的說明識別碼，從執行下載資產。 如果未指定，則會傳回最近上傳的說明。 預設值: 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

傳回

類型	Description
<xref:interpret_community.explanation.explanation.BaseExplanation>	上傳至執行歷程記錄的說明

from_run

使用指定執行的 Factory 方法建立用戶端。

from_run(run, datastore_name=None)

參數

名稱	Description
cls 必要	ExplanationClient ExplanationClient 類別。
run 必要	Run 將會附加回合說明。
datastore_name	str 要用於上傳的資料存放區名稱， (預設為工作區存放區) 預設值: None

傳回

類型	Description
ExplanationClient	ExplanationClient 的實例。

from_run_id

使用指定執行識別碼的 Factory 方法建立用戶端。

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

參數

名稱	Description
cls 必要	ExplanationClient ExplanationClient 類別。
workspace 必要	Workspace 物件，表示工作區。
experiment_name 必要	str 實驗的名稱。
run_id 必要	str 表示執行的 GUID。
datastore_name	str 要用於上傳的資料存放區名稱， (預設為工作區存放區) 預設值: None

傳回

類型	Description
ExplanationClient	ExplanationClient 的實例。

list_model_explanations

傳回所有可用模型說明的元資料字典。

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

參數

名稱	Description
comment	str 字串，用來根據上傳的字串來篩選說明。 需要完全相符的專案。 預設值: None
raw	bool 或 None 如果為 True 或 False，則會根據說明是否為未經處理而進行篩選。 如果未指定任何內容，將不會套用此篩選。 預設值: None
engineered	bool 或 None 如果為 True 或 False，則會根據是否進行工程來篩選說明。 如果未指定任何內容，將不會套用此篩選。 預設值: None

傳回

類型	Description
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) -> None

參數

名稱	Description
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 如果有的話，初始化 (資料集服務中背景) 資料集的識別碼。 用來將說明連結至資料集。 預設值: None
eval_dataset_id	str 如果有的話，資料集服務中評估資料集的識別碼。 用來將說明連結至資料集。 預設值: None
ys_pred_dataset_id	str 如果有的話，資料集服務中預測值資料集的識別碼。 預設值: None
ys_pred_proba_dataset_id	str 如果有的話，資料集服務中預測機率值資料集的識別碼。 預設值: None
upload_datasets	bool 如果設定為 True 且未傳入任何資料集識別碼，評估資料集將會上傳至 Azure 儲存體作為 Dataset 物件。 這可讓說明連結到 Web 檢視中的資料集。 預設值: False
model_id	str MMS 模型識別碼。 預設值: None
true_ys	list | <xref:pandas.Dataframe> | ndarray 評估範例的 true 標籤。 預設值: None
visualization_points	int 或 list[int] 如果設定為整數，這是 Web UI 中可供視覺效果使用的點數上限。 如果設定為整數清單，這些整數會用來作為索引，以選取原始資料 (點範例，以及) 在 Web UI 中視覺化的說明。 如果不打算在 Web UI 中檢視說明，此參數可以設定為 0，而且不會進行額外的計算或儲存體。 整數或清單長度的上限目前為 20000 (2000) 。 如果傳入較大的整數或較長的清單，函式將會失敗。 目的是為了效能考慮，限制輸入 Web UI 的資料量。 透過更進一步的評估，可能會引發此限制。 預設值: 5000

屬性

run

從說明用戶端取得執行。

傳回

類型	Description
Run	run 物件。