ExplanationClient Classe

  • Referência

Define o cliente que carrega e baixa as explicações.

Crie o cliente usado 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

Nome Description
service_context
Obrigatório
<xref:ServiceContext>

Detentor das informações de serviço.
run_id
Obrigatório
str

Um GUID que representa uma execução.
_run
Run

Uma execução. Se for passado, outros argumentos serão ignorados.

Valor padrão: None
service_context
Obrigatório
<xref:ServiceContext>

Detentor das informações de serviço.
run_id
Obrigatório
str

Um GUID que representa uma execução.
_run
Obrigatório
Run

Uma execução. Se passado, run_id será ignorado.
datastore_name
str

Nome do armazenamento de dados a ser usado para uploads (padrões para o armazenamento de workspace)

Valor padrão: None
experiment_name
Obrigatório

Métodos

download_model_explanation

Baixa uma explicação do modelo que foi armazenada no histórico de execuções.
from_run

Cria o cliente com o método de fábrica com base em uma execução fornecida.
from_run_id

Cria o cliente com o método de fábrica, com base em uma ID de execução fornecida.
list_model_explanations

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

Carrega as informações de explicação do modelo no histórico de execuções.

download_model_explanation

Baixa uma explicação do modelo que foi armazenada no histórico de execuções.

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

Parâmetros

Nome Description
explanation_id
str

Se for especificado, tentará baixar o ativo da execução com a ID da explicação fornecida. Se não for especificado, retornará a explicação mais recente carregada.

Valor padrão: None
top_k
int

Se for especificado, limite os dados ordenados retornados aos recursos e valores mais importantes. Se esse for o caso, global_importance_values e per_class_values conterão os k primeiros valores classificados, em vez da lista completa usual de valores não classificados.

Valor padrão: None
comment
str

Uma cadeia de caracteres usada para filtrar explicações com base nas cadeias de caracteres com as quais elas foram carregadas. Exige uma correspondência exata. Se várias explicações compartilharem essa cadeia de caracteres, as mais recentes serão retornadas.

Valor padrão: None
raw
bool ou None

Se for True ou False, as explicações serão filtradas com base em serem brutas ou não. Se nada for especificado, esse filtro não será aplicado.

Valor padrão: None
engineered
bool ou None

Se for True ou False, as explicações serão filtradas com base em serem projetadas ou não. Se nada for especificado, esse filtro não será aplicado.

Valor padrão: None

Retornos

Tipo Description
<xref:interpret_community.explanation.explanation.BaseExplanation>

A explicação, do jeito que foi carregada no histórico de execuções

from_run

Cria o cliente com o método de fábrica com base em uma execução fornecida.

from_run(run, datastore_name=None)

Parâmetros

Nome Description
cls
Obrigatório
ExplanationClient

A classe ExplanationClient.
run
Obrigatório
Run

A execução à qual as explicações serão anexadas.
datastore_name
str

Nome do armazenamento de dados a ser usado para uploads (padrões para o armazenamento de workspace)

Valor padrão: None

Retornos

Tipo Description
ExplanationClient

Uma instância do ExplanationClient.

from_run_id

Cria o cliente com o método de fábrica, com base em uma ID de execução fornecida.

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

Parâmetros

Nome Description
cls
Obrigatório
ExplanationClient

A classe ExplanationClient.
workspace
Obrigatório
Workspace

Um objeto que representa um workspace.
experiment_name
Obrigatório
str

O nome de um experimento.
run_id
Obrigatório
str

Um GUID que representa uma execução.
datastore_name
str

Nome do armazenamento de dados a ser usado para uploads (padrões para o armazenamento de workspace)

Valor padrão: None

Retornos

Tipo Description
ExplanationClient

Uma instância do ExplanationClient.

list_model_explanations

Retorna 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

Nome Description
comment
str

Uma cadeia de caracteres usada para filtrar explicações com base nas cadeias de caracteres com as quais elas foram carregadas. Exige uma correspondência exata.

Valor padrão: None
raw
bool ou None

Se for True ou False, as explicações serão filtradas com base em serem brutas ou não. Se nada for especificado, esse filtro não será aplicado.

Valor padrão: None
engineered
bool ou None

Se for True ou False, as explicações serão filtradas com base em serem projetadas ou não. Se nada for especificado, esse filtro não será aplicado.

Valor padrão: None

Retornos

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 upload, classificado por tempo de upload

upload_model_explanation

Carrega as informações de explicação do modelo no histórico de execuções.

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

Nome Description
explanation
Obrigatório
<xref:interpret_community.explanation.explanation.BaseExplanation>

As informações de explicação a serem salvas.
max_num_blocks
int

O número máximo de blocos a serem armazenados.

Valor padrão: None
block_size
int

O tamanho de cada bloco para o resumo armazenado no armazenamento de artefatos.

Valor padrão: None
top_k
int

O número de recursos importantes armazenados na explicação. Se especificado, somente os nomes e valores correspondentes aos K recursos mais importantes serão retornados/armazenados. Se esse for o caso, global_importance_values e per_class_values conterão os k primeiros valores classificados, em vez da lista completa usual de valores não classificados.

Valor padrão: None
comment
str

Uma cadeia de caracteres opcional para identificar a explicação. A cadeia de caracteres é exibida ao listar explicações, o que permite a identificação de explicações carregadas.

Valor padrão: None
init_dataset_id
str

A ID do conjunto de dados de inicialização (segundo plano) no serviço de conjunto de dados, se disponível. Usado para vincular a explicação ao conjunto de dados.

Valor padrão: None
eval_dataset_id
str

A ID do conjunto de dados de avaliação no serviço de conjunto de dados, se disponível. Usado para vincular a explicação ao conjunto de dados.

Valor padrão: None
ys_pred_dataset_id
str

A ID do conjunto de dados de valores previstos no serviço de conjunto de dados, se disponível.

Valor padrão: None
ys_pred_proba_dataset_id
str

A ID do conjunto de dados de valores de probabilidade previstos no serviço de conjunto de dados, se disponível.

Valor padrão: None
upload_datasets
bool

Se definido como true e nenhuma ID de conjunto de dados for passada, o conjunto de dados de avaliação será carregado no Armazenamento do Azure como um objeto Dataset. Isso permitirá que a explicação seja vinculada ao conjunto de dados na exibição da Web.

Valor padrão: False
model_id
str

A ID do modelo de MMS.

Valor padrão: None
true_ys
list | <xref:pandas.Dataframe> | ndarray

Os rótulos verdadeiros para os exemplos de avaliação.

Valor padrão: None
visualization_points
int ou list[int]

Se for definido como um inteiro, esse será o limite superior do número de pontos que estarão disponíveis para visualização na interface do usuário da Web. Se definido como uma lista de inteiros, esses inteiros serão usados como índices para selecionar uma amostra de pontos (dados e explicações originais) a serem visualizados na interface do usuário da Web. Se você não estiver planejando exibir a explicação na interface do usuário da Web, esse parâmetro poderá ser definido como 0 e nenhuma computação nem armazenamento extra ocorrerá.

O limite superior para o inteiro ou o comprimento da lista é, no momento, 20.000 (vinte mil). Caso um inteiro maior ou uma lista mais longa seja passada, a função falhará. A intenção é limitar a quantidade de dados que entram na interface do usuário da Web por motivos de desempenho. Com mais avaliação, esse limite pode ser elevado.

Valor padrão: 5000

Atributos

run

Obtém a execução do cliente de explicação.

Retornos

Tipo Description
Run

O objeto de execução.