aibox.nlp.metrics.recall

Implementação da métrica de revocação.

Classes

Recall([labels, average, zero_division])

Métrica para cálculo da Revocação.

class aibox.nlp.metrics.recall.Recall(labels: list[int] | None = None, average: str | None = None, zero_division: float = 0.0)

Base: Metric

Métrica para cálculo da Revocação.

Parâmetros:

• labels (list[int]) – lista com labels utilizadas, caso não seja passado é inferido das entradas.

• average (str) – nenhum (None), micro, macro, weighted.

• zero_division (float) – valor caso ocorra divisão por zero.

Essa métrica produz resultados diferentes dependendo das configurações. Caso labels não seja passado, inferimos quais são as labels de acordo com y_true.

Já para average, temos as seguintes regras:

• Caso None, temos os valores por classe;

• Caso ‘micro’, calculamos a métrica global contando o número total de TP, FN e FP.

• Caso ‘macro’, calculamos a métrica para cada classe e retornamos a média não ponderada.

• Caso ‘weighted’, realizamos o mesmo processo que ‘macro’ mas retornamos a média ponderada onde os pesos são a quantidade de instâncias para aquela classe.

compute(y_true: ndarray, y_pred: ndarray) → ndarray[float32]

Computa o valor dessa métrica para as entradas recebidas.

Parâmetros:

• y_true (ndarray) – valores ground-truth com formato (n_samples,).

• y_pred (ndarray) – valores preditos por algum estimator com formato (n_samples,).

Retorna:

array com os valores da métrica. Shape depende da métrica.

Tipo de retorno:

ndarray[float32]

name() → str

Nome dessa métrica, toda métrica possui um nome único.

Se dois instâncias de uma métrica possuem o mesmo nome, o valor do método compute() é o mesmo para ambas instâncias dada as mesmas configurações e entradas.

Retorna:

nome identificador dessa métrica.

Tipo de retorno:

str