scoring_explainer Pacote

Define os modelos de pontuação para aproximação dos valores de importância do recurso.

Classes

DeepScoringExplainer	Define um modelo de pontuação baseado em DeepExplainer. Se o explicador original estava usando um DeepExplainer SHAP e nenhum dado de inicialização foi enviado, será reutilizado o núcleo do explicador original. Se o explicador original tiver usado outro método ou se tiverem sido enviados novos dados de inicialização em initialization_examples, será criado um novo explicador. Se tiverem sido passadas transformações no original_explainer, elas serão transferidas para o explicador de pontuação que, por sua vez, esperará dados brutos e, por padrão, serão retornadas importâncias para recursos brutos. Se feature_maps forem passados aqui (NÃO se destinam a serem usados ao mesmo tempo que as transformações), o explicador esperará dados transformados e, por padrão, serão retornadas importâncias para dados transformados. Em ambos os casos, a saída pode ser especificada definindo get_raw explicitamente como True ou False no método explain do explicador. Inicialize o DeepScoringExplainer. Se o explicador original estava usando um DeepExplainer SHAP e nenhum dado de inicialização foi enviado, será reutilizado o núcleo do explicador original. Se o explicador original tiver usado outro método ou se tiverem sido enviados novos dados de inicialização em initialization_examples, será criado um novo explicador. Se tiverem sido passadas transformações no original_explainer, elas serão transferidas para o explicador de pontuação que, por sua vez, esperará dados brutos e, por padrão, serão retornadas importâncias para recursos brutos. Se feature_maps forem passados aqui (NÃO se destinam a serem usados ao mesmo tempo que as transformações), o explicador esperará dados transformados e, por padrão, serão retornadas importâncias para dados transformados. Em ambos os casos, a saída pode ser especificada definindo get_raw explicitamente como True ou False no método explain do explicador.
KernelScoringExplainer	Define um modelo de pontuação baseado em KernelExplainer. Se o explicador original estava usando um KernelExplainer SHAP e nenhum dado de inicialização foi enviado, será reutilizado o núcleo do explicador original. Se o explicador original tiver usado outro método ou se tiverem sido enviados novos dados de inicialização em initialization_examples, será criado um novo explicador. Se tiverem sido passadas transformações no original_explainer, elas serão transferidas para o explicador de pontuação que, por sua vez, esperará dados brutos e, por padrão, serão retornadas importâncias para recursos brutos. Se feature_maps forem passados aqui (NÃO se destinam a serem usados ao mesmo tempo que as transformações), o explicador esperará dados transformados e, por padrão, serão retornadas importâncias para dados transformados. Em ambos os casos, a saída pode ser especificada definindo get_raw explicitamente como True ou False no método explain do explicador. Inicialize o KernelScoringExplainer. Se o explicador original estava usando um KernelExplainer SHAP e nenhum dado de inicialização foi enviado, será reutilizado o núcleo do explicador original. Se o explicador original tiver usado outro método ou se tiverem sido enviados novos dados de inicialização em initialization_examples, será criado um novo explicador. Se tiverem sido passadas transformações no original_explainer, elas serão transferidas para o explicador de pontuação que, por sua vez, esperará dados brutos e, por padrão, serão retornadas importâncias para recursos brutos. Se feature_maps forem passados aqui (NÃO se destinam a serem usados ao mesmo tempo que as transformações), o explicador esperará dados transformados e, por padrão, serão retornadas importâncias para dados transformados. Em ambos os casos, a saída pode ser especificada definindo get_raw explicitamente como True ou False no método explain do explicador.
LinearScoringExplainer	Define um modelo de pontuação baseado em LinearExplainer. Se o explicador original estava usando um LinearExplainer SHAP e nenhum dado de inicialização foi enviado, será reutilizado o núcleo do explicador original. Se o explicador original tiver usado outro método ou se tiverem sido enviados novos dados de inicialização em initialization_examples, será criado um novo explicador. Se tiverem sido passadas transformações no original_explainer, elas serão transferidas para o explicador de pontuação que, por sua vez, esperará dados brutos e, por padrão, serão retornadas importâncias para recursos brutos. Se feature_maps forem passados aqui (NÃO se destinam a serem usados ao mesmo tempo que as transformações), o explicador esperará dados transformados e, por padrão, serão retornadas importâncias para dados transformados. Em ambos os casos, a saída pode ser especificada definindo get_raw explicitamente como True ou False no método explain do explicador. Inicialize o LinearScoringExplainer. Se o explicador original estava usando um LinearExplainer SHAP e nenhum dado de inicialização foi enviado, será reutilizado o núcleo do explicador original. Se o explicador original tiver usado outro método ou se tiverem sido enviados novos dados de inicialização em initialization_examples, será criado um novo explicador. Se tiverem sido passadas transformações no original_explainer, elas serão transferidas para o explicador de pontuação que, por sua vez, esperará dados brutos e, por padrão, serão retornadas importâncias para recursos brutos. Se feature_maps forem passados aqui (NÃO se destinam a serem usados ao mesmo tempo que as transformações), o explicador esperará dados transformados e, por padrão, serão retornadas importâncias para dados transformados. Em ambos os casos, a saída pode ser especificada definindo get_raw explicitamente como True ou False no método explain do explicador.
ScoringExplainer	Define um modelo de pontuação. Se as transformações foram passadas no original_explainer, essas transformações serão transferidas para o explicador de pontuação que, por sua vez, esperará dados brutos e, por padrão, as importâncias serão retornadas para recursos brutos. Se feature_maps forem passados aqui (não se destinam a serem usados ao mesmo tempo que as transformações), o explicador esperará dados transformados e, por padrão, as importâncias serão retornadas para dados transformados. Em ambos os casos, a saída pode ser especificada definindo get_raw explicitamente como True ou False no método explain do explicador. Inicialize o ScoreExplainer. Se as transformações foram passadas no original_explainer, essas transformações serão transferidas para o explicador de pontuação que, por sua vez, esperará dados brutos e, por padrão, as importâncias serão retornadas para recursos brutos. Se feature_maps forem passados aqui (não se destinam a serem usados ao mesmo tempo que as transformações), o explicador esperará dados transformados e, por padrão, as importâncias serão retornadas para dados transformados. Em ambos os casos, a saída pode ser especificada definindo get_raw explicitamente como True ou False no método explain do explicador.
TreeScoringExplainer	Define um modelo de pontuação baseado em TreeExplainer. Se o explicador original estava usando um SHAP TreeExplainer, o núcleo do explicador original será reutilizado. Se o explicador original usou outro método, outro explicador será criado. Se as transformações foram passadas no original_explainer, essas transformações serão transferidas para o explicador de pontuação que, por sua vez, esperará dados brutos e, por padrão, as importâncias serão retornadas para recursos brutos. Se feature_maps forem passados aqui (NÃO se destinam a serem usados ao mesmo tempo que as transformações), o explicador esperará dados transformados e, por padrão, serão retornadas importâncias para dados transformados. Em ambos os casos, a saída pode ser especificada definindo get_raw explicitamente como True ou False no método explain do explicador. Inicialize o TreeScoringExplainer. Se o explicador original estava usando um SHAP TreeExplainer, o núcleo do explicador original será reutilizado. Se o explicador original usou outro método, outro explicador será criado. Se as transformações foram passadas no original_explainer, essas transformações serão transferidas para o explicador de pontuação que, por sua vez, esperará dados brutos e, por padrão, as importâncias serão retornadas para recursos brutos. Se feature_maps forem passados aqui (NÃO se destinam a serem usados ao mesmo tempo que as transformações), o explicador esperará dados transformados e, por padrão, serão retornadas importâncias para dados transformados. Em ambos os casos, a saída pode ser especificada definindo get_raw explicitamente como True ou False no método explain do explicador.

Funções

load

Carregue o explicador de pontuação do disco.

load(directory)

Parâmetros

Nome	Description
directory Obrigatório	str O diretório sob o qual o explicador serializado é armazenado. Pressupõe que scoring_explainer.pkl está disponível no nível superior do diretório.

Retornos

Tipo	Description
ScoringExplainer	O explicador de pontuação de uma explicação, carregado do disco.

save

Salve o explicador de pontuação no disco.

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

Parâmetros

Nome	Description
scoring_explainer Obrigatório	O objeto explicador de pontuação que deve ser salvo. O explicador será gravado em [diretório]/scoring_explainer.pkl.
directory	str O diretório sob o qual o explicador serializado deve ser armazenado. Se o diretório não existir, ele será criado. Valor padrão: .
exist_ok	bool Se for False (o estado padrão) e o diretório fornecido já existir, um aviso será gerado. Se for True, o diretório atual será usado e conteúdos sobrepostos serão substituídos. Valor padrão: False

Retornos

Tipo	Description
str	O caminho para o arquivo pickle do explicador de pontuação.