ExplanationClient Clase

Define el cliente que carga y descarga explicaciones.

Crea el cliente que se usa para interactuar con las explicaciones y el historial de ejecución.

Herencia

builtins.object

ExplanationClient

Constructor

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

Parámetros

Nombre	Description
service_context Requerido	<xref:ServiceContext> Titular de la información del servicio.
run_id Requerido	str GUID que representa una ejecución.
_run	Run Una ejecución. Si se pasa, se omitirán otros argumentos. Valor predeterminado: None
service_context Requerido	<xref:ServiceContext> Titular de la información del servicio.
run_id Requerido	str GUID que representa una ejecución.
_run Requerido	Run Una ejecución. Si se pasa, se omitirá run_id.
datastore_name	str Nombre del almacén de datos que se va a usar para cargas (el valor predeterminado es el almacén del área de trabajo). Valor predeterminado: None
experiment_name Requerido

Métodos

download_model_explanation	Descargue una explicación del modelo que se haya almacenado en el historial de ejecución.
from_run	Cree el cliente con el Factory Method según una ejecución.
from_run_id	Cree el cliente con el Factory Method según un identificador de ejecución.
list_model_explanations	Devuelve un diccionario de metadatos para todas las explicaciones del modelo disponibles.
upload_model_explanation	Cargue la información de explicación del modelo en el historial de ejecución.

download_model_explanation

Descargue una explicación del modelo que se haya almacenado en el historial de ejecución.

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

Parámetros

Nombre	Description
explanation_id	str Si se especifica, intenta descargar el recurso de la ejecución con el identificador de explicación especificado. Si no se especifica, devuelve la explicación cargada más recientemente. Valor predeterminado: None
top_k	int Si se especifica, limite los datos ordenados devueltos a las características y valores más importantes. Si este es el caso, global_importance_values y per_class_values contendrán los valores k principales ordenados en lugar de la lista completa habitual de valores no ordenados. Valor predeterminado: None
comment	str Cadena que se usa para filtrar las explicaciones en función de las cadenas con las que se cargaron. Requiere una coincidencia exacta. Si varias explicaciones comparten esta cadena, se devolverá la más reciente. Valor predeterminado: None
raw	bool o None Si es True o False, las explicaciones se filtrarán en función de si son sin procesar o no. Si no se especifica nada, este filtro no se aplicará. Valor predeterminado: None
engineered	bool o None Si es True o False, las explicaciones se filtrarán en función de si están diseñadas o no. Si no se especifica nada, este filtro no se aplicará. Valor predeterminado: None

Devoluciones

Tipo	Description
<xref:interpret_community.explanation.explanation.BaseExplanation>	La explicación tal y como se cargó en el historial de ejecución

from_run

Cree el cliente con el Factory Method según una ejecución.

from_run(run, datastore_name=None)

Parámetros

Nombre	Description
cls Requerido	ExplanationClient Clase ExplanationClient.
run Requerido	Run Se adjuntarán las explicaciones de ejecución.
datastore_name	str Nombre del almacén de datos que se va a usar para cargas (el valor predeterminado es el almacén del área de trabajo). Valor predeterminado: None

Devoluciones

Tipo	Description
ExplanationClient	Instancia de ExplanationClient.

from_run_id

Cree el cliente con el Factory Method según un identificador de ejecución.

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

Parámetros

Nombre	Description
cls Requerido	ExplanationClient Clase ExplanationClient.
workspace Requerido	Workspace Objeto que representa un área de trabajo.
experiment_name Requerido	str Nombre de un experimento.
run_id Requerido	str GUID que representa una ejecución.
datastore_name	str Nombre del almacén de datos que se va a usar para cargas (el valor predeterminado es el almacén del área de trabajo). Valor predeterminado: None

Devoluciones

Tipo	Description
ExplanationClient	Instancia de ExplanationClient.

list_model_explanations

Devuelve un diccionario de metadatos para todas las explicaciones del modelo disponibles.

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

