ScoringExplainer Classe

Définit un modèle de scoring.

Si des transformations ont été transmises sur original_explainer, ces transformations sont transmises à l’explicatif de scoring, elles s’attendent à ce que les données brutes soient retournées par défaut pour les fonctionnalités brutes. Si feature_maps sont passées ici (NON destinées à être utilisées en même temps que les transformations), l’explicatif s’attend à recevoir des données transformées et, par défaut, les importances sont retournées pour les données transformées. Dans les deux cas, la sortie peut être spécifiée en définissant get_raw explicitement sur True ou False sur la méthode d’explication de l’explicatif .

Initialisez scoringExplainer.

Si des transformations ont été transmises sur original_explainer, ces transformations sont transmises à l’explicatif de scoring, elles s’attendent à ce que les données brutes soient retournées par défaut pour les fonctionnalités brutes. Si feature_maps sont passées ici (NON destinées à être utilisées en même temps que les transformations), l’explicatif s’attend à recevoir des données transformées et, par défaut, les importances sont retournées pour les données transformées. Dans les deux cas, la sortie peut être spécifiée en définissant get_raw explicitement sur True ou False sur la méthode d’explication de l’explicatif .

Constructeur

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

Paramètres

Nom	Description
original_explainer Obligatoire	<xref:interpret_community.common.base_explainer.BaseExplainer> L’explicatif du temps d’entraînement utilisé à l’origine pour expliquer le modèle.
feature_maps	list[ndarray] ou list[csr_matrix] Liste des mappages de fonctionnalités d’une fonctionnalité brute à une fonctionnalité générée. La liste peut être des tableaux numpy ou des matrices éparses où chaque entrée de tableau (raw_index, generated_index) est le poids de chaque paire de caractéristiques brute générée. Les autres entrées sont définies sur zéro. Pour une séquence de transformations [t1, t2, ..., tn] générant des fonctionnalités générées à partir de caractéristiques brutes, la liste des mappages de caractéristiques correspond à la valeur brute aux cartes générées dans le même ordre que t1, t2, etc. Si le mappage global brut à fonctionnalité généré de t1 à tn est disponible, il suffit que cette carte de fonctionnalités dans une seule liste d’éléments puisse être passée. Valeur par défaut: None
raw_features	list[str] Liste facultative des noms de fonctionnalités pour les fonctionnalités brutes qui peuvent être spécifiées si l’explicatif d’origine calcule l’explication sur les fonctionnalités conçues. Valeur par défaut: None
engineered_features	list[str] Liste facultative des noms de fonctionnalités pour les fonctionnalités conçues qui peuvent être spécifiées si l’explicatif d’origine a des transformations passées et calcule uniquement les importances sur les caractéristiques brutes. Valeur par défaut: None
original_explainer Obligatoire	<xref:interpret_community.common.base_explainer.BaseExplainer> L’explicatif du temps d’entraînement utilisé à l’origine pour expliquer le modèle.
feature_maps Obligatoire	list[ndarray] ou list[csr_matrix] Liste des mappages de fonctionnalités d’une fonctionnalité brute à une fonctionnalité générée. La liste peut être des tableaux numpy ou des matrices éparses où chaque entrée de tableau (raw_index, generated_index) est le poids de chaque paire de caractéristiques brute générée. Les autres entrées sont définies sur zéro. Pour une séquence de transformations [t1, t2, ..., tn] générant des fonctionnalités générées à partir de caractéristiques brutes, la liste des mappages de caractéristiques correspond à la valeur brute aux cartes générées dans le même ordre que t1, t2, etc. Si le mappage global brut à fonctionnalité généré de t1 à tn est disponible, il suffit que cette carte de fonctionnalités dans une seule liste d’éléments puisse être passée.
raw_features Obligatoire	list[str] Liste facultative des noms de fonctionnalités pour les fonctionnalités brutes qui peuvent être spécifiées si l’explicatif d’origine calcule l’explication sur les fonctionnalités conçues.
engineered_features Obligatoire	list[str] Liste facultative des noms de fonctionnalités pour les fonctionnalités conçues qui peuvent être spécifiées si l’explicatif d’origine a des transformations passées et calcule uniquement les importances sur les caractéristiques brutes.

