abacusai.feature_drift_record
=============================

.. py:module:: abacusai.feature_drift_record


Classes
-------

.. autoapisummary::

   abacusai.feature_drift_record.FeatureDriftRecord


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

.. py:class:: FeatureDriftRecord(client, name=None, distance=None, jsDistance=None, wsDistance=None, ksStatistic=None, psi=None, csi=None, chiSquare=None)

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


   Value of each type of drift

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param name: Name of feature.
   :type name: str
   :param distance: Symmetric sum of KL divergences between the training distribution and the range of values in the specified window.
   :type distance: float
   :param jsDistance: JS divergence between the training distribution and the range of values in the specified window.
   :type jsDistance: float
   :param wsDistance: Wasserstein distance between the training distribution and the range of values in the specified window.
   :type wsDistance: float
   :param ksStatistic: Kolmogorov-Smirnov statistic computed between the training distribution and the range of values in the specified window.
   :type ksStatistic: float
   :param psi: Population stability index computed between the training distribution and the range of values in the specified window.
   :type psi: float
   :param csi: Characteristic Stability Index computed between the training distribution and the range of values in the specified window.
   :type csi: float
   :param chiSquare: Chi-square statistic computed between the training distribution and the range of values in the specified window.
   :type chiSquare: float


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



   .. py:attribute:: distance
      :value: None



   .. py:attribute:: js_distance
      :value: None



   .. py:attribute:: ws_distance
      :value: None



   .. py:attribute:: ks_statistic
      :value: None



   .. py:attribute:: psi
      :value: None



   .. py:attribute:: csi
      :value: None



   .. py:attribute:: chi_square
      :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