Partager via

ExplanationClient Classe

  • Référence

Définit le client qui charge et télécharge les explications.

Crée le client utilisé pour interagir avec les explications et l’historique des exécutions.

Héritage
builtins.object
ExplanationClient

Constructeur

ExplanationClient(service_context, experiment_name, run_id, _run=None, datastore_name=None)

Paramètres

Nom Description
service_context
Obligatoire
<xref:ServiceContext>

Détenteur des informations de service.
run_id
Obligatoire
str

GUID représentant une exécution.
_run
Run

Une exécution. En cas de réussite, les autres arguments seront ignorés.

Valeur par défaut: None
service_context
Obligatoire
<xref:ServiceContext>

Détenteur des informations de service.
run_id
Obligatoire
str

GUID représentant une exécution.
_run
Obligatoire
Run

Une exécution. S’il est transmis, run_id sera ignoré.
datastore_name
str

Nom du magasin de données à utiliser pour les chargements (valeurs par défaut dans le magasin d’espace de travail)

Valeur par défaut: None
experiment_name
Obligatoire

Méthodes

download_model_explanation

Téléchargez une explication de modèle qui a été stockée dans l’historique des exécutions.
from_run

Créez le client avec la méthode de fabrique en fonction d’une exécution.
from_run_id

Créez le client avec la méthode de fabrique en fonction d’un ID d’exécution.
list_model_explanations

Retournez un dictionnaire de métadonnées pour toutes les explications de modèle disponibles.
upload_model_explanation

Téléchargez les informations d’explication du modèle dans l’historique des exécutions.

download_model_explanation

Téléchargez une explication de modèle qui a été stockée dans l’historique des exécutions.

download_model_explanation(explanation_id=None, top_k=None, comment=None, raw=None, engineered=None)

Paramètres

Nom Description
explanation_id
str

Si spécifié, tente de télécharger la ressource à partir de l’exécution avec l’ID d’explication donné. Si non spécifié, retourne l’explication la plus récemment téléchargée.

Valeur par défaut: None
top_k
int

Si spécifié, limitez les données ordonnées retournées aux fonctionnalités et valeurs les plus importantes. Si c’est le cas, global_importance_values et per_class_values contiendront les k valeurs triées les plus importantes au lieu de la liste complète habituelle des valeurs non triées.

Valeur par défaut: None
comment
str

Chaîne utilisée pour filtrer les explications basées sur les chaînes avec lesquelles elles ont été téléchargées. Requiert une correspondance exacte. Si plusieurs explications partagent cette chaîne, la plus récente est retournée.

Valeur par défaut: None
raw
bool ou None

Si la valeur est true ou false, les explications sont filtrées selon qu’elles sont brutes ou non. Si rien n’est spécifié, ce filtre ne sera pas appliqué.

Valeur par défaut: None
engineered
bool ou None

Si la valeur est true ou false, les explications sont filtrées selon qu’elles sont traitées ou non. Si rien n’est spécifié, ce filtre ne sera pas appliqué.

Valeur par défaut: None

Retours

Type Description
<xref:interpret_community.explanation.explanation.BaseExplanation>

L’explication telle qu’elle a été téléchargée dans l’historique des exécutions

from_run

Créez le client avec la méthode de fabrique en fonction d’une exécution.

from_run(run, datastore_name=None)

Paramètres

Nom Description
cls
Obligatoire
ExplanationClient

Classe ExplanationClient.
run
Obligatoire
Run

Les explications de l’exécution y seront jointes.
datastore_name
str

Nom du magasin de données à utiliser pour les chargements (valeurs par défaut dans le magasin d’espace de travail)

Valeur par défaut: None

Retours

Type Description
ExplanationClient

Instance de ExplanationClient.

from_run_id

Créez le client avec la méthode de fabrique en fonction d’un ID d’exécution.

from_run_id(workspace, experiment_name, run_id, datastore_name=None)

Paramètres

Nom Description
cls
Obligatoire
ExplanationClient

Classe ExplanationClient.
workspace
Obligatoire
Workspace

Objet qui représente un espace de travail.
experiment_name
Obligatoire
str

Nom d’une expérience.
run_id
Obligatoire
str

GUID représentant une exécution.
datastore_name
str

Nom du magasin de données à utiliser pour les chargements (valeurs par défaut dans le magasin d’espace de travail)

Valeur par défaut: None

Retours

Type Description
ExplanationClient

Instance de ExplanationClient.

