abacusai.range_violation
========================

.. py:module:: abacusai.range_violation


Classes
-------

.. autoapisummary::

   abacusai.range_violation.RangeViolation


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

.. py:class:: RangeViolation(client, name=None, trainingMin=None, trainingMax=None, predictionMin=None, predictionMax=None, freqAboveTrainingRange=None, freqBelowTrainingRange=None)

   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`


   Summary of important range mismatches for a numerical feature discovered by a model monitoring instance

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param name: Name of feature.
   :type name: str
   :param trainingMin: Minimum value of training distribution for the specified feature.
   :type trainingMin: float
   :param trainingMax: Maximum value of training distribution for the specified feature.
   :type trainingMax: float
   :param predictionMin: Minimum value of prediction distribution for the specified feature.
   :type predictionMin: float
   :param predictionMax: Maximum value of prediction distribution for the specified feature.
   :type predictionMax: float
   :param freqAboveTrainingRange: Frequency of prediction rows below training minimum for the specified feature.
   :type freqAboveTrainingRange: float
   :param freqBelowTrainingRange: Frequency of prediction rows above training maximum for the specified feature.
   :type freqBelowTrainingRange: float


   .. py:attribute:: name
      :value: None



   .. py:attribute:: training_min
      :value: None



   .. py:attribute:: training_max
      :value: None



   .. py:attribute:: prediction_min
      :value: None



   .. py:attribute:: prediction_max
      :value: None



   .. py:attribute:: freq_above_training_range
      :value: None



   .. py:attribute:: freq_below_training_range
      :value: None



   .. py:attribute:: deprecated_keys


   .. py:method:: __repr__()


   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict