:py:mod:`rhino_health.lib.metrics.quantile`
===========================================

.. py:module:: rhino_health.lib.metrics.quantile


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

Classes
~~~~~~~

.. autoapisummary::

   rhino_health.lib.metrics.quantile.Median
   rhino_health.lib.metrics.quantile.Percentile
   rhino_health.lib.metrics.quantile.Min
   rhino_health.lib.metrics.quantile.Max




.. py:class:: Median(**data: Any)


   Bases: :py:obj:`rhino_health.lib.metrics.base_metric.AggregatableMetric`

   
   Returns the median of entries for a specified VARIABLE
















   ..
       !! processed by numpydoc !!
   .. py:attribute:: variable
      :type: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

      


.. py:class:: Percentile(**data: Any)


   Bases: :py:obj:`rhino_health.lib.metrics.base_metric.AggregatableMetric`

   
   Returns the k-percentile of entries for a specified VARIABLE
















   ..
       !! processed by numpydoc !!
   .. py:attribute:: variable
      :type: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

      

   .. py:attribute:: percentile
      :type: Union[int, float]

      


.. py:class:: Min(**data: Any)


   Bases: :py:obj:`rhino_health.lib.metrics.base_metric.AggregatableMetric`

   
   Returns the minimum of entries for a specified VARIABLE
















   ..
       !! processed by numpydoc !!
   .. py:attribute:: variable
      :type: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

      


.. py:class:: Max(**data: Any)


   Bases: :py:obj:`rhino_health.lib.metrics.base_metric.AggregatableMetric`

   
   Returns the maximum of entries for a specified VARIABLE
















   ..
       !! processed by numpydoc !!
   .. py:attribute:: variable
      :type: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName