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 如果有的話，數據集服務中初始化 （background） 數據集的標識符。 用來將說明連結至數據集。 預設值: None
eval_dataset_id	str 如果有的話，數據集服務中評估數據集的標識符。 用來將說明連結至數據集。 預設值: None
ys_pred_dataset_id	str 如果有的話，數據集服務中預測值數據集的標識碼。 預設值: None
ys_pred_proba_dataset_id	str 如果有的話，數據集服務中預測機率值數據集的標識碼。 預設值: None
upload_datasets	bool 如果設定為 True 且未傳入任何數據集標識碼，則評估數據集會以數據集物件的形式上傳至 Azure 記憶體。 這可讓說明連結至 Web 檢視中的數據集。 預設值: False
model_id	str MMS 模型標識碼。 預設值: None
true_ys	list | <xref:pandas.Dataframe> | ndarray 評估範例的真正標籤。 預設值: None
visualization_points	int 或 list[int] 如果設定為整數，這是 Web UI 中視覺效果可用點數的上限。 如果設定為整數清單，這些整數將用來作為索引，以選取要可視化的 Web UI 中要可視化的點範例（原始數據和說明）。 如果不打算在 Web UI 中檢視說明，此參數可以設定為 0，而且不會進行額外的計算或記憶體。 整數或清單長度的上限目前為 20000 （20000 年）。 如果傳入較大的整數或較長的清單，函式將會失敗。 目的是為了效能考慮，限制輸入 Web UI 的數據量。 在進行更多評估時，可能會引發此限制。 預設值: 5000

屬性

run

從說明用戶端取得執行。

傳回

類型	Description
Run	run 物件。