ExplanationClient Třída

Definuje klienta, který odesílá a stahuje vysvětlení.

Vytvořte klienta sloužícího k interakci s vysvětleními a historií spuštění.

Dědičnost

builtins.object

ExplanationClient

Konstruktor

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

Parametry

service_context

<xref:ServiceContext>

Vyžadováno

Držitel informací o servisu.

run_id

str

Vyžadováno

Identifikátor GUID, který představuje spuštění.

_run

Run

výchozí hodnota: None

Spuštění. Pokud se předá, ostatní argumenty budou ignorovány.

service_context

<xref:ServiceContext>

Vyžadováno

Držitel informací o servisu.

run_id

str

Vyžadováno

Identifikátor GUID, který představuje spuštění.

_run

Run

Vyžadováno

Spuštění. Pokud se run_id předá, budou ignorovány.

datastore_name

str

výchozí hodnota: None

Název úložiště dat, které se má použít pro nahrávání (výchozí nastavení je úložiště pracovních prostorů)

experiment_name

Metody

download_model_explanation	Stáhněte si vysvětlení modelu, které bylo uloženo v historii spuštění.
from_run	Vytvořte klienta s metodou factory při spuštění.
from_run_id	Vytvořte klienta pomocí metody factory s ID spuštění.
list_model_explanations	Vrátí slovník metadat pro všechna dostupná vysvětlení modelu.
upload_model_explanation	Nahrajte informace o vysvětlení modelu a spusťte historii spuštění.

download_model_explanation

Stáhněte si vysvětlení modelu, které bylo uloženo v historii spuštění.

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

Parametry

explanation_id

str

výchozí hodnota: None

Pokud je zadáno, pokusí se stáhnout prostředek z běhu s daným ID vysvětlení. Pokud není zadáno, vrátí naposledy nahrané vysvětlení.

top_k

int

výchozí hodnota: None

Pokud je tato možnost zadána, omezte vrácená seřazená data na nejdůležitější funkce a hodnoty. V takovém případě budou global_importance_values a per_class_values místo úplného seznamu neseřazených hodnot obsahovat nejvyšší hodnoty k.

comment

str

výchozí hodnota: None

Řetězec sloužící k filtrování vysvětlení na základě řetězců, se kterými se nahrál. Vyžaduje přesnou shodu. Pokud tento řetězec sdílí více vysvětlení, vrátí se nejnovější.

raw

bool nebo None

výchozí hodnota: None

Pokud je pravda nebo nepravda, vysvětlení se vyfiltrují podle toho, jestli jsou nezpracované nebo ne. Pokud není zadáno nic, nebude tento filtr použit.

engineered

bool nebo None

výchozí hodnota: None

Pokud je pravda nebo nepravda, vysvětlení se vyfiltrují podle toho, jestli jsou nebo nejsou zpracovaná. Pokud není zadáno nic, nebude tento filtr použit.

Návraty

Vysvětlení, jak se nahrálo do historie spuštění

Návratový typ

<xref:interpret_community.explanation.explanation.BaseExplanation>

from_run

Vytvořte klienta s metodou factory při spuštění.

from_run(run, datastore_name=None)

Parametry

cls

ExplanationClient

Vyžadováno

Třída ExplanationClient.

run

Run

Vyžadováno

Vysvětlení spuštění se připojí k.

datastore_name

str

výchozí hodnota: None

Název úložiště dat, které se má použít pro nahrávání (výchozí nastavení je úložiště pracovních prostorů)

Návraty

An instance of the ExplanationClient.

Návratový typ

ExplanationClient

from_run_id

Vytvořte klienta pomocí metody factory s ID spuštění.

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

Parametry

cls

ExplanationClient

Vyžadováno

Třída ExplanationClient.

workspace

Workspace

Vyžadováno

Objekt, který představuje pracovní prostor.

experiment_name

str

Vyžadováno

Název experimentu.

run_id

str

Vyžadováno

Identifikátor GUID, který představuje spuštění.

datastore_name

str

výchozí hodnota: None

Název úložiště dat, které se má použít pro nahrávání (výchozí nastavení je úložiště pracovních prostorů)

Návraty

An instance of the ExplanationClient.

Návratový typ

ExplanationClient

list_model_explanations

Vrátí slovník metadat pro všechna dostupná vysvětlení modelu.

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

