ExplanationClient Classe

Definisce il client che carica e scarica spiegazioni.

Creare il client usato per interagire con spiegazioni e cronologia di esecuzione.

Ereditarietà

builtins.object

ExplanationClient

Costruttore

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

Parametri

Nome	Descrizione
service_context Necessario	<xref:ServiceContext> Titolare delle informazioni sul servizio.
run_id Necessario	str GUID che rappresenta un'esecuzione.
_run	Run Esecuzione. Se passato, gli altri arg verranno ignorati. Valore predefinito: None
service_context Necessario	<xref:ServiceContext> Titolare delle informazioni sul servizio.
run_id Necessario	str GUID che rappresenta un'esecuzione.
_run Necessario	Run Esecuzione. Se passato, run_id verrà ignorato.
datastore_name	str Nome dell'archivio dati da usare per i caricamenti (impostazione predefinita nell'archivio aree di lavoro) Valore predefinito: None
experiment_name Necessario

Metodi

download_model_explanation	Scaricare una spiegazione del modello archiviata nella cronologia di esecuzione.
from_run	Creare il client con il metodo factory assegnato a un'esecuzione.
from_run_id	Creare il client con il metodo factory in base a un ID di esecuzione.
list_model_explanations	Restituisce un dizionario di metadati per tutte le spiegazioni del modello disponibili.
upload_model_explanation	Caricare le informazioni sulla spiegazione del modello per eseguire la cronologia.

download_model_explanation

Scaricare una spiegazione del modello archiviata nella cronologia di esecuzione.

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

Parametri

Nome	Descrizione
explanation_id	str Se specificato, tenta di scaricare l'asset dall'esecuzione con l'ID spiegazione specificato. Se non specificato, restituisce la spiegazione caricata più di recente. Valore predefinito: None
top_k	int Se specificato, limitare i dati ordinati restituiti alle funzionalità e ai valori più importanti. Se si tratta del caso, global_importance_values e per_class_values conterrà i valori ordinati in alto k anziché il consueto elenco completo di valori non ordinati. Valore predefinito: None
comment	str Stringa usata per filtrare le spiegazioni in base alle stringhe caricate con. Richiede una corrispondenza esatta. Se più spiegazioni condividono questa stringa, verrà restituito il valore più recente. Valore predefinito: None
raw	bool oppure None Se True o False, le spiegazioni verranno filtrate in base al fatto che siano non elaborate o meno. Se non viene specificato alcun elemento, questo filtro non verrà applicato. Valore predefinito: None
engineered	bool oppure None Se True o False, le spiegazioni verranno filtrate in base al fatto che siano ingegneriate o meno. Se non viene specificato alcun elemento, questo filtro non verrà applicato. Valore predefinito: None

Restituisce

Tipo	Descrizione
<xref:interpret_community.explanation.explanation.BaseExplanation>	Spiegazione come è stata caricata per eseguire la cronologia di esecuzione

from_run

Creare il client con il metodo factory assegnato a un'esecuzione.

from_run(run, datastore_name=None)

Parametri

Nome	Descrizione
cls Necessario	ExplanationClient Classe ExplanationClient.
run Necessario	Run Le spiegazioni di esecuzione verranno associate a.
datastore_name	str Nome dell'archivio dati da usare per i caricamenti (impostazione predefinita nell'archivio aree di lavoro) Valore predefinito: None

Restituisce

Tipo	Descrizione
ExplanationClient	Istanza di ExplanationClient.

from_run_id

Creare il client con il metodo factory in base a un ID di esecuzione.

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

Parametri

Nome	Descrizione
cls Necessario	ExplanationClient Classe ExplanationClient.
workspace Necessario	Workspace Oggetto che rappresenta un'area di lavoro.
experiment_name Necessario	str Nome di un esperimento.
run_id Necessario	str GUID che rappresenta un'esecuzione.
datastore_name	str Nome dell'archivio dati da usare per i caricamenti (impostazione predefinita nell'archivio aree di lavoro) Valore predefinito: None

Restituisce

Tipo	Descrizione
ExplanationClient	Istanza di ExplanationClient.

list_model_explanations

Restituisce un dizionario di metadati per tutte le spiegazioni del modello disponibili.

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

