ExplanationClient Klass
Definierar den klient som laddar upp och laddar ned förklaringar.
Skapa klienten som används för att interagera med förklaringar och körningshistorik.
- Arv
-
builtins.objectExplanationClient
Konstruktor
ExplanationClient(service_context, experiment_name, run_id, _run=None, datastore_name=None)Parametrar
| Name | Description |
|---|---|
|
service_context
Obligatorisk
|
<xref:ServiceContext>
Innehavare för tjänstinformation. |
|
run_id
Obligatorisk
|
Ett GUID som representerar en körning. |
|
_run
|
En körning. Om det skickas in ignoreras andra args. Standardvärde: None
|
|
service_context
Obligatorisk
|
<xref:ServiceContext>
Innehavare för tjänstinformation. |
|
run_id
Obligatorisk
|
Ett GUID som representerar en körning. |
|
_run
Obligatorisk
|
En körning. Om det skickas ignoreras run_id . |
|
datastore_name
|
Namnet på datalagret som ska användas för uppladdningar (standard för lagring av arbetsytor) Standardvärde: None
|
|
experiment_name
Obligatorisk
|
|
Metoder
| download_model_explanation |
Ladda ned en modellförklaring som har lagrats i körningshistoriken. |
| from_run |
Skapa klienten med fabriksmetoden med en körning. |
| from_run_id |
Skapa klienten med fabriksmetoden med ett körnings-ID. |
| list_model_explanations |
Returnera en ordlista med metadata för alla tillgängliga modellförklaringar. |
| upload_model_explanation |
Ladda upp förklaringsinformationen för modellen för att köra historiken. |
download_model_explanation
Ladda ned en modellförklaring som har lagrats i körningshistoriken.
download_model_explanation(explanation_id=None, top_k=None, comment=None, raw=None, engineered=None)Parametrar
| Name | Description |
|---|---|
|
explanation_id
|
Om det anges försöker du ladda ned tillgången från körningen med det angivna förklarings-ID:t. Om den är ospecificerad returneras den senast uppladdade förklaringen. Standardvärde: None
|
|
top_k
|
Om du anger det begränsar du de sorterade data som returneras till de viktigaste funktionerna och värdena. I så fall innehåller global_importance_values och per_class_values de översta k sorterade värdena i stället för den vanliga fullständiga listan med osorterade värden. Standardvärde: None
|
|
comment
|
En sträng som används för att filtrera förklaringar baserat på de strängar som de laddades upp med. Kräver en exakt matchning. Om flera förklaringar delar den här strängen returneras den senaste. Standardvärde: None
|
|
raw
|
Om det är sant eller falskt filtreras förklaringarna baserat på om de är råa eller inte. Om inget anges tillämpas inte det här filtret. Standardvärde: None
|
|
engineered
|
Om det är sant eller falskt filtreras förklaringarna baserat på om de är konstruerade eller inte. Om inget anges tillämpas inte det här filtret. Standardvärde: None
|
Returer
| Typ | Description |
|---|---|
|
<xref:interpret_community.explanation.explanation.BaseExplanation>
|
Förklaringen när den laddades upp till körningshistoriken |
from_run
Skapa klienten med fabriksmetoden med en körning.
from_run(run, datastore_name=None)Parametrar
| Name | Description |
|---|---|
|
cls
Obligatorisk
|
Klassen ExplanationClient. |
|
run
Obligatorisk
|
Körningsförklaringarna kopplas till. |
|
datastore_name
|
Namnet på datalagret som ska användas för uppladdningar (standard för lagring av arbetsytor) Standardvärde: None
|
Returer
| Typ | Description |
|---|---|
|
En instans av ExplanationClient. |
from_run_id
Skapa klienten med fabriksmetoden med ett körnings-ID.
from_run_id(workspace, experiment_name, run_id, datastore_name=None)Parametrar
| Name | Description |
|---|---|
|
cls
Obligatorisk
|
Klassen ExplanationClient. |
|
workspace
Obligatorisk
|
Ett objekt som representerar en arbetsyta. |
|
experiment_name
Obligatorisk
|
Namnet på ett experiment. |
|
run_id
Obligatorisk
|
Ett GUID som representerar en körning. |
|
datastore_name
|
Namnet på datalagret som ska användas för uppladdningar (standard för lagring av arbetsytor) Standardvärde: None
|
Returer
| Typ | Description |
|---|---|
|
En instans av ExplanationClient. |
list_model_explanations
Returnera en ordlista med metadata för alla tillgängliga modellförklaringar.
list_model_explanations(comment=None, raw=None, engineered=None)Parametrar
| Name | Description |
|---|---|
|
comment
|
En sträng som används för att filtrera förklaringar baserat på de strängar som de laddades upp med. Kräver en exakt matchning. Standardvärde: None
|
|
raw
|
Om det är sant eller falskt filtreras förklaringarna baserat på om de är råa eller inte. Om inget anges tillämpas inte det här filtret. Standardvärde: None
|
|
engineered
|
Om det är sant eller falskt filtreras förklaringarna baserat på om de är konstruerade eller inte. Om inget anges tillämpas inte det här filtret. Standardvärde: None
|
Returer
| Typ | Description |
|---|---|
|
En ordlista med förklaringsmetadata som id, datatyp, förklaringsmetod, modelltyp och uppladdningstid, sorterade efter uppladdningstid |
upload_model_explanation
Ladda upp förklaringsinformationen för modellen för att köra historiken.
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) -> NoneParametrar
| Name | Description |
|---|---|
|
explanation
Obligatorisk
|
<xref:interpret_community.explanation.explanation.BaseExplanation>
Förklaringsinformationen som ska sparas. |
|
max_num_blocks
|
Det maximala antalet block som ska lagras. Standardvärde: None
|
|
block_size
|
Storleken på varje block för sammanfattningen som lagras i artefakternas lagring. Standardvärde: None
|
|
top_k
|
Antal viktiga funktioner som lagras i förklaringen. Om detta anges returneras/lagras endast de namn och värden som motsvarar de viktigaste K-funktionerna. I så fall innehåller global_importance_values och per_class_values de översta k sorterade värdena i stället för den vanliga fullständiga listan med osorterade värden. Standardvärde: None
|
|
comment
|
En valfri sträng för att identifiera förklaringen. Strängen visas när du listar förklaringar, vilket gör det möjligt att identifiera uppladdade förklaringar. Standardvärde: None
|
|
init_dataset_id
|
ID:t för initieringsdatauppsättningen (bakgrund) i datauppsättningstjänsten, om tillgängligt. Används för att länka förklaringen till datauppsättningen. Standardvärde: None
|
|
eval_dataset_id
|
ID:t för utvärderingsdatauppsättningen i datauppsättningstjänsten, om tillgängligt. Används för att länka förklaringen till datauppsättningen. Standardvärde: None
|
|
ys_pred_dataset_id
|
ID:t för datauppsättningen för förutsagda värden i datauppsättningstjänsten, om tillgängligt. Standardvärde: None
|
|
ys_pred_proba_dataset_id
|
ID:t för datamängden för förutsagda sannolikhetsvärden i datamängdstjänsten, om tillgängligt. Standardvärde: None
|
|
upload_datasets
|
Om värdet är Sant och inga datauppsättnings-ID:n skickas, laddas utvärderingsdatauppsättningen upp till Azure Storage som ett datauppsättningsobjekt. Detta gör att förklaringen kan länkas till datauppsättningen i webbvyn. Standardvärde: False
|
|
model_id
|
MMS-modell-ID: t. Standardvärde: None
|
|
true_ys
|
De sanna etiketterna för utvärderingsexemplen. Standardvärde: None
|
|
visualization_points
|
Om det är inställt på ett heltal är detta den övre gränsen för antalet punkter som ska vara tillgängliga för visualisering i webbgränssnittet. Om de anges till en lista över heltal används dessa heltal som index för att välja ett urval av punkter (ursprungliga data och förklaringar) som ska visualiseras i webbgränssnittet. Om du inte planerar att visa förklaringen i webbgränssnittet kan den här parametern anges till 0 och ingen extra beräkning eller lagring sker. Den övre gränsen för antingen heltal eller längden på listan är för närvarande 20000 (tjugotusen). Om en större heltalslista eller en längre lista skickas misslyckas funktionen. Avsikten är att begränsa mängden data som kommer in i webbgränssnittet av prestandaskäl. Med mer utvärdering kan den här gränsen höjas. Standardvärde: 5000
|