ExplanationClient Klas

Definieert de client die uitleg uploadt en downloadt.

Maak de client die wordt gebruikt voor interactie met uitleg en uitvoeringsgeschiedenis.

Overname

builtins.object

ExplanationClient

Constructor

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

Parameters

Name	Description
service_context Vereist	<xref:ServiceContext> Houder voor service-informatie.
run_id Vereist	str Een GUID die een uitvoering vertegenwoordigt.
_run	Run Een run. Als u deze doorgeeft, worden andere argumenten genegeerd. Default value: None
service_context Vereist	<xref:ServiceContext> Houder voor service-informatie.
run_id Vereist	str Een GUID die een uitvoering vertegenwoordigt.
_run Vereist	Run Een run. Als dit wordt doorgegeven, wordt run_id genegeerd.
datastore_name	str Naam van het gegevensarchief dat moet worden gebruikt voor uploads (standaard in werkruimteopslag) Default value: None
experiment_name Vereist

Methoden

download_model_explanation	Download een modeluitleg die is opgeslagen in de uitvoeringsgeschiedenis.
from_run	Maak de client met de factory-methode op basis van een uitvoering.
from_run_id	Maak de client met de factory-methode op basis van een uitvoerings-id.
list_model_explanations	Retourneer een woordenlijst met metagegevens voor alle beschikbare modeluitleg.
upload_model_explanation	Upload de informatie over de modeluitleg om de uitvoeringsgeschiedenis uit te voeren.

download_model_explanation

Download een modeluitleg die is opgeslagen in de uitvoeringsgeschiedenis.

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

Parameters

Name	Description
explanation_id	str Indien opgegeven, wordt geprobeerd de asset van de uitvoering te downloaden met de opgegeven uitleg-id. Indien niet opgegeven, retourneert de meest recent geüploade uitleg. Default value: None
top_k	int Indien opgegeven, beperkt u de geordende gegevens die worden geretourneerd tot de belangrijkste functies en waarden. Als dit het geval is, bevatten global_importance_values en per_class_values de best gesorteerde k-waarden in plaats van de gebruikelijke volledige lijst met niet-gesorteerde waarden. Default value: None
comment	str Een tekenreeks die wordt gebruikt om uitleg te filteren op basis van de tekenreeksen waarmee ze zijn geüpload. Vereist een exacte overeenkomst. Als meerdere verklaringen deze tekenreeks delen, wordt de meest recente geretourneerd. Default value: None
raw	bool of None Indien waar of onwaar, worden verklaringen gefilterd op basis van of ze onbewerkt zijn of niet. Als er niets is opgegeven, wordt dit filter niet toegepast. Default value: None
engineered	bool of None Indien Waar of Onwaar, worden verklaringen gefilterd op basis van of ze zijn ontworpen of niet. Als er niets is opgegeven, wordt dit filter niet toegepast. Default value: None

Retouren

Type	Description
<xref:interpret_community.explanation.explanation.BaseExplanation>	De uitleg zoals deze is geüpload naar uitvoeringsgeschiedenis

from_run

Maak de client met de factory-methode op basis van een uitvoering.

from_run(run, datastore_name=None)

Parameters

Name	Description
cls Vereist	ExplanationClient De klasse ExplanationClient.
run Vereist	Run De uitvoeringsuitleg wordt gekoppeld aan.
datastore_name	str Naam van het gegevensarchief dat moet worden gebruikt voor uploads (standaard in werkruimteopslag) Default value: None

Retouren

Type	Description
ExplanationClient	Een exemplaar van de ExplanationClient.

from_run_id

Maak de client met de factory-methode op basis van een uitvoerings-id.

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

Parameters

Name	Description
cls Vereist	ExplanationClient De klasse ExplanationClient.
workspace Vereist	Workspace Een object dat een werkruimte vertegenwoordigt.
experiment_name Vereist	str De naam van een experiment.
run_id Vereist	str Een GUID die een uitvoering vertegenwoordigt.
datastore_name	str Naam van het gegevensarchief dat moet worden gebruikt voor uploads (standaard in werkruimteopslag) Default value: None

Retouren

Type	Description
ExplanationClient	Een exemplaar van de ExplanationClient.

list_model_explanations

Retourneer een woordenlijst met metagegevens voor alle beschikbare modeluitleg.

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

Parameters

