.. _pyreal.explanation_types:

Explanation Type
=========================
.. currentmodule:: pyreal.explanation_types

Explanation Type
~~~~~~~~~~~~~~~~~
.. autosummary::
    :toctree: api/

    base.Explanation
    base.Explanation.get
    base.Explanation.get_explanation
    base.Explanation.get_values
    base.Explanation.update_explanation
    base.Explanation.apply_feature_descriptions
    base.Explanation.update_values
    base.Explanation.validate
    base.Explanation.validate_values

DataFrame Explanation Type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
    :toctree: api/

    feature_based.FeatureBased

Feature Importance Explanation Type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
    :toctree: api/

    feature_based.FeatureImportanceExplanation

Additive Feature Importance Explanation Type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
    :toctree: api/

    feature_based.AdditiveFeatureImportanceExplanation

Feature Contribution Explanation Type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
    :toctree: api/

    feature_based.FeatureContributionExplanation

Additive Feature Contribution Explanation Type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
    :toctree: api/

    feature_based.AdditiveFeatureContributionExplanation

Feature Value Based Explanation Type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
    :toctree: api/

    feature_value_based.FeatureValueBased

Partial Dependence Explanation Type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
    :toctree: api/

    feature_value_based.PartialDependenceExplanation

Decision Tree Explanation Type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
    :toctree: api/

    decision_tree.DecisionTreeExplanation

Example Based Explanation Type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
    :toctree: api/

    example_based.ExampleBasedExplanation

Similar Examples Explanation Type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
    :toctree: api/

    example_based.SimilarExampleExplanation