Pular para o conteúdo principal
Versões: 0.5.x

BaseClassifier

Classe base abstrata para algoritmos de classificação.

Módulo: aisp.base
Importação: from aisp.base import BaseClassifier


Visão geral

Esta classe define a interface principal para algoritmos de classificação.
Ela define a implementação dos metodos fit e predict em todas as classes derivadas, e fornece uma implementação do método score.

Caso de uso:

  • Classe base abstrata para estender classes de algoritmos de classificação.

Atributos

NomeTipoPadrãoDescrição
classesOptional[npt.NDArray]NoneRótulos das classes identificado de y durante o treinamento.

Métodos abstratos

fit

@abstractmethod
def fit(
self,
X: Union[npt.NDArray, list],
y: Union[npt.NDArray, list],
verbose: bool = True
) -> BaseClassifier:
...

Treine o modelo usando os dados de entrada X e seus rótulos correspondentes y. Este método abstrato é implementado é responsabilidade das classes filhas.

Parâmetros

NomeTipoPadrãoDescrição
XUnion[npt.NDArray, list]-Amostras de entrada para treinamento. Cada linha corresponde a uma amostra e cada coluna a uma característica.
yUnion[npt.NDArray, list]-Vetor alvo no formato (n_samples,). Deve conter o mesmo número de amostras que X.
verboseboolTrueSe True, exibe informações sobre o progresso do treinamento.

Returns

TipoDescrição
SelfRetorna a instancia da classe.

predict

@abstractmethod
def predict(self, X: Union[npt.NDArray, list]) -> npt.NDArray:
...

Gera previsões com base nos dados de entrada X.
Este método abstrato é implementado é responsabilidade das classes filhas.

Parâmetros

NomeTipoPadrãoDescrição
XUnion[npt.NDArray, list]-Amostras de entrada. Deve ter o mesmo número de características usadas no treinamento.

Returns

TipoDescrição
npt.NDArrayArray com as previsões para cada amostra de X.

Métodos públicos

score

def score(
self,
X: Union[npt.NDArray, list],
y: Union[npt.NDArray, list]
) -> float:
...

A função calcula o desempenho do modelo nas previsões utilizando a métrica de acurácia.

Esta função realiza a previsão de X e verifica quantos elementos são iguais entre o vetor y e y_predicted.
Esta função foi adicionada para compatibilidade com algumas funções do scikit-learn.

Parâmetros

NomeTipoPadrãoDescrição
XUnion[npt.NDArray, list]-Conjunto de características com dimensões (n_samples, n_features).
yUnion[npt.NDArray, list]-Rótulos verdadeiros com dimensão (n_amostras,).

Returns

TipoDescrição
floatA precisão do modelo.