Parametry

comment

str

výchozí hodnota: None

Řetězec sloužící k filtrování vysvětlení na základě řetězců, se kterými se nahrál. Vyžaduje přesnou shodu.

raw

bool nebo None

výchozí hodnota: None

Pokud je pravda nebo nepravda, vysvětlení se vyfiltrují podle toho, jestli jsou nezpracované nebo ne. Pokud není zadáno nic, nebude tento filtr použit.

engineered

bool nebo None

výchozí hodnota: None

Pokud je pravda nebo nepravda, vysvětlení se vyfiltrují podle toho, jestli jsou nebo nejsou zpracovaná. Pokud není zadáno nic, nebude tento filtr použit.

Návraty

Slovník metadat vysvětlení, jako je ID, datový typ, metoda vysvětlení, typ modelu a čas nahrávání, seřazený podle času nahrání

Návratový typ

dict

upload_model_explanation

Nahrajte informace o vysvětlení modelu a spusťte historii spuštění.

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

explanation

<xref:interpret_community.explanation.explanation.BaseExplanation>

Vyžadováno

Informace o vysvětlení, které se mají uložit.

max_num_blocks

int

výchozí hodnota: None

Maximální počet bloků, které se mají uložit.

block_size

int

výchozí hodnota: None

Velikost každého bloku pro souhrn uložený v úložišti artefaktů.

top_k

int

výchozí hodnota: None

Počet důležitých funkcí uložených ve vysvětlení Pokud je zadáno, budou vráceny nebo uloženy pouze názvy a hodnoty odpovídající nejdůležitějším funkcím K. V takovém případě budou global_importance_values a per_class_values místo úplného seznamu neseřazených hodnot obsahovat nejvyšší hodnoty k.

comment

str

výchozí hodnota: None

Volitelný řetězec pro identifikaci vysvětlení. Řetězec se zobrazí při výpisu vysvětlení, což umožňuje identifikaci nahraných vysvětlení.

init_dataset_id

str

výchozí hodnota: None

ID inicializační (pozadí) datové sady ve službě Dataset Service, pokud je k dispozici. Slouží k propojení vysvětlení s datovou sadou.

eval_dataset_id

str

výchozí hodnota: None

ID zkušební datové sady ve službě Dataset Service, pokud je k dispozici. Slouží k propojení vysvětlení s datovou sadou.

ys_pred_dataset_id

str

výchozí hodnota: None

ID datové sady predikovaných hodnot ve službě Dataset Service, pokud je k dispozici.

ys_pred_proba_dataset_id

str

výchozí hodnota: None

ID datové sady predikovaných hodnot pravděpodobnosti ve službě Dataset (pokud je k dispozici).

upload_datasets

bool

výchozí hodnota: False

Pokud je nastavená hodnota True a nepředávají se žádná ID datové sady, zkušební datová sada se nahraje do úložiště Azure jako objekt Dataset. To umožní propojení vysvětlení s datovou sadou ve webovém zobrazení.

model_id

str

výchozí hodnota: None

ID modelu MMS.

true_ys

list | <xref:pandas.Dataframe> | ndarray

výchozí hodnota: None

Skutečné popisky pro příklady vyhodnocení

visualization_points

int nebo list[int]

výchozí hodnota: 5000

Pokud je nastavené celé číslo, jedná se o horní hranici počtu bodů, které budou k dispozici pro vizualizaci ve webovém uživatelském rozhraní. Pokud je nastaven seznam celých čísel, budou tato celá čísla použita jako indexy pro výběr vzorku bodů (původní data a vysvětlení), které se mají vizualizovat ve webovém uživatelském rozhraní. Pokud nechcete zobrazit vysvětlení ve webovém uživatelském rozhraní, můžete tento parametr nastavit na hodnotu 0 a nedojde k žádným dalším výpočtům ani úložišti.

Horní limit pro celé číslo nebo délku seznamu je v současné době 20000 (dvacet tisíc). V případě, že se předá větší celé číslo nebo delší seznam, funkce selže. Záměrem je omezit množství dat vstupujících do webového uživatelského rozhraní z důvodů výkonu. Při větším vyhodnocení může být tento limit zvýšen.

Atributy

run

Získejte spuštění z klienta vysvětlení.

Návraty

Objekt spuštění.

Návratový typ

Run