aibox.nlp.metrics.kappa

Implementação de métricas relacionadas com o Cohen’s Kappa.

Classes

CohensKappaScore([weights])

Métrica para cálculo do Cohen's Kappa.

NeighborCohensKappaScore([neighbor_limit, ...])

Métrica do Cohen's Kappa vizinho.

class aibox.nlp.metrics.kappa.CohensKappaScore(weights: str | None = None)[código-fonte]

Base: Metric

Métrica para cálculo do Cohen’s Kappa.

Parâmetros:

weights (str) – ‘quadratic’, ‘linear’ ou None. Indica se devemos calcular a métrica ponderada (default=None).

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[código-fonte]

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

class aibox.nlp.metrics.kappa.NeighborCohensKappaScore(neighbor_limit: int = 1, weights: str | None = None)[código-fonte]

Base: Metric

Métrica do Cohen’s Kappa vizinho.

Métrica para o cálculo do Cohen’s Kappa onde classes vizinhas são consideradas iguais para fins de cálculo.

Parâmetros:
  • neighbor_limit (int) – diferença máxima entre duas classes para elas serem consideradas vizinhas (default=1).

  • weights (str) – ‘quadratic’, ‘linear’ ou None. Indica se devemos calcular a métrica ponderada (default=None).

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[código-fonte]

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