deconvatac.tl.metrics
=====================

.. py:module:: deconvatac.tl.metrics


Functions
---------

.. autoapisummary::

   deconvatac.tl.metrics.rmse
   deconvatac.tl.metrics.jsd


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

.. py:function:: rmse(true: Union[pandas.DataFrame, numpy.ndarray], predicted: Union[pandas.DataFrame, numpy.ndarray]) -> float

   Compute RMSE on true and predicted cell type proportions.

   Parameters
   ----------
   true
       True cell type proportions.
   predicted
       Predicted cell type proportions.

   Returns
   -------
   Root mean squared error.


.. py:function:: jsd(true: Union[pandas.DataFrame, numpy.ndarray], predicted: Union[pandas.DataFrame, numpy.ndarray]) -> float

   Compute Jensen-Shannon divergence on true and predicted cell type proportions.

   Parameters
   ----------
   true
       True cell type proportions.
   predicted
       Predicted cell type proportions.

   Returns
   -------
   Jensen-Shannon divergence.