Source code for ignite.contrib.metrics.regression.canberra_metric

import torch

from ignite.contrib.metrics.regression._base import _BaseRegression

[docs]class CanberraMetric(_BaseRegression): r""" Calculates the Canberra Metric. :math:`\text{CM} = \sum_{j=1}^n\frac{|A_j - P_j|}{A_j + P_j}` where, :math:`A_j` is the ground truth and :math:`P_j` is the predicted value. More details can be found in `Botchkarev 2018`__. - ``update`` must receive output of the form ``(y_pred, y)`` or ``{'y_pred': y_pred, 'y': y}``. - `y` and `y_pred` must be of same shape `(N, )` or `(N, 1)`. __ """ def reset(self): self._sum_of_errors = 0.0 def _update(self, output): y_pred, y = output errors = torch.abs(y.view_as(y_pred) - y_pred) / (y_pred + y.view_as(y_pred)) self._sum_of_errors += torch.sum(errors).item() def compute(self): return self._sum_of_errors

© Copyright 2024, PyTorch-Ignite Contributors. Last updated on 04/08/2024, 4:55:15 PM.

Built with Sphinx using a theme provided by Read the Docs.