Partilhar via


scoring_explainer Pacote

Define modelos de classificação para a aproximação de valores de importância de funcionalidade.

Classes

DeepScoringExplainer

Define um modelo de classificação baseado no DeepExplainer.

Se o explicador original estava a utilizar um DEEPExplainer SHAP e não foram transmitidos dados de inicialização, o núcleo do explicador original será reutilizado. Se o explicador original tiver utilizado outro método ou se forem transmitidos novos dados de inicialização em initialization_examples, será criado um novo explicador.

Se as transformações forem transmitidas em original_explainer, essas transformações serão transferidas para o explicador de classificação, esperarão dados não processados e, por predefinição, serão devolvidas importâncias não processadas para as funcionalidades não processadas. Se feature_maps forem transmitidas aqui (NÃO se destina a serem utilizadas ao mesmo tempo que as transformações), o explicador irá esperar dados transformados e, por predefinição, serão devolvidos importâncias para os dados transformados. Em ambos os casos, a saída pode ser especificada ao definir get_raw explicitamente como Verdadeiro ou Falso no método de explicação do explicador.

Inicialize o DeepScoringExplainer.

Se o explicador original estava a utilizar um DEEPExplainer SHAP e não foram transmitidos dados de inicialização, o núcleo do explicador original será reutilizado. Se o explicador original tiver utilizado outro método ou se forem transmitidos novos dados de inicialização em initialization_examples, será criado um novo explicador.

Se as transformações forem transmitidas em original_explainer, essas transformações serão transferidas para o explicador de classificação, esperarão dados não processados e, por predefinição, serão devolvidas importâncias não processadas para as funcionalidades não processadas. Se feature_maps forem transmitidas aqui (NÃO se destina a serem utilizadas ao mesmo tempo que as transformações), o explicador irá esperar dados transformados e, por predefinição, serão devolvidos importâncias para os dados transformados. Em ambos os casos, a saída pode ser especificada ao definir get_raw explicitamente como Verdadeiro ou Falso no método de explicação do explicador.

KernelScoringExplainer

Define um modelo de classificação baseado em KernelExplainer.

Se o explicador original estava a utilizar um KernelExplainer SHAP e não foram transmitidos dados de inicialização, o núcleo do explicador original será reutilizado. Se o explicador original tiver utilizado outro método ou se forem transmitidos novos dados de inicialização em initialization_examples, será criado um novo explicador.

Se as transformações forem transmitidas em original_explainer, essas transformações serão transferidas para o explicador de classificação, esperarão dados não processados e, por predefinição, serão devolvidas importâncias não processadas para as funcionalidades não processadas. Se feature_maps forem transmitidas aqui (NÃO se destina a serem utilizadas ao mesmo tempo que as transformações), o explicador irá esperar dados transformados e, por predefinição, serão devolvidos importâncias para os dados transformados. Em ambos os casos, a saída pode ser especificada ao definir get_raw explicitamente como Verdadeiro ou Falso no método de explicação do explicador.

Inicialize o KernelScoringExplainer.

Se o explicador original estava a utilizar um KernelExplainer SHAP e não foram transmitidos dados de inicialização, o núcleo do explicador original será reutilizado. Se o explicador original tiver utilizado outro método ou se forem transmitidos novos dados de inicialização em initialization_examples, será criado um novo explicador.

Se as transformações forem transmitidas em original_explainer, essas transformações serão transferidas para o explicador de classificação, esperarão dados não processados e, por predefinição, serão devolvidas importâncias não processadas para as funcionalidades não processadas. Se feature_maps forem transmitidas aqui (NÃO se destina a serem utilizadas ao mesmo tempo que as transformações), o explicador irá esperar dados transformados e, por predefinição, serão devolvidos importâncias para os dados transformados. Em ambos os casos, a saída pode ser especificada ao definir get_raw explicitamente como Verdadeiro ou Falso no método de explicação do explicador.

LinearScoringExplainer

Define um modelo de classificação baseado em LinearExplainer.

Se o explicador original estava a utilizar um SHAP LinearExplainer e não foram transmitidos dados de inicialização, o núcleo do explicador original será reutilizado. Se o explicador original tiver utilizado outro método ou se forem transmitidos novos dados de inicialização em initialization_examples, será criado um novo explicador.

Se as transformações forem transmitidas em original_explainer, essas transformações serão transferidas para o explicador de classificação, esperarão dados não processados e, por predefinição, serão devolvidas importâncias não processadas para as funcionalidades não processadas. Se feature_maps forem transmitidas aqui (NÃO se destina a serem utilizadas ao mesmo tempo que as transformações), o explicador irá esperar dados transformados e, por predefinição, serão devolvidos importâncias para os dados transformados. Em ambos os casos, a saída pode ser especificada ao definir get_raw explicitamente como Verdadeiro ou Falso no método de explicação do explicador.

Inicialize o LinearScoringExplainer.

