次の方法で共有


ScoringExplainer クラス

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

変換original_explainerで渡された場合、それらの変換はスコアリング Explainer に渡され、生データが想定され、既定では生の特徴に対して重要度が返されます。 ここでfeature_mapsが渡された場合 (変換と同時に使用されるものではありません)、explainer は変換されたデータを予期し、変換されたデータの既定の重要度が返されます。 どちらの場合も、explainer の explain メソッドget_raw明示的に True または False に設定することで、出力を指定できます。

ScoringExplainer を初期化します。

変換original_explainerで渡された場合、それらの変換はスコアリング Explainer に渡され、生データが想定され、既定では生の特徴に対して重要度が返されます。 ここでfeature_mapsが渡された場合 (変換と同時に使用されるものではありません)、explainer は変換されたデータを予期し、変換されたデータの既定の重要度が返されます。 どちらの場合も、explainer の explain メソッドget_raw明示的に True または False に設定することで、出力を指定できます。

コンストラクター

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

パラメーター

名前 説明
original_explainer
必須
<xref:interpret_community.common.base_explainer.BaseExplainer>

トレーニング時間の説明者は、最初にモデルの説明に使用しました。

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

生のフィーチャから生成されたフィーチャにマップされるフィーチャの一覧。 リストには、numpy 配列またはスパース マトリックスを指定できます。各配列エントリ (raw_index、generated_index) は、生で生成された各特徴ペアの重みになります。 他のエントリは 0 に設定されます。 生フィーチャから生成されたフィーチャを生成する一連の変換 [t1,t2, ..., tn] の場合、フィーチャ マップの一覧は、t1、t2 などの順序で生成された未加工のマップに対応します。t1 から tn への生成済みフィーチャ マップ全体を使用できる場合は、1 つの要素リスト内のそのフィーチャ マップのみを渡すことができます。

規定値: None
raw_features

元の Explainer がエンジニアリングされた特徴に関する説明を計算する場合に指定できる、生の特徴の特徴名の省略可能なリスト。

規定値: None
engineered_features

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

規定値: None
original_explainer
必須
<xref:interpret_community.common.base_explainer.BaseExplainer>

トレーニング時間の説明者は、最初にモデルの説明に使用しました。

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

生のフィーチャから生成されたフィーチャにマップされるフィーチャの一覧。 リストには、numpy 配列またはスパース マトリックスを指定できます。各配列エントリ (raw_index、generated_index) は、生で生成された各特徴ペアの重みになります。 他のエントリは 0 に設定されます。 生フィーチャから生成されたフィーチャを生成する一連の変換 [t1,t2, ..., tn] の場合、フィーチャ マップの一覧は、t1、t2 などの順序で生成された未加工のマップに対応します。t1 から tn への生成済みフィーチャ マップ全体を使用できる場合は、1 つの要素リスト内のそのフィーチャ マップのみを渡すことができます。

raw_features
必須

元の Explainer がエンジニアリングされた特徴に関する説明を計算する場合に指定できる、生の特徴の特徴名の省略可能なリスト。

engineered_features
必須

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

メソッド

explain

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

fit

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

predict

スコア付けに TreeExplainer とツリー モデルを使用して、データの特徴の重要度の値を取得します。

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

explain

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

abstract explain(evaluation_examples, get_raw)

パラメーター

名前 説明
evaluation_examples
必須
array または DataFrame または csr_matrix

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

get_raw
必須

True の場合、生の特徴の重要度の値が返されます。 False の場合、エンジニアリングされた特徴の重要度の値が返されます。 指定されておらず、変換が元 Explainer に渡された場合は、生の重要度の値が返されます。 指定されておらず 、スコア リング explainer にfeature_mapsが渡された場合は、エンジニアリングされた重要度の値が返されます。

戻り値

説明

回帰などの単一の出力を持つモデルの場合、このメソッドは特徴の重要度値のマトリックスを返します。 ベクトル出力を持つモデルの場合、この関数は出力ごとに 1 つずつ、そのような行列のリストを返します。 この行列の次元は (# 例 x # 特徴) です。

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 # 特徴) です。

属性

engineered_features

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

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

戻り値

説明
list[str],

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

features

機能名を取得します。

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

戻り値

説明
list[str],

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

raw_features

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

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

戻り値

説明
list[str],

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