aibox.nlp.core.metric

Interface básica para o cálculo de métricas.

Classes

Metric()

Essa é a interface para uma métrica.

class aibox.nlp.core.metric.Metric

Base: ABC

Essa é a interface para uma métrica.

Toda métrica recebe os valores reais e os preditos por algum estimador e retorna uma numpy array com os resultados.

import numpy as np
from aibox.nlp.core.metric import Metric

# Exemplo de uso para classes concretas
metric = Metric()
y_true = np.array([0, 1, 2])
y_pred = np.array([0, 0, 2])

# Calculando métricas
metric.compute(y_true, y_pred)
# Out: array(0.6666667)

abstract 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

abstract 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]