.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples\3_models\plot_1_gam_reg.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_3_models_plot_1_gam_reg.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_3_models_plot_1_gam_reg.py:


GAM Regression (California Housing)
=====================================

.. GENERATED FROM PYTHON SOURCE LINES 8-9

Experiment initialization and data preparation

.. GENERATED FROM PYTHON SOURCE LINES 9-16

.. code-block:: default

    from piml import Experiment
    from piml.models import GAMRegressor

    exp = Experiment()
    exp.data_loader(data="CaliforniaHousing_trim2", silent=True)
    exp.data_prepare(target="MedHouseVal", task_type="regression", silent=True)








.. GENERATED FROM PYTHON SOURCE LINES 17-18

Train Model

.. GENERATED FROM PYTHON SOURCE LINES 18-20

.. code-block:: default

    exp.model_train(model=GAMRegressor(spline_order=1, n_splines=20, lam=0.6), name="GAM")








.. GENERATED FROM PYTHON SOURCE LINES 21-22

Evaluate predictive performance

.. GENERATED FROM PYTHON SOURCE LINES 22-24

.. code-block:: default

    exp.model_diagnose(model="GAM", show="accuracy_table")





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

              MSE     MAE       R2
                              
    Train  0.0145  0.0867   0.7453
    Test   0.0152  0.0883   0.7257
    Gap    0.0007  0.0017  -0.0196




.. GENERATED FROM PYTHON SOURCE LINES 25-26

Global interpretation: effect plot

.. GENERATED FROM PYTHON SOURCE LINES 26-29

.. code-block:: default

    exp.model_interpret(model="GAM", show="global_effect_plot", uni_feature="MedInc",
                        original_scale=True, figsize=(5, 4))




.. image-sg:: /auto_examples/3_models/images/sphx_glr_plot_1_gam_reg_001.png
   :alt: MedInc (19.7%)
   :srcset: /auto_examples/3_models/images/sphx_glr_plot_1_gam_reg_001.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 30-31

Global interpretation: feature importance

.. GENERATED FROM PYTHON SOURCE LINES 31-33

.. code-block:: default

    exp.model_interpret(model="GAM", show="global_fi", figsize=(5, 4))




.. image-sg:: /auto_examples/3_models/images/sphx_glr_plot_1_gam_reg_002.png
   :alt: Feature Importance
   :srcset: /auto_examples/3_models/images/sphx_glr_plot_1_gam_reg_002.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 34-35

Local interpretation

.. GENERATED FROM PYTHON SOURCE LINES 35-38

.. code-block:: default

    exp.model_interpret(model="GAM", show="local_fi", sample_id=0,
                        original_scale=True, figsize=(5, 4))




.. image-sg:: /auto_examples/3_models/images/sphx_glr_plot_1_gam_reg_003.png
   :alt: Predicted: 0.3804 | Actual: 1.0000
   :srcset: /auto_examples/3_models/images/sphx_glr_plot_1_gam_reg_003.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 39-40

Local interpretation

.. GENERATED FROM PYTHON SOURCE LINES 40-42

.. code-block:: default

    exp.model_interpret(model="GAM", show="local_fi", sample_id=10,
                        original_scale=True, figsize=(5, 4))



.. image-sg:: /auto_examples/3_models/images/sphx_glr_plot_1_gam_reg_004.png
   :alt: Predicted: 0.3839 | Actual: 0.3885
   :srcset: /auto_examples/3_models/images/sphx_glr_plot_1_gam_reg_004.png
   :class: sphx-glr-single-img






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

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

**Estimated memory usage:**  150 MB


.. _sphx_glr_download_auto_examples_3_models_plot_1_gam_reg.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/3_models/plot_1_gam_reg.ipynb
        :alt: Launch binder
        :width: 150 px



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

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

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

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


.. only:: html

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

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