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 1 つの実行。 渡された場合は、他の引数が無視されます。 既定値: None
service_context 必須	<xref:ServiceContext> サービス情報の保有者。
run_id 必須	str 実行を表す GUID。
_run 必須	Run 1 つの実行。 渡された場合、 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 を渡さない場合、評価データセットは Azure Storage に Dataset オブジェクトとしてアップロードされます。 これにより、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 に設定できます。追加の計算やストレージは実行されません。 整数またはリストの長さの上限は、現在 20,000 です。 より大きな整数またはより長いリストが渡された場合、関数は失敗します。 目的は、パフォーマンス上の理由から、Web UI に入力するデータの量を制限することです。 評価がさらに進めば、この制限が引き上げられる可能性があります。 既定値: 5000

属性

run

説明クライアントから実行を取得します。

戻り値

型	説明
Run	実行オブジェクト。