list_model_explanations

Retournez un dictionnaire de métadonnées pour toutes les explications de modèle disponibles.

list_model_explanations(comment=None, raw=None, engineered=None)

Paramètres

Nom Description
comment
str

Chaîne utilisée pour filtrer les explications basées sur les chaînes avec lesquelles elles ont été téléchargées. Requiert une correspondance exacte.

Valeur par défaut: None
raw
bool ou None

Si la valeur est true ou false, les explications sont filtrées selon qu’elles sont brutes ou non. Si rien n’est spécifié, ce filtre ne sera pas appliqué.

Valeur par défaut: None
engineered
bool ou None

Si la valeur est true ou false, les explications sont filtrées selon qu’elles sont traitées ou non. Si rien n’est spécifié, ce filtre ne sera pas appliqué.

Valeur par défaut: None

Retours

Type Description
dict

Dictionnaire de métadonnées d’explication telles que l’ID, le type de données, la méthode d’explication, le type de modèle et l’heure de téléchargement, trié par heure de téléchargement

upload_model_explanation

Téléchargez les informations d’explication du modèle dans l’historique des exécutions.

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

Paramètres

Nom Description
explanation
Obligatoire
<xref:interpret_community.explanation.explanation.BaseExplanation>

Informations d’explication à enregistrer.
max_num_blocks
int

Nombre maximal de blocs à stocker.

Valeur par défaut: None
block_size
int

Taille de chaque bloc pour le résumé stocké dans le stockage des artefacts.

Valeur par défaut: None
top_k
int

Nombre de fonctionnalités importantes stockées dans l’explication. Si spécifié, seuls les noms et les valeurs correspondant aux K fonctionnalités les plus importantes seront retournés/stockés. Si c’est le cas, global_importance_values et per_class_values contiendront les k valeurs triées les plus importantes au lieu de la liste complète habituelle des valeurs non triées.

Valeur par défaut: None
comment
str

Chaîne facultative pour identifier l’explication. La chaîne s’affiche lorsque vous répertoriez des explications, ce qui permet d’identifier les explications téléchargées.

Valeur par défaut: None
init_dataset_id
str

ID du jeu de données d’initialisation (arrière-plan) dans le service de jeu de données, si disponible. Utilisé pour lier l’explication au jeu de données.

Valeur par défaut: None
eval_dataset_id
str

ID du jeu de données d’évaluation dans le service de jeu de données, si disponible. Utilisé pour lier l’explication au jeu de données.

Valeur par défaut: None
ys_pred_dataset_id
str

ID du jeu de données de valeurs prédites dans le service de jeu de données, si disponible.

Valeur par défaut: None
ys_pred_proba_dataset_id
str

ID du jeu de données de valeurs de probabilité prédites dans le service de jeu de données, si disponible.

Valeur par défaut: None
upload_datasets
bool

Si la valeur est true et qu’aucun ID de jeu de données n’est transmis, le jeu de données d’évaluation est téléchargé vers le stockage Azure en tant qu’objet DataSet. Cela permettra d’associer l’explication au jeu de données dans l’affichage Web.

Valeur par défaut: False
model_id
str

ID de modèle MMS.

Valeur par défaut: None
true_ys
list | <xref:pandas.Dataframe> | ndarray

Les étiquettes true des exemples d’évaluation.

Valeur par défaut: None
visualization_points
int ou list[int]

Si la valeur est un entier, il s’agit de la limite supérieure du nombre de points qui seront disponibles pour la visualisation dans l’interface utilisateur Web. Si la valeur est une liste d’entiers, ces entiers sont utilisés comme indices pour sélectionner un échantillon de points (données d’origine et explications) à visualiser dans l’interface utilisateur Web. Si vous n’envisagez pas d’afficher l’explication dans l’interface utilisateur Web, ce paramètre peut être mis à 0 et aucun calcul ou stockage supplémentaire ne sera effectué.

La limite supérieure de l’entier ou de la longueur de la liste est actuellement de 20 000 (vingt mille). Dans le cas où un nombre entier plus grand ou une liste plus longue est transmis, la fonction échoue. L’objectif est de limiter la quantité de données qui entrent dans l’interface utilisateur Web pour des raisons de performances. Avec un plus grand nombre d’évaluations, cette limite peut être augmentée.

Valeur par défaut: 5000

Attributs

run

Obtenez l’exécution à partir du client d’explication.

Retours

Type Description
Run

Objet d’exécution.