ExplanationClient Classe

Define o cliente que carrega e transfere explicações.

Crie o cliente utilizado para interagir com explicações e histórico de execuções.

Herança

builtins.object

ExplanationClient

Construtor

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

Parâmetros

Name	Description
service_context Necessário	<xref:ServiceContext> Titular para informações de serviço.
run_id Necessário	str Um GUID que representa uma execução.
_run	Run Uma corrida. Se forem transmitidos, outros args serão ignorados. Default value: None
service_context Necessário	<xref:ServiceContext> Titular para informações de serviço.
run_id Necessário	str Um GUID que representa uma execução.
_run Necessário	Run Uma corrida. Se for transmitida, run_id será ignorada.
datastore_name	str Nome do arquivo de dados a utilizar para carregamentos (predefinições para o arquivo de áreas de trabalho) Default value: None
experiment_name Necessário

Métodos

download_model_explanation	Transfira uma explicação de modelo que tenha sido armazenada no histórico de execuções.
from_run	Crie o cliente com o método de fábrica dado uma execução.
from_run_id	Crie o cliente com o método de fábrica com um ID de execução.
list_model_explanations	Devolva um dicionário de metadados para todas as explicações de modelo disponíveis.
upload_model_explanation	Carregue as informações de explicação do modelo para executar o histórico.

download_model_explanation

Transfira uma explicação de modelo que tenha sido armazenada no histórico de execuções.

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

Parâmetros

Name	Description
explanation_id	str Se especificado, tenta transferir o recurso a partir da execução com o ID de explicação especificado. Se não for especificado, devolve a explicação carregada mais recentemente. Default value: None
top_k	int Se especificado, limite os dados ordenados devolvidos às funcionalidades e valores mais importantes. Se for este o caso, global_importance_values e per_class_values conterão os valores ordenados k superiores em vez da lista completa habitual de valores não ordenados. Default value: None
comment	str Uma cadeia utilizada para filtrar explicações com base nas cadeias com as qual foram carregadas. Requer uma correspondência exata. Se várias explicações partilharem esta cadeia, a mais recente será devolvida. Default value: None
raw	bool ou None Se For Verdadeiro ou Falso, as explicações serão filtradas com base no facto de serem não processadas ou não. Se nada for especificado, este filtro não será aplicado. Default value: None
engineered	bool ou None Se For Verdadeiro ou Falso, as explicações serão filtradas com base no facto de serem concebidas ou não. Se nada for especificado, este filtro não será aplicado. Default value: None

Devoluções

Tipo	Description
<xref:interpret_community.explanation.explanation.BaseExplanation>	A explicação à medida que foi carregada para o histórico de execuções

from_run

Crie o cliente com o método de fábrica dado uma execução.

from_run(run, datastore_name=None)

Parâmetros

Name	Description
cls Necessário	ExplanationClient A classe ExplanationClient.
run Necessário	Run As explicações de execução serão anexadas.
datastore_name	str Nome do arquivo de dados a utilizar para carregamentos (predefinições para o arquivo de áreas de trabalho) Default value: None

Devoluções

Tipo	Description
ExplanationClient	Uma instância do ExplanationClient.

from_run_id

Crie o cliente com o método de fábrica com um ID de execução.

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

Parâmetros

Name	Description
cls Necessário	ExplanationClient A classe ExplanationClient.
workspace Necessário	Workspace Um objeto que representa uma área de trabalho.
experiment_name Necessário	str O nome de uma experimentação.
run_id Necessário	str Um GUID que representa uma execução.
datastore_name	str Nome do arquivo de dados a utilizar para carregamentos (predefinições para o arquivo de áreas de trabalho) Default value: None

Devoluções

Tipo	Description
ExplanationClient	Uma instância do ExplanationClient.

list_model_explanations

Devolva um dicionário de metadados para todas as explicações de modelo disponíveis.

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

Parâmetros

Name	Description
comment	str Uma cadeia utilizada para filtrar explicações com base nas cadeias com as qual foram carregadas. Requer uma correspondência exata. Default value: None
raw	bool ou None Se For Verdadeiro ou Falso, as explicações serão filtradas com base no facto de serem não processadas ou não. Se nada for especificado, este filtro não será aplicado. Default value: None
engineered	bool ou None Se For Verdadeiro ou Falso, as explicações serão filtradas com base no facto de serem concebidas ou não. Se nada for especificado, este filtro não será aplicado. Default value: None

Devoluções

Tipo	Description
dict	Um dicionário de metadados de explicação, como id, tipo de dados, método de explicação, tipo de modelo e tempo de carregamento, ordenado pela hora de carregamento

upload_model_explanation

Carregue as informações de explicação do modelo para executar o histórico.

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

Name	Description
explanation Necessário	<xref:interpret_community.explanation.explanation.BaseExplanation> As informações de explicação a guardar.
max_num_blocks	int O número máximo de blocos a armazenar. Default value: None
block_size	int O tamanho de cada bloco para o resumo armazenado no armazenamento de artefactos. Default value: None
top_k	int Número de funcionalidades importantes armazenadas na explicação. Se especificado, apenas os nomes e valores correspondentes às principais funcionalidades K mais importantes serão devolvidos/armazenados. Se for este o caso, global_importance_values e per_class_values conterão os valores ordenados k superiores em vez da lista completa habitual de valores não ordenados. Default value: None
comment	str Uma cadeia opcional para identificar a explicação. A cadeia é apresentada ao listar explicações, o que permite a identificação de explicações carregadas. Default value: None
init_dataset_id	str O ID do conjunto de dados de inicialização (em segundo plano) no serviço Conjunto de dados, se disponível. Utilizado para associar a explicação ao Conjunto de Dados. Default value: None
eval_dataset_id	str O ID do conjunto de dados de avaliação no serviço Conjunto de dados, se disponível. Utilizado para associar a explicação ao Conjunto de Dados. Default value: None
ys_pred_dataset_id	str O ID do conjunto de dados de valores previstos no serviço Conjunto de dados, se disponível. Default value: None
ys_pred_proba_dataset_id	str O ID do conjunto de dados de valores de probabilidade previsto no serviço Conjunto de Dados, se disponível. Default value: None
upload_datasets	bool Se estiver definido como Verdadeiro e não forem transmitidos IDs de conjuntos de dados, o conjunto de dados de avaliação será carregado para o armazenamento do Azure como um objeto conjunto de dados. Isto permitirá que a explicação seja ligada ao Conjunto de Dados na vista Web. Default value: False
model_id	str O ID do modelo MMS. Default value: None
true_ys	list | <xref:pandas.Dataframe> | ndarray As etiquetas verdadeiras para os exemplos de avaliação. Default value: None
visualization_points	int ou list[int] Se estiver definido como um número inteiro, este é o limite superior no número de pontos que estarão disponíveis para visualização na IU da Web. Se estiver definido como uma lista de números inteiros, estes números inteiros serão utilizados como índices para selecionar uma amostra de pontos (dados originais e explicações) a visualizar na IU da Web. Se não planear ver a explicação na IU da Web, este parâmetro pode ser definido como 0 e não será efetuada qualquer computação ou armazenamento adicional. O limite superior para o número inteiro ou o comprimento da lista é atualmente 20000 (vinte mil). No caso de ser transmitida uma lista maior de números inteiros ou mais longos, a função falhará. A intenção é limitar a quantidade de dados que entram na IU da Web por motivos de desempenho. Com mais avaliação, este limite pode ser aumentado. Default value: 5000

Atributos

run

Obtenha a execução a partir do cliente de explicação.

Devoluções

Tipo	Description
Run	O objeto de execução.