Parametri

Nome	Descrizione
comment	str Stringa usata per filtrare le spiegazioni in base alle stringhe caricate con. Richiede una corrispondenza esatta. Valore predefinito: None
raw	bool oppure None Se True o False, le spiegazioni verranno filtrate in base al fatto che siano non elaborate o meno. Se non viene specificato alcun elemento, questo filtro non verrà applicato. Valore predefinito: None
engineered	bool oppure None Se True o False, le spiegazioni verranno filtrate in base al fatto che siano ingegneriate o meno. Se non viene specificato alcun elemento, questo filtro non verrà applicato. Valore predefinito: None

Restituisce

Tipo	Descrizione
dict	Dizionario dei metadati della spiegazione, ad esempio ID, tipo di dati, metodo di spiegazione, tipo di modello e tempo di caricamento, ordinati in base al tempo di caricamento

upload_model_explanation

Caricare le informazioni sulla spiegazione del modello per eseguire la cronologia.

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

Parametri

Nome	Descrizione
explanation Necessario	<xref:interpret_community.explanation.explanation.BaseExplanation> Informazioni di spiegazione da salvare.
max_num_blocks	int Numero massimo di blocchi da archiviare. Valore predefinito: None
block_size	int Dimensioni di ogni blocco per il riepilogo archiviato nell'archiviazione degli artefatti. Valore predefinito: None
top_k	int Numero di funzionalità importanti archiviate nella spiegazione. Se specificato, verranno restituiti/archiviati solo i nomi e i valori corrispondenti alle principali funzionalità K più importanti. Se si tratta del caso, global_importance_values e per_class_values conterrà i valori ordinati in alto k anziché il consueto elenco completo di valori non ordinati. Valore predefinito: None
comment	str Stringa facoltativa per identificare la spiegazione. La stringa viene visualizzata quando si elencano le spiegazioni, che consente l'identificazione delle spiegazioni caricate. Valore predefinito: None
init_dataset_id	str ID del set di dati di inizializzazione (background) nel servizio Set di dati, se disponibile. Usato per collegare la spiegazione al set di dati. Valore predefinito: None
eval_dataset_id	str ID del set di dati di valutazione nel servizio Set di dati, se disponibile. Usato per collegare la spiegazione al set di dati. Valore predefinito: None
ys_pred_dataset_id	str ID del set di dati dei valori stimati nel servizio Set di dati, se disponibile. Valore predefinito: None
ys_pred_proba_dataset_id	str ID del set di dati di probabilità stimato nel servizio Set di dati, se disponibile. Valore predefinito: None
upload_datasets	bool Se impostato su True e non vengono passati ID set di dati, il set di dati di valutazione verrà caricato nell'archiviazione di Azure come oggetto Dataset. Ciò consentirà di collegare la spiegazione al set di dati nella visualizzazione Web. Valore predefinito: False
model_id	str ID modello MMS. Valore predefinito: None
true_ys	list | <xref:pandas.Dataframe> | ndarray Etichette vere per gli esempi di valutazione. Valore predefinito: None
visualization_points	int oppure list[int] Se impostato su un intero, questo è il limite superiore sul numero di punti che saranno disponibili per la visualizzazione nell'interfaccia utente Web. Se impostato su un elenco di interi, questi interi verranno usati come indici per la selezione di un esempio di punti (dati originali e spiegazioni) da visualizzare nell'interfaccia utente Web. Se non si prevede di visualizzare la spiegazione nell'interfaccia utente Web, questo parametro può essere impostato su 0 e non verrà eseguito alcun calcolo o archiviazione aggiuntivo. Il limite superiore per l'intero o la lunghezza dell'elenco è attualmente 20000 (ventimila). Nel caso in cui venga passato un numero intero più grande o più lungo, la funzione avrà esito negativo. L'intenzione è limitare la quantità di dati che entrano nell'interfaccia utente Web per motivi di prestazioni. Con una maggiore valutazione, questo limite può essere generato. Valore predefinito: 5000

Attributi

run

Ottenere l'esecuzione dal client di spiegazione.

Restituisce

Tipo	Descrizione
Run	Oggetto run.