.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples\2_explain\plot_5_shap.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_examples_2_explain_plot_5_shap.py>`
        to download the full example code or to run this example in your browser via Binder

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_2_explain_plot_5_shap.py:


SHapley Additive exPlanations
=====================================

.. GENERATED FROM PYTHON SOURCE LINES 9-10

Experiment initialization and data preparation

.. GENERATED FROM PYTHON SOURCE LINES 10-18

.. code-block:: default

    from piml import Experiment
    from piml.models import XGB2Regressor

    exp = Experiment()
    exp.data_loader(data="BikeSharing", silent=True)
    exp.data_summary(feature_exclude=["yr", "mnth", "temp"], silent=True)
    exp.data_prepare(target="cnt", task_type="regression", silent=True)








.. GENERATED FROM PYTHON SOURCE LINES 19-20

Train Model

.. GENERATED FROM PYTHON SOURCE LINES 20-22

.. code-block:: default

    exp.model_train(model=XGB2Regressor(), name="XGB2")








.. GENERATED FROM PYTHON SOURCE LINES 23-24

SHAP Waterfall plot

.. GENERATED FROM PYTHON SOURCE LINES 24-25

.. code-block:: default

    exp.model_explain(model="XGB2", show="shap_waterfall", sample_id=0, figsize=(5, 4))



.. image-sg:: /auto_examples/2_explain/images/sphx_glr_plot_5_shap_001.png
   :alt: plot 5 shap
   :srcset: /auto_examples/2_explain/images/sphx_glr_plot_5_shap_001.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 26-27

SHAP feature importance

.. GENERATED FROM PYTHON SOURCE LINES 27-28

.. code-block:: default

    exp.model_explain(model="XGB2", show="shap_fi", sample_size=100, figsize=(5, 4))



.. image-sg:: /auto_examples/2_explain/images/sphx_glr_plot_5_shap_002.png
   :alt: plot 5 shap
   :srcset: /auto_examples/2_explain/images/sphx_glr_plot_5_shap_002.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 29-30

SHAP summary plot

.. GENERATED FROM PYTHON SOURCE LINES 30-31

.. code-block:: default

    exp.model_explain(model="XGB2", show="shap_summary", sample_size=100, figsize=(5, 4))



.. image-sg:: /auto_examples/2_explain/images/sphx_glr_plot_5_shap_003.png
   :alt: plot 5 shap
   :srcset: /auto_examples/2_explain/images/sphx_glr_plot_5_shap_003.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 32-33

SHAP scatter plot

.. GENERATED FROM PYTHON SOURCE LINES 33-35

.. code-block:: default

    exp.model_explain(model="XGB2", show="shap_scatter", uni_feature="hr", 
                      sample_size=100, figsize=(5, 4))



.. image-sg:: /auto_examples/2_explain/images/sphx_glr_plot_5_shap_004.png
   :alt: plot 5 shap
   :srcset: /auto_examples/2_explain/images/sphx_glr_plot_5_shap_004.png
   :class: sphx-glr-single-img






.. rst-class:: sphx-glr-timing

   **Total running time of the script:** ( 0 minutes  43.691 seconds)

**Estimated memory usage:**  33 MB


.. _sphx_glr_download_auto_examples_2_explain_plot_5_shap.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example


    .. container:: binder-badge

      .. image:: images/binder_badge_logo.svg
        :target: https://mybinder.org/v2/gh/selfexplainml/piml-toolbox/main?urlpath=lab/tree/./docs/_build/html/notebooks/auto_examples/2_explain/plot_5_shap.ipynb
        :alt: Launch binder
        :width: 150 px



    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_5_shap.py <plot_5_shap.py>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_5_shap.ipynb <plot_5_shap.ipynb>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_