ExplanationClient Klasa

Definiuje klienta, który przekazuje i pobiera wyjaśnienia.

Utwórz klienta używanego do interakcji z wyjaśnieniami i historią uruchamiania.

Dziedziczenie

builtins.object

ExplanationClient

Konstruktor

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

Parametry

Nazwa	Opis
service_context Wymagane	<xref:ServiceContext> Posiadacz informacji o usłudze.
run_id Wymagane	str Identyfikator GUID reprezentujący przebieg.
_run	Run Przebieg. Jeśli zostanie przekazana, inne elementy args zostaną zignorowane. Domyślna wartość: None
service_context Wymagane	<xref:ServiceContext> Posiadacz informacji o usłudze.
run_id Wymagane	str Identyfikator GUID reprezentujący przebieg.
_run Wymagane	Run Przebieg. Jeśli zostanie przekazana, run_id zostaną zignorowane.
datastore_name	str Nazwa magazynu danych, który ma być używany do przekazywania (domyślnie jest to magazyn obszarów roboczych) Domyślna wartość: None
experiment_name Wymagane

Metody

download_model_explanation	Pobierz wyjaśnienie modelu, które zostało zapisane w historii uruchamiania.
from_run	Utwórz klienta z metodą fabryki przy użyciu przebiegu.
from_run_id	Utwórz klienta z metodą fabryki przy użyciu identyfikatora przebiegu.
list_model_explanations	Zwróć słownik metadanych dla wszystkich dostępnych wyjaśnień modelu.
upload_model_explanation	Przekaż informacje objaśnienia modelu, aby uruchomić historię.

download_model_explanation

Pobierz wyjaśnienie modelu, które zostało zapisane w historii uruchamiania.

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

Parametry

Nazwa	Opis
explanation_id	str Jeśli zostanie określony, spróbuje pobrać zasób z przebiegu przy użyciu podanego identyfikatora wyjaśnienia. Jeśli nieokreślone, zwraca ostatnio przekazane wyjaśnienie. Domyślna wartość: None
top_k	int W przypadku określenia ogranicz uporządkowane dane zwracane do najważniejszych funkcji i wartości. W takim przypadku global_importance_values i per_class_values będą zawierać najwyżej posortowane wartości, a nie zwykłą pełną listę niesortowanych wartości. Domyślna wartość: None
comment	str Ciąg służący do filtrowania wyjaśnień na podstawie ciągów, za pomocą których zostały one przekazane. Wymaga dokładnego dopasowania. Jeśli wiele wyjaśnień udostępnia ten ciąg, zostanie zwrócony najnowszy. Domyślna wartość: None
raw	bool lub None W przypadku wartości Prawda lub Fałsz wyjaśnienia będą filtrowane na podstawie tego, czy są nieprzetworzone, czy nie. Jeśli nic nie zostanie określone, ten filtr nie zostanie zastosowany. Domyślna wartość: None
engineered	bool lub None W przypadku wartości Prawda lub Fałsz wyjaśnienia będą filtrowane na podstawie tego, czy są one zaprojektowane, czy nie. Jeśli nic nie zostanie określone, ten filtr nie zostanie zastosowany. Domyślna wartość: None

Zwraca

Typ	Opis
<xref:interpret_community.explanation.explanation.BaseExplanation>	Wyjaśnienie przekazane do historii uruchamiania

from_run

Utwórz klienta z metodą fabryki przy użyciu przebiegu.

from_run(run, datastore_name=None)

Parametry

Nazwa	Opis
cls Wymagane	ExplanationClient Klasa ExplanationClient.
run Wymagane	Run Wyjaśnienia przebiegu zostaną dołączone do.
datastore_name	str Nazwa magazynu danych, który ma być używany do przekazywania (domyślnie jest to magazyn obszarów roboczych) Domyślna wartość: None

Zwraca

Typ	Opis
ExplanationClient	Wystąpienie klasy ExplanationClient.

from_run_id

Utwórz klienta z metodą fabryki przy użyciu identyfikatora przebiegu.

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

Parametry

Nazwa	Opis
cls Wymagane	ExplanationClient Klasa ExplanationClient.
workspace Wymagane	Workspace Obiekt reprezentujący obszar roboczy.
experiment_name Wymagane	str Nazwa eksperymentu.
run_id Wymagane	str Identyfikator GUID reprezentujący przebieg.
datastore_name	str Nazwa magazynu danych, który ma być używany do przekazywania (domyślnie jest to magazyn obszarów roboczych) Domyślna wartość: None

Zwraca

Typ	Opis
ExplanationClient	Wystąpienie klasy ExplanationClient.

list_model_explanations

Zwróć słownik metadanych dla wszystkich dostępnych wyjaśnień modelu.

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

