:py:mod:`deeprvat.metrics`
==========================

.. py:module:: deeprvat.metrics

.. autodoc2-docstring:: deeprvat.metrics
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`RSquared <deeprvat.metrics.RSquared>`
     - .. autodoc2-docstring:: deeprvat.metrics.RSquared
          :summary:
   * - :py:obj:`PearsonCorr <deeprvat.metrics.PearsonCorr>`
     - .. autodoc2-docstring:: deeprvat.metrics.PearsonCorr
          :summary:
   * - :py:obj:`PearsonCorrTorch <deeprvat.metrics.PearsonCorrTorch>`
     - .. autodoc2-docstring:: deeprvat.metrics.PearsonCorrTorch
          :summary:
   * - :py:obj:`AveragePrecisionWithLogits <deeprvat.metrics.AveragePrecisionWithLogits>`
     - .. autodoc2-docstring:: deeprvat.metrics.AveragePrecisionWithLogits
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`logger <deeprvat.metrics.logger>`
     - .. autodoc2-docstring:: deeprvat.metrics.logger
          :summary:

API
~~~

.. py:data:: logger
   :canonical: deeprvat.metrics.logger
   :value: 'getLogger(...)'

   .. autodoc2-docstring:: deeprvat.metrics.logger

.. py:class:: RSquared()
   :canonical: deeprvat.metrics.RSquared

   .. autodoc2-docstring:: deeprvat.metrics.RSquared

   .. rubric:: Initialization

   .. autodoc2-docstring:: deeprvat.metrics.RSquared.__init__

   .. py:method:: __call__(preds: torch.tensor, targets: torch.tensor)
      :canonical: deeprvat.metrics.RSquared.__call__

      .. autodoc2-docstring:: deeprvat.metrics.RSquared.__call__

.. py:class:: PearsonCorr()
   :canonical: deeprvat.metrics.PearsonCorr

   .. autodoc2-docstring:: deeprvat.metrics.PearsonCorr

   .. rubric:: Initialization

   .. autodoc2-docstring:: deeprvat.metrics.PearsonCorr.__init__

   .. py:method:: __call__(burden, y)
      :canonical: deeprvat.metrics.PearsonCorr.__call__

      .. autodoc2-docstring:: deeprvat.metrics.PearsonCorr.__call__

.. py:class:: PearsonCorrTorch()
   :canonical: deeprvat.metrics.PearsonCorrTorch

   .. autodoc2-docstring:: deeprvat.metrics.PearsonCorrTorch

   .. rubric:: Initialization

   .. autodoc2-docstring:: deeprvat.metrics.PearsonCorrTorch.__init__

   .. py:method:: __call__(burden, y)
      :canonical: deeprvat.metrics.PearsonCorrTorch.__call__

      .. autodoc2-docstring:: deeprvat.metrics.PearsonCorrTorch.__call__

   .. py:method:: calculate_pearsonr(x, y)
      :canonical: deeprvat.metrics.PearsonCorrTorch.calculate_pearsonr

      .. autodoc2-docstring:: deeprvat.metrics.PearsonCorrTorch.calculate_pearsonr

.. py:class:: AveragePrecisionWithLogits()
   :canonical: deeprvat.metrics.AveragePrecisionWithLogits

   .. autodoc2-docstring:: deeprvat.metrics.AveragePrecisionWithLogits

   .. rubric:: Initialization

   .. autodoc2-docstring:: deeprvat.metrics.AveragePrecisionWithLogits.__init__

   .. py:method:: __call__(logits, y)
      :canonical: deeprvat.metrics.AveragePrecisionWithLogits.__call__

      .. autodoc2-docstring:: deeprvat.metrics.AveragePrecisionWithLogits.__call__