"""
Copyright (c) 2022 Poutyne and all respective contributors.
Each contributor holds copyright over their respective contributions. The project versioning (Git)
records all such contribution source information.
This file is part of Poutyne.
Poutyne is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
version.
Poutyne is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with Poutyne. If not, see
<https://www.gnu.org/licenses/>.
"""
from abc import ABC, abstractmethod
import torch.nn as nn
[docs]
class Metric(ABC, nn.Module):
"""
The abstract class representing a metric which can be accumulated at each batch and calculated at the end
of the epoch.
"""
[docs]
def forward(self, y_pred, y_true):
"""
Update the current state of the metric and return the metric for the current batch. This method has to
be implemented if the metric is used as a **batch metric**. If used as an epoch metric, it does not need to be
implemented.
Args:
y_pred: The prediction of the model.
y_true: Target to evaluate the model.
Returns:
The value of the metric for the current batch.
"""
raise NotImplementedError
[docs]
def update(self, y_pred, y_true) -> None:
"""
Update the current state of the metric. This method has to be implemented if the metric is used as an **epoch
metric**. If used as a batch metric, it does not need to be implemented.
Args:
y_pred: The prediction of the model.
y_true: Target to evaluate the model.
"""
raise NotImplementedError
[docs]
@abstractmethod
def compute(self):
"""
Compute and return the metric. Should not modify the state of metric.
"""
pass
[docs]
@abstractmethod
def reset(self) -> None:
"""
The information kept for the computation of the metric is cleaned so that a new epoch can be done.
"""
pass