libuplift.metrics.bins
======================

.. py:module:: libuplift.metrics.bins

.. autoapi-nested-parse::

   Measures based on comparing treatment and control statistics within
   bins, such as quantiles.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   libuplift.metrics.bins.iter_quantiles
   libuplift.metrics.bins.QMSE
   libuplift.metrics.bins.QMSE_j
   libuplift.metrics.bins.EUCE
   libuplift.metrics.bins.MUCE


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

.. py:function:: iter_quantiles(scores, trt, n_trt, n=10, joint=False, sample_weight=None)

   
   Iterate simultaneously over quantiles of score vectors for all
   treatments.

   Returns a generator which, for each quantile, returns a list of
   index arrays for scores within each treatment.

   If joint is True, quantiles are computed jointly for all
   treatments.

   If sample_weight is not None, weighted quantiles are used.















   ..
       !! processed by numpydoc !!

.. py:function:: QMSE(y_true, y_pred, trt, n_trt=None, sample_weight=None, n_bins=10, allow_nans=False, joint_quantiles=False)

   
   The per-quantile MSE measure by Rudaś, Jaroszewicz.
















   ..
       !! processed by numpydoc !!

.. py:function:: QMSE_j(y_true, y_pred, trt, n_trt=None, sample_weight=None, n_bins=10, allow_nans=False)

.. py:function:: EUCE(y_true, y_pred, trt, n_trt=None, sample_weight=None, n_bins=100, allow_nans=False, joint_quantiles=True)

   
   The EUCE measure by Nyberg and Klami.
















   ..
       !! processed by numpydoc !!

.. py:function:: MUCE(y_true, y_pred, trt, n_trt=None, sample_weight=None, n_bins=100, allow_nans=False, joint_quantiles=True)

   
   The MUCE measure by Nyberg and Klami.
















   ..
       !! processed by numpydoc !!