Share via

ScoringExplainer クラス

  • リファレンス

スコアリング モデルを定義します。

original_explainer 上で transformations が渡された場合、これらの変換は、Scoring Explainer まで存続し、生データを予期して、既定では生の特徴量に対して重要度が返されます。 ここで feature_maps が渡された場合 (transformations と同時に使用することは想定されていません)、Explainer は、変換されたデータを予期し、既定では変換されたデータに対して重要度が返されます。 いずれの場合も、出力を指定するには、Explainer の explain メソッド上で、get_raw を明示的に True または False に設定します。

ScoringExplainer を初期化します。

original_explainer 上で transformations が渡された場合、これらの変換は、Scoring Explainer まで存続し、生データを予期して、既定では生の特徴量に対して重要度が返されます。 ここで feature_maps が渡された場合 (transformations と同時に使用することは想定されていません)、Explainer は、変換されたデータを予期し、既定では変換されたデータに対して重要度が返されます。 いずれの場合も、出力を指定するには、Explainer の explain メソッド上で、get_raw を明示的に True または False に設定します。

継承
azureml._logging.chained_identity.ChainedIdentity
ScoringExplainer

コンストラクター

ScoringExplainer(original_explainer, feature_maps=None, raw_features=None, engineered_features=None, **kwargs)

パラメーター

original_explainer
<xref:interpret_community.common.base_explainer.BaseExplainer>
必須

モデルの説明に最初に使用されていたトレーニング時間 Explainer。

feature_maps
list[ndarray] または list[csr_matrix]
既定値: None

生の特徴量から生成された特徴量への特徴量マップのリスト。 このリストは、numpy 配列またはスパース行列のリストにできます。各配列エントリ (raw_index、generated_index) は、生および生成された各特徴量ペアの重みです。 その他のエントリは 0 に設定されます。 生の特徴量から生成された特徴量を生成する一連の変換 [t1, t2, ..., tn] の場合、特徴量マップのリストは、t1、t2 などと同じ順序で生のマップから生成されたマップに対応します。t1 から tn への生から生成された特徴量マップ全体を使用できる場合は、1 つの要素リスト内のその特徴量マップだけを渡すだけですむ可能性があります。

raw_features
list[str]
既定値: None

元の Explainer がエンジニアリングされた機能の説明を計算する場合に指定できる、生の特徴の特徴名のオプションリスト。

engineered_features
list[str]
既定値: None

元の Explainer に変換が渡され、生の特徴の重要度のみを計算する場合に指定できる、エンジニアリングされた特徴の特徴名のオプションリスト。

original_explainer
<xref:interpret_community.common.base_explainer.BaseExplainer>
必須

モデルの説明に最初に使用されていたトレーニング時間 Explainer。

feature_maps
list[ndarray] または list[csr_matrix]
必須

生の特徴量から生成された特徴量への特徴量マップのリスト。 このリストは、numpy 配列またはスパース行列のリストにできます。各配列エントリ (raw_index、generated_index) は、生および生成された各特徴量ペアの重みです。 その他のエントリは 0 に設定されます。 生の特徴量から生成された特徴量を生成する一連の変換 [t1, t2, ..., tn] の場合、特徴量マップのリストは、t1、t2 などと同じ順序で生のマップから生成されたマップに対応します。t1 から tn への生から生成された特徴量マップ全体を使用できる場合は、1 つの要素リスト内のその特徴量マップだけを渡すだけですむ可能性があります。

raw_features
list[str]
必須

元の Explainer がエンジニアリングされた機能の説明を計算する場合に指定できる、生の特徴の特徴名のオプションリスト。

engineered_features
list[str]
必須

元の Explainer に変換が渡され、生の特徴の重要度のみを計算する場合に指定できる、エンジニアリングされた特徴の特徴名のオプションリスト。

メソッド

explain

スコアリングにモデルを使用して、データの特徴量の重要度の値を概算します。
fit

scikit-learn パイプライン インターフェイスに適合させるために必要なダミー メソッドを実装します。
predict

データの特徴量の重要度の値を取得するには、スコアリングに TreeExplainer とツリー モデルを使用します。

.explain() 関数をラップします。

explain

スコアリングにモデルを使用して、データの特徴量の重要度の値を概算します。

abstract explain(evaluation_examples, get_raw)

パラメーター

evaluation_examples
array または DataFrame または csr_matrix
必須

モデルの出力を説明するための特徴量ベクトルの例のマトリックス (例の数 x 特徴量の数)。

get_raw
bool
必須

True の場合、生の特徴量の重要度の値が返されます。 False の場合、エンジニアリングされた特徴量の重要度の値が返されます。 指定せず、transformations が元の Explainer に渡された場合、生の重要度の値が返されます。 指定せず、feature_maps が Scoring Explainer に渡された場合、エンジニアリングされた重要度の値が返されます。

戻り値

回帰などの単一出力のモデルの場合、このメソッドは特徴量の重要度の値のマトリックスを返します。 ベクトル出力を含むモデルの場合、この関数は、このようなマトリックスのリストを、出力ごとに 1 つずつ返します。 このマトリックスのディメンションは (例の数 x 特徴量の数) です。

の戻り値の型 :

list

fit

scikit-learn パイプライン インターフェイスに適合させるために必要なダミー メソッドを実装します。

fit(X, y=None)

パラメーター

X
必須

トレーニング データ。

y
既定値: None

トレーニング ターゲット。

predict

データの特徴量の重要度の値を取得するには、スコアリングに TreeExplainer とツリー モデルを使用します。

.explain() 関数をラップします。

predict(evaluation_examples)

パラメーター

evaluation_examples
array または DataFrame または csr_matrix
必須

モデルの出力を説明するための特徴量ベクトルの例のマトリックス (例の数 x 特徴量の数)。

戻り値

回帰などの単一出力のモデルの場合、これは特徴量の重要度の値のマトリックスを返します。 ベクトル出力を含むモデルの場合、この関数は、このようなマトリックスのリストを、出力ごとに 1 つずつ返します。 このマトリックスのディメンションは (例の数 x 特徴量の数) です。

の戻り値の型 :

list

属性

engineered_features

explain 呼び出しで、get_raw=False パラメーターに対応するエンジニアリングされた機能名を取得します。

元の explainer に変換が渡された場合は、engineered_features パラメーターを使用して、エンジニアリングされた機能をスコアリング explainer コンストラクターに渡す必要があります。 それ以外の場合、特徴マップがスコアリングの説明者に渡された場合、エンジニアリングされた特徴は特徴と同じになります。

戻り値

エンジニアリングされた機能名。ユーザーが指定しなかった場合は None。

の戻り値の型 :

list[str],
None

features

特徴名を取得します。

explain 呼び出しでget_rawが指定されていない場合は、既定の機能名を返します。

戻り値

特徴量名、または None (ユーザーが何も指定しなかった場合)。

の戻り値の型 :

list[str],
None

raw_features

explain 呼び出しで、get_raw=True パラメーターに対応する生の特徴名を取得します。

元の explainer に変換が渡されておらず、feature_mapsスコアリング explainer に渡された場合は、raw_features パラメーターを使用して、生の特徴名をスコアリング explainer コンストラクターに渡す必要があります。 それ以外の場合、生の特徴は特徴と同じになります。

戻り値

生の機能名。ユーザーが何も指定しなかった場合は None。

の戻り値の型 :

list[str],
None