Se o explicador original estava a utilizar um SHAP LinearExplainer e não foram transmitidos dados de inicialização, o núcleo do explicador original será reutilizado. Se o explicador original tiver utilizado outro método ou se forem transmitidos novos dados de inicialização em initialization_examples, será criado um novo explicador.

Se as transformações forem transmitidas em original_explainer, essas transformações serão transferidas para o explicador de classificação, esperarão dados não processados e, por predefinição, serão devolvidas importâncias não processadas para as funcionalidades não processadas. Se feature_maps forem transmitidas aqui (NÃO se destina a serem utilizadas ao mesmo tempo que as transformações), o explicador irá esperar dados transformados e, por predefinição, serão devolvidos importâncias para os dados transformados. Em ambos os casos, a saída pode ser especificada ao definir get_raw explicitamente como Verdadeiro ou Falso no método de explicação do explicador.

ScoringExplainer

Define um modelo de classificação.

Se as transformações forem transmitidas em original_explainer, essas transformações serão transferidas para o explicador de classificação, esperarão dados não processados e, por predefinição, serão devolvidas importâncias não processadas para as funcionalidades não processadas. Se feature_maps forem transmitidas aqui (NÃO se destina a serem utilizadas ao mesmo tempo que transformações), o explicador espera que os dados transformados sejam transformados e, por predefinição, serão devolvidos importâncias para os dados transformados. Em ambos os casos, a saída pode ser especificada ao definir get_raw explicitamente como Verdadeiro ou Falso no método de explicação do explicador.

Inicialize o ScoringExplainer.

Se as transformações forem transmitidas em original_explainer, essas transformações serão transferidas para o explicador de classificação, esperarão dados não processados e, por predefinição, serão devolvidas importâncias não processadas para as funcionalidades não processadas. Se feature_maps forem transmitidas aqui (NÃO se destina a serem utilizadas ao mesmo tempo que transformações), o explicador espera que os dados transformados sejam transformados e, por predefinição, serão devolvidos importâncias para os dados transformados. Em ambos os casos, a saída pode ser especificada ao definir get_raw explicitamente como Verdadeiro ou Falso no método de explicação do explicador.

TreeScoringExplainer

Define um modelo de classificação baseado em TreeExplainer.

Se o explicador original estava a utilizar um TREEExplainer SHAP, o núcleo do explicador original será reutilizado. Se o explicador original tiver utilizado outro método, será criado um novo explicador.

Se as transformações forem transmitidas em original_explainer, essas transformações serão transferidas para o explicador de classificação, esperarão dados não processados e, por predefinição, serão devolvidas importâncias não processadas para as funcionalidades não processadas. Se feature_maps forem transmitidas aqui (NÃO se destina a serem utilizadas ao mesmo tempo que as transformações), o explicador irá esperar dados transformados e, por predefinição, serão devolvidos importâncias para os dados transformados. Em ambos os casos, a saída pode ser especificada ao definir get_raw explicitamente como Verdadeiro ou Falso no método de explicação do explicador.

Inicialize o TreeScoringExplainer.

Se o explicador original estava a utilizar um TREEExplainer SHAP, o núcleo do explicador original será reutilizado. Se o explicador original tiver utilizado outro método, será criado um novo explicador.

Se as transformações forem transmitidas em original_explainer, essas transformações serão transferidas para o explicador de classificação, esperarão dados não processados e, por predefinição, serão devolvidas importâncias não processadas para as funcionalidades não processadas. Se feature_maps forem transmitidas aqui (NÃO se destina a serem utilizadas ao mesmo tempo que as transformações), o explicador irá esperar dados transformados e, por predefinição, serão devolvidos importâncias para os dados transformados. Em ambos os casos, a saída pode ser especificada ao definir get_raw explicitamente como Verdadeiro ou Falso no método de explicação do explicador.

Funções

load

Carregue o explicador de classificação a partir do disco.

load(directory)

Parâmetros

Name Description
directory
Necessário
str

O diretório no qual o explicador serializado está armazenado. Parte do princípio de que scoring_explainer.pkl está disponível no nível superior do diretório.

Devoluções

Tipo Description

O explicador de classificação de uma explicação, carregado a partir do disco.

save

Guarde o explicador de classificação no disco.

save(scoring_explainer, directory='.', exist_ok=False)

Parâmetros

Name Description
scoring_explainer
Necessário

O objeto do explicador de classificação que deve ser guardado. O explicador será escrito em [diretório]/scoring_explainer.pkl.

directory
str

O diretório no qual o explicador serializado deve ser armazenado. Se o diretório não existir, será criado.

Default value: .
exist_ok

Se For Falso (o estado predefinido), será emitido um aviso se o diretório indicado já existir. Se For Verdadeiro, o diretório atual será utilizado e todos os conteúdos sobrepostos serão substituídos.

Default value: False

Devoluções

Tipo Description
str

O caminho para o ficheiro pickle do explicador de classificação.