ScoringExplainer Classe

Définit un modèle de scoring.

Si les transformations ont été transmises à original_explainer, ces transformations sont acheminées vers l’explicatif de scoring, les données brutes sont attendues et des valeurs d’importance sont retournées par défaut pour les fonctionnalités brutes. Si feature_maps sont transmis ici (NON destiné à être utilisé en même temps que les transformations), l’explicatif attend les 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 affectant explicitement à get_raw la valeur True ou False dans la méthode explain de l’explicatif.

Initialisez scoringExplainer.

Si les transformations ont été transmises à original_explainer, ces transformations sont acheminées vers l’explicatif de scoring, les données brutes sont attendues et des valeurs d’importance sont retournées par défaut pour les fonctionnalités brutes. Si feature_maps sont transmis ici (NON destiné à être utilisé en même temps que les transformations), l’explicatif attend les 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 affectant explicitement à get_raw la valeur True ou False dans la méthode explain de l’explicatif.

Héritage

azureml._logging.chained_identity.ChainedIdentity

ScoringExplainer

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> Temps d’apprentissage d’origine de l’explicatif pour expliquer le modèle.
feature_maps	list[ndarray] ou list[csr_matrix] Liste de mappages de fonctionnalités des fonctionnalités brutes à générées. La liste peut être la liste de tableaux numpy ou de matrices éparses où chaque entrée de tableau (raw_index, generated_index) représente la pondération de chaque paire de fonctionnalités brutes 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 fonctionnalités brutes, la liste des mappages de fonctionnalités correspond aux mappages bruts à générés dans le même ordre que t1, t2, etc. Si le mappage de fonctionnalités brutes à générées global de t1 à tn est disponible, il est possible de transmettre uniquement cette carte de fonctionnalités dans une liste d’éléments unique. 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 fonctionnalités brutes. Valeur par défaut: None
original_explainer Obligatoire	<xref:interpret_community.common.base_explainer.BaseExplainer> Temps d’apprentissage d’origine de l’explicatif pour expliquer le modèle.
feature_maps Obligatoire	list[ndarray] ou list[csr_matrix] Liste de mappages de fonctionnalités des fonctionnalités brutes à générées. La liste peut être la liste de tableaux numpy ou de matrices éparses où chaque entrée de tableau (raw_index, generated_index) représente la pondération de chaque paire de fonctionnalités brutes 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 fonctionnalités brutes, la liste des mappages de fonctionnalités correspond aux mappages bruts à générés dans le même ordre que t1, t2, etc. Si le mappage de fonctionnalités brutes à générées global de t1 à tn est disponible, il est possible de transmettre uniquement cette carte de fonctionnalités dans une liste d’éléments unique.
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 fonctionnalités brutes.

Méthodes

explain	Utilisez le modèle de scoring pour évaluer les valeurs d’importance d’une caractéristique des données.
fit	Implémente une méthode factice requise pour adapter l’interface de pipeline scikit-Learn.
predict	Utilisez TreeExplainer et le modèle en arborescence de scoring pour obtenir les valeurs d’importance d’une fonctionnalité des données. Enveloppe la fonction .explain().

explain

Utilisez le modèle de scoring pour évaluer les valeurs d’importance d’une caractéristique 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 fonctionnalité (nombre d’exemples x nombre de fonctionnalités) sur laquelle expliquer la sortie du modèle.
get_raw Obligatoire	bool Si la valeur est True, les valeurs d’importance des fonctionnalités brutes sont retournées. Si la valeur est False, les valeurs d’importance des fonctionnalités de conception sont retournées. Si la valeur n’est pas spécifiée et que transformations a été transmis à l’explicatif d’origine, les valeurs d’importance brutes sont retournées. Si la valeur n’est pas spécifiée et que feature_maps a été transmis à l’explicatif de scoring, les valeurs d’importance de conception sont retournées.

Retours

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

fit

Implémente une méthode factice requise pour adapter l’interface de pipeline scikit-Learn.

fit(X, y=None)

Paramètres

Nom	Description
X Obligatoire	Données de formation.
y	Cibles d’apprentissage. Valeur par défaut: None

predict

Utilisez TreeExplainer et le modèle en arborescence de scoring pour obtenir les valeurs d’importance d’une fonctionnalité des données.

Enveloppe 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 fonctionnalité (nombre d’exemples x nombre de fonctionnalités) sur laquelle expliquer la sortie du modèle.

Retours

Type	Description
list	Pour un modèle avec une seule sortie telle que la régression, cela retourne une matrice de valeurs d’importance d’une fonctionnalité. Pour les modèles avec des sorties de vecteurs, cette fonction retourne une liste de ces matrices, une pour chaque sortie. La dimension de cette matrice est (nombre d’exemples x nombre de 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 des transformations ont été transmises à l’explicatif d’origine, 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é transmis à l’explicatif de scoring, les fonctionnalités conçues seront les mêmes que les fonctionnalités.

Retours

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

features

Obtenir 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 None si aucun nom n’a été fourni par l’utilisateur.

raw_features

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

Si les transformations de l’explicatif d’origine ne lui ont pas été transmises et que feature_maps ont été transmises à l’explicatif de scoring, les noms de caractéristiques bruts doivent être passés au constructeur de l’explicatif de scoring à l’aide du paramètre raw_features. Sinon, les fonctionnalités brutes seront les mêmes que les fonctionnalités.

Retours

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