ScoringExplainer Klasa

Definiuje model oceniania.

Jeśli przekształcenia zostały przekazane w original_explainer, te przekształcenia zostaną przeniesione do objaśnienia oceniania, będzie oczekiwać danych pierwotnych, a domyślnie ważność zostanie zwrócona dla nieprzetworzonych funkcji. Jeśli feature_maps są przekazywane w tym miejscu (NIE przeznaczone do użycia w tym samym czasie co przekształcenia), objaśnienie będzie oczekiwać przekształconych danych, a domyślnie ważność zostanie zwrócona dla przekształconych danych. W obu przypadkach dane wyjściowe można określić przez ustawienie get_raw jawnie wartości True lub False w metodzie wyjaśnień .

Zainicjuj element ScoringExplainer.

Jeśli przekształcenia zostały przekazane w original_explainer, te przekształcenia zostaną przeniesione do objaśnienia oceniania, będzie oczekiwać danych pierwotnych, a domyślnie ważność zostanie zwrócona dla nieprzetworzonych funkcji. Jeśli feature_maps są przekazywane w tym miejscu (NIE przeznaczone do użycia w tym samym czasie co przekształcenia), objaśnienie będzie oczekiwać przekształconych danych, a domyślnie ważność zostanie zwrócona dla przekształconych danych. W obu przypadkach dane wyjściowe można określić przez ustawienie get_raw jawnie wartości True lub False w metodzie wyjaśnień .

Konstruktor

ScoringExplainer(original_explainer, feature_maps=None, raw_features=None, engineered_features=None, **kwargs)

Parametry

Nazwa	Opis
original_explainer Wymagane	<xref:interpret_community.common.base_explainer.BaseExplainer> Objaśnienie czasu trenowania pierwotnie używane do wyjaśnienia modelu.
feature_maps	list[ndarray] lub list[csr_matrix] Lista map funkcji z nieprzetworzonej do wygenerowanej funkcji. Lista może być tablicami numpy lub rozrzedzonymi macierzami, w których każdy wpis tablicy (raw_index, generated_index) jest wagą dla każdej nieprzetworzonej, wygenerowanej pary cech. Pozostałe wpisy są ustawione na zero. W przypadku sekwencji przekształceń [t1, t2, ..., tn] generujących wygenerowane funkcje na podstawie nieprzetworzonych cech lista map funkcji odpowiada nieprzetworzonym mapom wygenerowanym w tej samej kolejności co t1, t2 itp. Jeśli dostępna jest ogólna mapa funkcji nieprzetworzona do wygenerowania z t1 do tn, można przekazać tylko tę mapę funkcji na jednej liście elementów. Domyślna wartość: None
raw_features	list[str] Opcjonalna lista nazw funkcji dla nieprzetworzonych funkcji, które można określić, jeśli oryginalny obiekt wyjaśniający oblicza wyjaśnienie funkcji zaprojektowanych. Domyślna wartość: None
engineered_features	list[str] Opcjonalna lista nazw funkcji dla zaprojektowanych funkcji, które można określić, jeśli oryginalny obiekt wyjaśniający ma przekazane przekształcenia i oblicza tylko znaczenie pierwotnych funkcji. Domyślna wartość: None
original_explainer Wymagane	<xref:interpret_community.common.base_explainer.BaseExplainer> Objaśnienie czasu trenowania pierwotnie używane do wyjaśnienia modelu.
feature_maps Wymagane	list[ndarray] lub list[csr_matrix] Lista map funkcji z nieprzetworzonej do wygenerowanej funkcji. Lista może być tablicami numpy lub rozrzedzonymi macierzami, w których każdy wpis tablicy (raw_index, generated_index) jest wagą dla każdej nieprzetworzonej, wygenerowanej pary cech. Pozostałe wpisy są ustawione na zero. W przypadku sekwencji przekształceń [t1, t2, ..., tn] generujących wygenerowane funkcje na podstawie nieprzetworzonych cech lista map funkcji odpowiada nieprzetworzonym mapom wygenerowanym w tej samej kolejności co t1, t2 itp. Jeśli dostępna jest ogólna mapa funkcji nieprzetworzona do wygenerowania z t1 do tn, można przekazać tylko tę mapę funkcji na jednej liście elementów.
raw_features Wymagane	list[str] Opcjonalna lista nazw funkcji dla nieprzetworzonych funkcji, które można określić, jeśli oryginalny obiekt wyjaśniający oblicza wyjaśnienie funkcji zaprojektowanych.
engineered_features Wymagane	list[str] Opcjonalna lista nazw funkcji dla zaprojektowanych funkcji, które można określić, jeśli oryginalny obiekt wyjaśniający ma przekazane przekształcenia i oblicza tylko znaczenie pierwotnych funkcji.