Name	Description
comment	str Een tekenreeks die wordt gebruikt om uitleg te filteren op basis van de tekenreeksen waarmee ze zijn geüpload. Vereist een exacte overeenkomst. Default value: None
raw	bool of None Indien waar of onwaar, worden verklaringen gefilterd op basis van of ze onbewerkt zijn of niet. Als er niets is opgegeven, wordt dit filter niet toegepast. Default value: None
engineered	bool of None Indien Waar of Onwaar, worden verklaringen gefilterd op basis van of ze zijn ontworpen of niet. Als er niets is opgegeven, wordt dit filter niet toegepast. Default value: None

Retouren

Type	Description
dict	Een woordenlijst met uitlegmetagegevens, zoals id, gegevenstype, uitlegmethode, modeltype en uploadtijd, gesorteerd op uploadtijd

upload_model_explanation

Upload de informatie over de modeluitleg om de uitvoeringsgeschiedenis uit te voeren.

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

Parameters

Name	Description
explanation Vereist	<xref:interpret_community.explanation.explanation.BaseExplanation> De uitleggegevens die moeten worden opgeslagen.
max_num_blocks	int Het maximum aantal blokken dat moet worden opgeslagen. Default value: None
block_size	int De grootte van elk blok voor de samenvatting die is opgeslagen in de opslag van artefacten. Default value: None
top_k	int Het aantal belangrijke functies dat in de uitleg is opgeslagen. Als u dit opgeeft, worden alleen de namen en waarden die overeenkomen met de belangrijkste K-functies geretourneerd/opgeslagen. Als dit het geval is, bevatten global_importance_values en per_class_values de best gesorteerde k-waarden in plaats van de gebruikelijke volledige lijst met niet-gesorteerde waarden. Default value: None
comment	str Een optionele tekenreeks om de uitleg te identificeren. De tekenreeks wordt weergegeven bij het weergeven van uitleg, waardoor geüploade uitleg kan worden geïdentificeerd. Default value: None
init_dataset_id	str De id van de initialisatiegegevensset (achtergrondgegevensset) in de gegevenssetservice, indien beschikbaar. Wordt gebruikt om de uitleg te koppelen aan de gegevensset. Default value: None
eval_dataset_id	str De id van de evaluatiegegevensset in de gegevenssetservice, indien beschikbaar. Wordt gebruikt om de uitleg te koppelen aan de gegevensset. Default value: None
ys_pred_dataset_id	str De id van de gegevensset met voorspelde waarden in de gegevenssetservice, indien beschikbaar. Default value: None
ys_pred_proba_dataset_id	str De id van de gegevensset met voorspelde waarschijnlijkheidswaarden in de gegevenssetservice, indien beschikbaar. Default value: None
upload_datasets	bool Als dit is ingesteld op Waar en er geen gegevensset-id's worden doorgegeven, wordt de evaluatiegegevensset geüpload naar Azure Storage als een gegevenssetobject. Hierdoor kan de uitleg worden gekoppeld aan de gegevensset in de webweergave. Default value: False
model_id	str De MMS-model-id. Default value: None
true_ys	list | <xref:pandas.Dataframe> | ndarray De werkelijke labels voor de evaluatievoorbeelden. Default value: None
visualization_points	int of list[int] Als dit is ingesteld op een geheel getal, is dit de bovengrens van het aantal punten dat beschikbaar is voor visualisatie in de webgebruikersinterface. Als deze zijn ingesteld op een lijst met gehele getallen, worden deze gehele getallen gebruikt als indexen voor het selecteren van een voorbeeld van punten (oorspronkelijke gegevens en uitleg) die moeten worden gevisualiseerd in de webgebruikersinterface. Als u niet van plan bent om de uitleg in de webgebruikersinterface te bekijken, kan deze parameter worden ingesteld op 0 en vindt er geen extra berekening of opslag plaats. De bovengrens voor het gehele getal of de lengte van de lijst is momenteel 20000 (twintigduizend). In het geval dat een groter geheel getal of een langere lijst wordt doorgegeven, mislukt de functie. De bedoeling is om de hoeveelheid gegevens die de webgebruikersinterface binnenkomen, te beperken om prestatieredenen. Bij meer evaluatie kan deze limiet worden verhoogd. Default value: 5000

Kenmerken

run

Haal de uitvoering op van de uitlegclient.

Retouren

Type	Description
Run	Het uitvoeringsobject.