Causality Module
==================

The ``causality`` module provides tools for comparing models using causal metrics and tests.

Classes
-------

CausalModels
~~~~~~~~~~~~

.. autoclass:: mini_causal.causality.CausalModels
   :members:
   :undoc-members:
   :show-inheritance:
   :exclude-members: __init__

   **Attributes:**

   - ``individual_causal_effects (np.ndarray)``: an array of the individual causal effects for the predictions
   - ``individual_causal_effects_resid (np.ndarray)``: an array of the individual causal effects for the residuals
   - ``average_causal_effect (float)``: the effect of the feature on the predictions or outcomes
   - ``average_causal_effect_resid (float)``: the average causal effect of the feature on the residuals

CausalModelsClassifier
~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: mini_causal.causality.CausalModelsClassifier
   :members:
   :undoc-members:
   :show-inheritance:
   :exclude-members: __init__

   **Attributes:**

   - ``individual_causal_effects (np.ndarray)``: an array of the individual causal effects for the predictions
   - ``individual_causal_effects_resid (np.ndarray)``: an array of the individual causal effects for the residuals
   - ``individual_causal_effects_probs (np.ndarray)``: an array of the individual causal effects for the probabilities
   - ``average_causal_effect (float)``: the average causal effect of the first model
   - ``average_causal_effect_resid (float)``: the average causal effect of the first model on the residuals
   - ``average_causal_effect_probs (float)``: the average causal effect of the first model on the predicted probabilities

CausalModelsRegression
~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: mini_causal.causality.CausalModelsRegression
   :members:
   :undoc-members:
   :show-inheritance:
   :exclude-members: __init__

   **Attributes:**

   - ``individual_causal_effects (np.ndarray)``: an array of the individual causal effects for the predictions
   - ``individual_causal_effects_resid (np.ndarray)``: an array of the individual causal effects for the residuals
   - ``individual_causal_effects_probs (np.ndarray)``: an array of the individual causal effects for the probabilities
   - ``average_causal_effect (float)``: the average causal effect of the first model
   - ``average_causal_effect_resid (float)``: the average causal effect of the first model on the residuals
   - ``average_causal_effect_probs (float)``: the average causal effect of the first model on the predicted probabilities