syndirella.slipper.stats
========================

.. py:module:: syndirella.slipper.stats

.. autoapi-nested-parse::

   Provides functions for calculating errors.



Functions
---------

.. autoapisummary::

   syndirella.slipper.stats.ae
   syndirella.slipper.stats.pe
   syndirella.slipper.stats.ape
   syndirella.slipper.stats.bae
   syndirella.slipper.stats.bpe
   syndirella.slipper.stats.bape


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

.. py:function:: ae(val_pred: float, val_true: float) -> float

   Calculate absolute error.


.. py:function:: pe(val_pred: float, val_true: float) -> float

   Calculate percentage error.


.. py:function:: ape(val_pred: float, val_true: float) -> float

   Calculate absolute percentage error.


.. py:function:: bae(val: float, lb: float, ub: float) -> float

   Calculate out of bounds absolute error.


.. py:function:: bpe(val: float, lb: float, ub: float) -> float

   Calculate out of bounds percentage error.


.. py:function:: bape(val: float, lb: float, ub: float) -> float

   Calculate out of bounds absolute percentage error.