ExplanationClient Klasse

Definiert den Client, der Erklärungen hoch- und herunterlädt.

Erstellen des Clients, der für die Interaktion mit Erklärungen und für den Ausführungsverlauf verwendet wird

Vererbung

builtins.object

ExplanationClient

Konstruktor

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

Parameter

Name	Beschreibung
service_context Erforderlich	<xref:ServiceContext> Platzhalter für Dienstinformationen.
run_id Erforderlich	str GUID, die eine Ausführung darstellt.
_run	Run Ausführung. Wenn eine Ausführung übergeben wird, werden andere Argumente ignoriert. Standardwert: None
service_context Erforderlich	<xref:ServiceContext> Platzhalter für Dienstinformationen.
run_id Erforderlich	str GUID, die eine Ausführung darstellt.
_run Erforderlich	Run Ausführung. Bei Übergabe wird run_id ignoriert.
datastore_name	str Name des Datenspeichers, der für Uploads verwendet werden soll (standardmäßig arbeitsbereichsspeicher) Standardwert: None
experiment_name Erforderlich

Methoden

download_model_explanation	Herunterladen einer Modellerklärung, die im Ausführungsverlauf gespeichert wurde.
from_run	Erstellen des Clients mit der Factorymethode anhand einer Ausführung.
from_run_id	Erstellen des Clients mit der Factorymethode anhand einer Ausführungs-ID.
list_model_explanations	Dient zum Zurückgeben eines Wörterbuchs mit Metadaten für alle verfügbaren Modellerklärungen.
upload_model_explanation	Hochladen der Modellerklärungsinformationen in den Ausführungsverlauf.

download_model_explanation

Herunterladen einer Modellerklärung, die im Ausführungsverlauf gespeichert wurde.

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

Parameter

Name	Beschreibung
explanation_id	str Wenn eine ID angegeben wird, wird versucht, die Ressource aus der Ausführung mit der angegebenen Erklärungs-ID herunterzuladen. Ist keine ID angegeben, wird die zuletzt hochgeladene Erklärung zurückgegeben. Standardwert: None
top_k	int Sofern angegeben, werden die zurückgegebenen sortierten Daten auf die wichtigsten Features und Werte beschränkt. In diesem Fall enthalten „global_importance_values“ und „per_class_values“ die sortierten wichtigsten 1.000 Werte anstelle der üblichen vollständigen Liste unsortierter Werte. Standardwert: None
comment	str Eine Zeichenfolge zum Filtern von Erklärungen auf Grundlage der Zeichenfolgen, mit denen sie hochgeladen wurden. Erfordert eine genaue Übereinstimmung. Wenn die Zeichenfolge in mehreren Erklärungen vorkommt, wird die neueste Erklärung zurückgegeben. Standardwert: None
raw	bool oder None Bei „True“ oder „False“ werden Erklärungen basierend darauf gefiltert, ob es sich um Erklärungen im Rohformat handelt. Wenn nichts angegeben wird, wird dieser Filter nicht angewendet. Standardwert: None
engineered	bool oder None Bei „True“ oder „False“ werden Erklärungen basierend darauf gefiltert, ob es sich um entwickelte Erklärungen handelt. Wenn nichts angegeben wird, wird dieser Filter nicht angewendet. Standardwert: None

Gibt zurück

Typ	Beschreibung
<xref:interpret_community.explanation.explanation.BaseExplanation>	Die Erklärung in der Form, in der sie in den Ausführungsverlauf hochgeladen wurde.

from_run

Erstellen des Clients mit der Factorymethode anhand einer Ausführung.

from_run(run, datastore_name=None)

Parameter

Name	Beschreibung
cls Erforderlich	ExplanationClient Die ExplanationClient-Klasse.
run Erforderlich	Run Die Ausführungserklärungen werden angefügt.
datastore_name	str Name des Datenspeichers, der für Uploads verwendet werden soll (standardmäßig arbeitsbereichsspeicher) Standardwert: None

Gibt zurück

Typ	Beschreibung
ExplanationClient	Eine Instanz des ExplanationClient.

from_run_id

Erstellen des Clients mit der Factorymethode anhand einer Ausführungs-ID.

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

Parameter

Name	Beschreibung
cls Erforderlich	ExplanationClient Die ExplanationClient-Klasse.
workspace Erforderlich	Workspace Ein Objekt, das einen Arbeitsbereich darstellt.
experiment_name Erforderlich	str Der Name eines Experiments.
run_id Erforderlich	str GUID, die eine Ausführung darstellt.
datastore_name	str Name des Datenspeichers, der für Uploads verwendet werden soll (standardmäßig arbeitsbereichsspeicher) Standardwert: None

Gibt zurück

Typ	Beschreibung
ExplanationClient	Eine Instanz des ExplanationClient.

list_model_explanations

Dient zum Zurückgeben eines Wörterbuchs mit Metadaten für alle verfügbaren Modellerklärungen.

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

Parameter

