abacusai.drift_distribution
===========================

.. py:module:: abacusai.drift_distribution


Classes
-------

.. autoapisummary::

   abacusai.drift_distribution.FeatureDistribution
   abacusai.drift_distribution.AbstractApiClass
   abacusai.drift_distribution.DriftDistribution


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

.. py:class:: FeatureDistribution(client, type=None, trainingDistribution=None, predictionDistribution=None, numericalTrainingDistribution=None, numericalPredictionDistribution=None, trainingStatistics=None, predictionStatistics=None)

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


   For a single feature, how it has changed in the training data versus some specified window

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param type: Data type of values in each distribution, typically 'categorical' or 'numerical'.
   :type type: str
   :param trainingDistribution: A dict describing the range of values in the training distribution.
   :type trainingDistribution: dict
   :param predictionDistribution: A dict describing the range of values in the specified window.
   :type predictionDistribution: dict
   :param numericalTrainingDistribution: A dict describing the summary statistics of the numerical training distribution.
   :type numericalTrainingDistribution: dict
   :param numericalPredictionDistribution: A dict describing the summary statistics of the numerical prediction distribution.
   :type numericalPredictionDistribution: dict
   :param trainingStatistics: A dict describing summary statistics of values in the training distribution.
   :type trainingStatistics: dict
   :param predictionStatistics: A dict describing summary statistics of values in the specified window.
   :type predictionStatistics: dict


   .. py:method:: __repr__()

      Return repr(self).



   .. 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



.. py:class:: AbstractApiClass(client, id)

   .. py:method:: __eq__(other)

      Return self==value.



   .. py:method:: _get_attribute_as_dict(attribute)


.. py:class:: DriftDistribution(client, trainColumn=None, predictedColumn=None, metrics=None, distribution={})

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


   How actuals or predicted values have changed in the training data versus predicted data

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param trainColumn: The feature name in the train table.
   :type trainColumn: str
   :param predictedColumn: The feature name in the prediction table.
   :type predictedColumn: str
   :param metrics: Drift measures.
   :type metrics: dict
   :param distribution: A FeatureDistribution, how the training data compares to the predicted data.
   :type distribution: FeatureDistribution


   .. py:method:: __repr__()

      Return repr(self).



   .. 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