Metody

explain	Użyj modelu do oceniania, aby przybliżyć wartości ważności funkcji danych.
fit	Zaimplementuj fikcyjną metodę wymaganą do dopasowania interfejsu potoku scikit-learn.
predict	Użyj modelu TreeExplainer i drzewa do oceniania, aby uzyskać wartości ważności funkcji danych. Opakowuje funkcję .explain().

explain

Użyj modelu do oceniania, aby przybliżyć wartości ważności funkcji danych.

abstract explain(evaluation_examples, get_raw)

Parametry

Nazwa	Opis
evaluation_examples Wymagane	array lub DataFrame lub csr_matrix Macierz przykładów wektorów funkcji (# przykłady x # funkcje), na których objaśniono dane wyjściowe modelu.
get_raw Wymagane	bool Jeśli wartość True, zostaną zwrócone wartości ważności dla nieprzetworzonych funkcji. Jeśli wartość False, zostaną zwrócone wartości ważności dla zaprojektowanych funkcji. Jeśli nieokreślone i przekształcenia zostały przekazane do pierwotnego objaśnienia, zostaną zwrócone nieprzetworzone wartości ważności. Jeśli nieokreślone i feature_maps zostały przekazane do objaśnienia oceniania, zostaną zwrócone wartości znaczenia inżynierów.

Zwraca

Typ	Opis
list	W przypadku modelu z pojedynczymi danymi wyjściowymi, takimi jak regresja, ta metoda zwraca macierz wartości ważności funkcji. W przypadku modeli z danymi wyjściowymi wektorów ta funkcja zwraca listę takich macierzy, po jednym dla każdego wyjścia. Wymiar tej macierzy to (# przykłady x # funkcje).

fit

Zaimplementuj fikcyjną metodę wymaganą do dopasowania interfejsu potoku scikit-learn.

fit(X, y=None)

Parametry

Nazwa	Opis
X Wymagane	Dane szkoleniowe.
y	Cele szkoleniowe. Domyślna wartość: None

predict

Użyj modelu TreeExplainer i drzewa do oceniania, aby uzyskać wartości ważności funkcji danych.

Opakowuje funkcję .explain().

predict(evaluation_examples)

Parametry

Nazwa	Opis
evaluation_examples Wymagane	array lub DataFrame lub csr_matrix Macierz przykładów wektorów funkcji (# przykłady x # funkcje), na których objaśniono dane wyjściowe modelu.

Zwraca

Typ	Opis
list	W przypadku modelu z pojedynczymi danymi wyjściowymi, takimi jak regresja, zwraca macierz wartości ważności funkcji. W przypadku modeli z danymi wyjściowymi wektorów ta funkcja zwraca listę takich macierzy, po jednym dla każdego wyjścia. Wymiar tej macierzy to (# przykłady x # funkcje).

Atrybuty

engineered_features

Pobierz nazwy cech inżynierów odpowiadające parametrowi get_raw=False podczas wywołania wyjaśnień.

Jeśli oryginalne objaśnienie miało przekazane przekształcenia, do konstruktora objaśnienia oceniania należy przekazać funkcje zaprojektowane przy użyciu parametru engineered_features. W przeciwnym razie, jeśli mapy funkcji zostały przekazane do objaśnienia oceniania, funkcje zaprojektowane będą takie same jak funkcje.

Zwraca

Typ	Opis
list[str], None	Nazwy funkcji zaprojektowanych lub Brak, jeśli żaden z nich nie został podany przez użytkownika.

features

Pobierz nazwy funkcji.

Zwraca domyślne nazwy funkcji, jeśli nie określono get_raw podczas objaśnienia wywołania.

Zwraca

Typ	Opis
list[str], None	Nazwy funkcji lub Brak, jeśli żaden nie został podany przez użytkownika.

raw_features

Pobierz nieprzetworzone nazwy funkcji odpowiadające parametrowi get_raw=True przy wywołaniu objaśnienia.

Jeśli oryginalne objaśnienie nie miało przekazanych przekształceń, a feature_maps zostały przekazane do objaśnienia oceniania, nieprzetworzone nazwy funkcji należy przekazać do konstruktora wyjaśniającego oceniania przy użyciu parametru raw_features. W przeciwnym razie nieprzetworzone funkcje będą takie same jak funkcje.

Zwraca

Typ	Opis
list[str], None	Nieprzetworzone nazwy funkcji lub Brak, jeśli żaden z nich nie został podany przez użytkownika.