Méthodes

explain	Utilisez le modèle pour évaluer approximativement les valeurs d’importance des caractéristiques des données.
fit	Implémentez la méthode factice requise pour ajuster l’interface de pipeline scikit-learn.
predict	Utilisez treeExplainer et le modèle d’arborescence pour obtenir les valeurs d’importance des caractéristiques des données. Encapsule la fonction .explain().

explain

Utilisez le modèle pour évaluer approximativement les valeurs d’importance des caractéristiques des données.

abstract explain(evaluation_examples, get_raw)

Paramètres

Nom	Description
evaluation_examples Obligatoire	array ou DataFrame ou csr_matrix Matrice d’exemples de vecteurs de caractéristiques (# exemples x # caractéristiques) sur laquelle expliquer la sortie du modèle.
get_raw Obligatoire	bool Si la valeur est True, les valeurs d’importance pour les fonctionnalités brutes sont retournées. Si la valeur est False, les valeurs d’importance des fonctionnalités conçues sont retournées. Si des transformations non spécifiées ont été passées dans l’explicatif d’origine, les valeurs d’importance brute sont retournées. Si des valeurs d’importance non spécifiées et feature_maps ont été transmises à l’explicatif de scoring, les valeurs d’importance conçues sont retournées.

Retours

Type	Description
list	Pour un modèle avec une sortie unique telle que la régression, cette méthode retourne une matrice de valeurs d’importance des caractéristiques. Pour les modèles avec des sorties vectorielles, cette fonction retourne une liste de ces matrices, une pour chaque sortie. La dimension de cette matrice est (# exemples x # fonctionnalités).

fit

Implémentez la méthode factice requise pour ajuster l’interface de pipeline scikit-learn.

fit(X, y=None)

Paramètres

Nom	Description
X Obligatoire	Données d’apprentissage.
y	Cibles d’entraînement. Valeur par défaut: None

predict

Utilisez treeExplainer et le modèle d’arborescence pour obtenir les valeurs d’importance des caractéristiques des données.

Encapsule la fonction .explain().

predict(evaluation_examples)

Paramètres

Nom	Description
evaluation_examples Obligatoire	array ou DataFrame ou csr_matrix Matrice d’exemples de vecteurs de caractéristiques (# exemples x # caractéristiques) sur laquelle expliquer la sortie du modèle.

Retours

Type	Description
list	Pour un modèle avec une sortie unique telle que la régression, cela retourne une matrice de valeurs d’importance des caractéristiques. Pour les modèles avec des sorties vectorielles, cette fonction retourne une liste de ces matrices, une pour chaque sortie. La dimension de cette matrice est (# exemples x # fonctionnalités).

Attributs

engineered_features

Obtenez les noms de fonctionnalités conçus correspondant au paramètre get_raw=False lors de l’appel d’explication.

Si l’explicatif d’origine avait des transformations passées à celui-ci, les fonctionnalités conçues doivent être transmises au constructeur de l’explicatif de scoring à l’aide du paramètre engineered_features. Sinon, si des mappages de caractéristiques ont été passés à l’explicatif de scoring, les fonctionnalités conçues sont identiques aux fonctionnalités.

Retours

Type	Description
list[str], None	Noms de fonctionnalités conçus ou Aucun si aucun n’a été donné par l’utilisateur.

features

Obtenez les noms des fonctionnalités.

Retourne les noms de fonctionnalités par défaut si get_raw n’est pas spécifié lors de l’appel d’explication.

Retours

Type	Description
list[str], None	Noms des fonctionnalités ou Aucun si aucun n’a été donné par l’utilisateur.

raw_features

Obtenez les noms de fonctionnalités brutes correspondant au paramètre get_raw=True lors de l’appel d’explication.

Si l’explicatif d’origine n’a pas eu de transformations transmises à celui-ci et que feature_maps ont été passés à l’explicatif de scoring, les noms de caractéristiques brutes doivent être passés dans le constructeur de l’explicatif de scoring à l’aide du paramètre raw_features. Sinon, les fonctionnalités brutes sont identiques aux fonctionnalités.

Retours

Type	Description
list[str], None	Noms de fonctionnalités brutes ou Aucun si aucun n’a été donné par l’utilisateur.