Parámetros

Nombre	Description
comment	str Cadena que se usa para filtrar las explicaciones en función de las cadenas con las que se cargaron. Requiere una coincidencia exacta. Valor predeterminado: None
raw	bool o None Si es True o False, las explicaciones se filtrarán en función de si son sin procesar o no. Si no se especifica nada, este filtro no se aplicará. Valor predeterminado: None
engineered	bool o None Si es True o False, las explicaciones se filtrarán en función de si están diseñadas o no. Si no se especifica nada, este filtro no se aplicará. Valor predeterminado: None

Devoluciones

Tipo	Description
dict	Diccionario de metadatos de explicación, como id, data type, explanation method, model type y upload time, ordenados por tiempo de carga

upload_model_explanation

Cargue la información de explicación del modelo en el historial de ejecució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

Parámetros

Nombre	Description
explanation Requerido	<xref:interpret_community.explanation.explanation.BaseExplanation> Información de explicación que se debe guardar.
max_num_blocks	int Número máximo de bloques que se van a almacenar. Valor predeterminado: None
block_size	int Tamaño de cada bloque para el resumen almacenado en el almacenamiento de artefactos. Valor predeterminado: None
top_k	int Número de características importantes almacenadas en la explicación. Si se especifica, solo se devolverán o almacenarán los nombres y valores correspondientes a las principales características de K más importantes. Si este es el caso, global_importance_values y per_class_values contendrán los valores k principales ordenados en lugar de la lista completa habitual de valores no ordenados. Valor predeterminado: None
comment	str Cadena opcional para identificar la explicación. La cadena se muestra al enumerar las explicaciones, lo que permite la identificación de las explicaciones cargadas. Valor predeterminado: None
init_dataset_id	str Identificador del conjunto de datos de inicialización (fondo) en el servicio Conjunto de datos, si está disponible. Se usa para vincular la explicación al conjunto de datos. Valor predeterminado: None
eval_dataset_id	str Identificador del conjunto de datos de evaluación en el servicio Conjunto de datos, si está disponible. Se usa para vincular la explicación al conjunto de datos. Valor predeterminado: None
ys_pred_dataset_id	str Identificador del conjunto de datos de valores predichos en el servicio Conjunto de datos, si está disponible. Valor predeterminado: None
ys_pred_proba_dataset_id	str Identificador del conjunto de datos de valores de probabilidad predichos en el servicio Conjunto de datos, si está disponible. Valor predeterminado: None
upload_datasets	bool Si se establece en True y no se pasan identificadores de conjuntos de datos, se cargará el conjunto de datos de evaluación en Azure Storage como un objeto Dataset. Esto permitirá que la explicación se vincule al conjunto de datos en la vista web. Valor predeterminado: False
model_id	str Identificador del modelo MMS. Valor predeterminado: None
true_ys	list | <xref:pandas.Dataframe> | ndarray Etiquetas True para los ejemplos de evaluación. Valor predeterminado: None
visualization_points	int o list[int] Si se establece en un entero, es el límite superior del número de puntos que estarán disponibles para su visualización en la interfaz de usuario web. Si se establece en una lista de enteros, estos enteros se usarán como índices para seleccionar una muestra de puntos (datos originales y explicaciones) que se visualizarán en la interfaz de usuario web. Si no planea ver la explicación en la interfaz de usuario web, este parámetro se puede establecer en 0 y no se llevará a cabo ningún cálculo o almacenamiento adicional. El límite superior para el entero o la longitud de la lista es actualmente de 20 000 (veinte mil). En caso de que se pase un entero mayor o una lista más larga, se producirá un error en la función. La intención es limitar la cantidad de datos que entran en la interfaz de usuario web por motivos de rendimiento. Con más evaluación, se puede aumentar este límite. Valor predeterminado: 5000

Atributos

run

Obtiene la ejecución desde el cliente de explicación.

Devoluciones

Tipo	Description
Run	Objeto de ejecución.