fair\_forge.metrics
===================

.. automodule:: fair_forge.metrics

   
   .. rubric:: Classes

   .. autosummary::
      :signatures: short

   
      DependencyTarget
      GroupMetric
      Metric
      MetricAgg
      RenyiCorrelation
   
   .. rubric:: Functions

   .. autosummary::
   
      as_group_metric
      cv
      prob_neg
      prob_pos
      tnr
      tpr
   
   

   

   
   
   .. autoclass:: DependencyTarget
      :members:
      :special-members: __call__
      :undoc-members:
      :show-inheritance:
   .. autoclass:: GroupMetric
      :members:
      :special-members: __call__
      :undoc-members:
      :show-inheritance:
   .. autoclass:: Metric
      :members:
      :special-members: __call__
      :undoc-members:
      :show-inheritance:
   .. autoclass:: MetricAgg
      :members:
      :special-members: __call__
      :undoc-members:
      :show-inheritance:
   .. autoclass:: RenyiCorrelation
      :members:
      :special-members: __call__
      :undoc-members:
      :show-inheritance:
   

   
   
   .. autofunction:: as_group_metric
   .. autofunction:: cv
   .. autofunction:: prob_neg
   .. autofunction:: prob_pos
   .. autofunction:: tnr
   .. autofunction:: tpr