pyepo.metric.regret
===================

.. py:module:: pyepo.metric.regret

.. autoapi-nested-parse::

   True regret loss



Functions
---------

.. autoapisummary::

   pyepo.metric.regret.regret
   pyepo.metric.regret.calRegret


Module Contents
---------------

.. py:function:: regret(predmodel, optmodel, dataloader)

   A function to evaluate model performance with normalized true regret

   :param predmodel: a regression neural network for cost prediction
   :type predmodel: nn
   :param optmodel: an PyEPO optimization model
   :type optmodel: optModel
   :param dataloader: Torch dataloader from optDataSet
   :type dataloader: DataLoader

   :returns: true regret loss
   :rtype: float


.. py:function:: calRegret(optmodel, pred_cost, true_cost, true_obj)

   A function to calculate normalized true regret for a batch

   :param optmodel: optimization model
   :type optmodel: optModel
   :param pred_cost: predicted costs
   :type pred_cost: torch.tensor
   :param true_cost: true costs
   :type true_cost: torch.tensor
   :param true_obj: true optimal objective values
   :type true_obj: torch.tensor

   Returns:predmodel
       float: true regret losses