:py:mod:`ForeTiS.evaluation.eval_metrics`
=========================================

.. py:module:: ForeTiS.evaluation.eval_metrics


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


Functions
~~~~~~~~~

.. autoapisummary::

   ForeTiS.evaluation.eval_metrics.smape
   ForeTiS.evaluation.eval_metrics.mape
   ForeTiS.evaluation.eval_metrics.get_evaluation_report



.. py:function:: smape(y_true, y_pred)

   Function delivering Symmetric Mean Absolute Percentage Error between prediction and actual values
   :param y_true: actual values
   :param y_pred: prediction values
   :return: sMAPE between prediction and actual values


.. py:function:: mape(y_true, y_pred)

   Function delivering Mean Absolute Percentage Error between prediction and actual values
   :param y_true: actual values
   :param y_pred: prediction values
   :return: MAPE between prediction and actual values


.. py:function:: get_evaluation_report(y_true, y_pred, prefix = '', current_model_name = None)

   Get values for common evaluation metrics

   :param y_true: true values
   :param y_pred: predicted values
   :param prefix: prefix to be added to the key if multiple eval metrics are collected
   :param current_model_name: name of the current model according to naming of .py file in package model

   :return: dictionary with common metrics