Parametry

Nazwa	Opis
comment	str Ciąg służący do filtrowania wyjaśnień na podstawie ciągów, za pomocą których zostały one przekazane. Wymaga dokładnego dopasowania. Domyślna wartość: None
raw	bool lub None W przypadku wartości Prawda lub Fałsz wyjaśnienia będą filtrowane na podstawie tego, czy są nieprzetworzone, czy nie. Jeśli nic nie zostanie określone, ten filtr nie zostanie zastosowany. Domyślna wartość: None
engineered	bool lub None W przypadku wartości Prawda lub Fałsz wyjaśnienia będą filtrowane na podstawie tego, czy są one zaprojektowane, czy nie. Jeśli nic nie zostanie określone, ten filtr nie zostanie zastosowany. Domyślna wartość: None

Zwraca

Typ	Opis
dict	Słownik metadanych wyjaśnienia, takich jak identyfikator, typ danych, metoda wyjaśnienia, typ modelu i czas przekazywania, posortowany według czasu przekazania

upload_model_explanation

Przekaż informacje objaśnienia modelu, aby uruchomić historię.

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

Parametry

Nazwa	Opis
explanation Wymagane	<xref:interpret_community.explanation.explanation.BaseExplanation> Informacje objaśnienia do zapisania.
max_num_blocks	int Maksymalna liczba bloków do zapisania. Domyślna wartość: None
block_size	int Rozmiar każdego bloku dla podsumowania przechowywanego w magazynie artefaktów. Domyślna wartość: None
top_k	int Liczba ważnych funkcji przechowywanych w objaśnieniu. W przypadku określenia zostaną zwrócone/przechowywane tylko nazwy i wartości odpowiadające najważniejszym funkcjom języka K. W takim przypadku global_importance_values i per_class_values będą zawierać najwyżej posortowane wartości, a nie zwykłą pełną listę niesortowanych wartości. Domyślna wartość: None
comment	str Opcjonalny ciąg identyfikująy wyjaśnienie. Ciąg jest wyświetlany podczas wyświetlania objaśnień, co umożliwia identyfikację przekazanych wyjaśnień. Domyślna wartość: None
init_dataset_id	str Identyfikator zestawu danych inicjowania (w tle) w usłudze Zestaw danych, jeśli jest dostępny. Służy do łączenia wyjaśnienia z zestawem danych. Domyślna wartość: None
eval_dataset_id	str Identyfikator zestawu danych oceny w usłudze Zestaw danych, jeśli jest dostępny. Służy do łączenia wyjaśnienia z zestawem danych. Domyślna wartość: None
ys_pred_dataset_id	str Identyfikator zestawu danych wartości przewidywanych w usłudze Zestaw danych, jeśli jest dostępny. Domyślna wartość: None
ys_pred_proba_dataset_id	str Identyfikator przewidywanego zestawu danych wartości prawdopodobieństwa w usłudze Dataset, jeśli jest dostępny. Domyślna wartość: None
upload_datasets	bool Jeśli ustawiono wartość True i nie przekazano żadnych identyfikatorów zestawów danych, zestaw danych oceny zostanie przekazany do usługi Azure Storage jako obiekt Zestawu danych. Pozwoli to na łączenie wyjaśnienia z zestawem danych w widoku internetowym. Domyślna wartość: False
model_id	str Identyfikator modelu MMS. Domyślna wartość: None
true_ys	list | <xref:pandas.Dataframe> | ndarray Prawdziwe etykiety dla przykładów oceny. Domyślna wartość: None
visualization_points	int lub list[int] Jeśli jest ustawiona na liczbę całkowitą, jest to górna granica liczby punktów, które będą dostępne do wizualizacji w internetowym interfejsie użytkownika. Jeśli ustawiono listę liczb całkowitych, te liczby całkowite będą używane jako indeksy do wybierania próbki punktów (oryginalnych danych i wyjaśnień) do wizualizacji w internetowym interfejsie użytkownika. Jeśli nie planujesz wyświetlania wyjaśnienia w internetowym interfejsie użytkownika, ten parametr można ustawić na wartość 0 i nie zostaną wykonane dodatkowe obliczenia ani magazyn. Górny limit liczby całkowitej lub długości listy wynosi obecnie 20000 (dwadzieścia tysięcy). W przypadku przekazania większej liczby całkowitej lub dłuższej listy funkcja zakończy się niepowodzeniem. Celem jest ograniczenie ilości danych wprowadzanych do internetowego interfejsu użytkownika ze względu na wydajność. W przypadku większej oceny ten limit może zostać podniesiony. Domyślna wartość: 5000

Atrybuty

run

Pobierz przebieg z klienta wyjaśnienia.

Zwraca

Typ	Opis
Run	Obiekt run.