abacusai.feature_importance
===========================

.. py:module:: abacusai.feature_importance


Classes
-------

.. autoapisummary::

   abacusai.feature_importance.FeatureImportance


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

.. py:class:: FeatureImportance(client, shapFeatureImportance=None, limeFeatureImportance=None, permutationFeatureImportance=None, nullFeatureImportance=None, lofoFeatureImportance=None, ebmFeatureImportance=None)

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


   Feature importance for a specified model monitor

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param shapFeatureImportance: A map of feature name to feature importance, determined by Shap values on a sample dataset.
   :type shapFeatureImportance: dict
   :param limeFeatureImportance: A map of feature name to feature importance, determined by Lime contribution values on a sample dataset.
   :type limeFeatureImportance: dict
   :param permutationFeatureImportance: A map of feature name to feature importance, determined by permutation importance.
   :type permutationFeatureImportance: dict
   :param nullFeatureImportance: A map of feature name to feature importance, determined by null feature importance.
   :type nullFeatureImportance: dict
   :param lofoFeatureImportance: A map of feature name to feature importance, determined by the Leave One Feature Out method.
   :type lofoFeatureImportance: dict
   :param ebmFeatureImportance: A map of feature name to feature importance, determined by an Explainable Boosting Machine.
   :type ebmFeatureImportance: dict


   .. py:attribute:: shap_feature_importance
      :value: None



   .. py:attribute:: lime_feature_importance
      :value: None



   .. py:attribute:: permutation_feature_importance
      :value: None



   .. py:attribute:: null_feature_importance
      :value: None



   .. py:attribute:: lofo_feature_importance
      :value: None



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