Name	Beschreibung
comment	str Eine Zeichenfolge zum Filtern von Erklärungen auf Grundlage der Zeichenfolgen, mit denen sie hochgeladen wurden. Erfordert eine genaue Übereinstimmung. Standardwert: None
raw	bool oder None Bei „True“ oder „False“ werden Erklärungen basierend darauf gefiltert, ob es sich um Erklärungen im Rohformat handelt. Wenn nichts angegeben wird, wird dieser Filter nicht angewendet. Standardwert: None
engineered	bool oder None Bei „True“ oder „False“ werden Erklärungen basierend darauf gefiltert, ob es sich um entwickelte Erklärungen handelt. Wenn nichts angegeben wird, wird dieser Filter nicht angewendet. Standardwert: None

Gibt zurück

Typ	Beschreibung
dict	Ein Wörterbuch mit Erklärungsmetadaten wie ID, Datentyp, Erklärungsmethode, Modelltyp und Uploadzeit (sortiert nach der Uploadzeit).

upload_model_explanation

Hochladen der Modellerklärungsinformationen in den Ausführungsverlauf.

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

Parameter

Name	Beschreibung
explanation Erforderlich	<xref:interpret_community.explanation.explanation.BaseExplanation> Die zu speichernden Erklärungsinformationen.
max_num_blocks	int Die maximale Anzahl von Blöcken, die gespeichert werden sollen. Standardwert: None
block_size	int Die Größe jedes Blocks für die im Artefaktspeicher gespeicherte Zusammenfassung. Standardwert: None
top_k	int Die Anzahl wichtiger Features, die in der Erklärung gespeichert sind. Sofern angegeben, werden nur die Namen und Werte der wichtigsten 1.000 Features zurückgegeben/gespeichert. In diesem Fall enthalten „global_importance_values“ und „per_class_values“ die sortierten wichtigsten 1.000 Werte anstelle der üblichen vollständigen Liste unsortierter Werte. Standardwert: None
comment	str Eine optionale Zeichenfolge zum Identifizieren der Erklärung. Die Zeichenfolge wird beim Auflisten von Erklärungen angezeigt, damit hochgeladene Erklärungen erkannt werden können. Standardwert: None
init_dataset_id	str Die ID des Initialisierungs- bzw. Hintergrunddatasets im Datasetdienst (sofern verfügbar). Wird verwendet, um die Erklärung mit dem Dataset zu verknüpfen. Standardwert: None
eval_dataset_id	str Die ID des Auswertungsdatasets im Datasetdienst (sofern verfügbar). Wird verwendet, um die Erklärung mit dem Dataset zu verknüpfen. Standardwert: None
ys_pred_dataset_id	str Die ID des Datasets mit den vorhergesagten Werten im Datasetdienst (sofern verfügbar). Standardwert: None
ys_pred_proba_dataset_id	str Die ID des Datasets mit den vorhergesagten Wahrscheinlichkeitswerten im Datasetdienst (sofern verfügbar). Standardwert: None
upload_datasets	bool Wenn „True“ festgelegt ist und keine Dataset-IDs übergeben werden, wird das Auswertungsdataset als Datasetobjekt in Azure Storage hochgeladen. Dadurch kann die Erklärung in der Webansicht mit dem Dataset verknüpft werden. Standardwert: False
model_id	str Die MMS-Modell-ID. Standardwert: None
true_ys	list | <xref:pandas.Dataframe> | ndarray Die richtigen Bezeichnungen für die Auswertungsbeispiele. Standardwert: None
visualization_points	int oder list[int] Wenn eine ganze Zahl angegeben wird, ist dies die Obergrenze für die Anzahl von Punkten, die auf der Webbenutzeroberfläche zur Visualisierung verfügbar sind. Wenn eine Liste von ganzen Zahlen angegeben wird, werden diese als Indizes zum Auswählen einer Stichprobe von Punkten (ursprüngliche Daten und Erklärungen) verwendet, die auf der Webbenutzeroberfläche visualisiert werden. Wenn Sie nicht vorhaben, die Erklärung auf der Webbenutzeroberfläche anzuzeigen, können Sie diesen Parameter auf 0 festlegen, sodass weder eine zusätzliche Berechnung noch zusätzlicher Speicherplatz erforderlich sind. Die Obergrenze für die ganze Zahl oder die Länge der Liste beträgt derzeit 20.000 (zwanzigtausend). Falls eine größere ganze Zahl oder eine längere Liste übergeben wird, tritt bei der Funktion ein Fehler auf. Mit dieser Funktion soll aus Leistungsgründen die Menge an Daten begrenzt werden, die in die Webbenutzeroberfläche gelangen. Wenn umfassendere Auswertungen vorliegen, wird dieser Grenzwert möglicherweise erhöht. Standardwert: 5000

Attribute

run

Abrufen der Ausführung vom Erklärungsclient.

Gibt zurück

Typ	Beschreibung
Run	Das Ausführungsojekt.