.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples\4_testing\plot_2_overfit_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_4_testing_plot_2_overfit_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_4_testing_plot_2_overfit_reg.py:


Overfit: Regression
=====================================

.. 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-21

.. code-block:: default

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







.. GENERATED FROM PYTHON SOURCE LINES 22-23

Histogram-based overfit test for a single feature

.. GENERATED FROM PYTHON SOURCE LINES 23-27

.. code-block:: default

    results = exp.model_diagnose(model="XGB2", show="overfit", slice_method="histogram", 
                                 slice_features=["hr"], threshold=1.05, min_samples=100,
                                 return_data=True, figsize=(5, 4))
    results.data



.. image-sg:: /auto_examples/4_testing/images/sphx_glr_plot_2_overfit_reg_001.png
   :alt: Overfit Regions
   :srcset: /auto_examples/4_testing/images/sphx_glr_plot_2_overfit_reg_001.png
   :class: sphx-glr-single-img



.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>
    <style scoped>
        .dataframe tbody tr th:only-of-type {
            vertical-align: middle;
        }

        .dataframe tbody tr th {
            vertical-align: top;
        }

        .dataframe thead th {
            text-align: right;
        }
    </style>
    <table border="1" class="dataframe">
      <thead>
        <tr style="text-align: right;">
          <th></th>
          <th>[hr</th>
          <th>hr)</th>
          <th>#Test</th>
          <th>#Train</th>
          <th>test_MSE</th>
          <th>train_MSE</th>
          <th>Gap</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>0.3</td>
          <td>0.4</td>
          <td>445</td>
          <td>1736</td>
          <td>0.0219</td>
          <td>0.0197</td>
          <td>0.0022</td>
        </tr>
        <tr>
          <th>1</th>
          <td>0.6</td>
          <td>0.7</td>
          <td>445</td>
          <td>1743</td>
          <td>0.0103</td>
          <td>0.0096</td>
          <td>0.0008</td>
        </tr>
        <tr>
          <th>2</th>
          <td>0.8</td>
          <td>0.9</td>
          <td>285</td>
          <td>1171</td>
          <td>0.0081</td>
          <td>0.0075</td>
          <td>0.0006</td>
        </tr>
      </tbody>
    </table>
    </div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 28-29

Histogram-based overfit test for two features

.. GENERATED FROM PYTHON SOURCE LINES 29-33

.. code-block:: default

    results = exp.model_diagnose(model="XGB2", show="overfit", slice_method="histogram", 
                                 slice_features=["hr", "atemp"], threshold=1.05, min_samples=100,
                                 return_data=True, figsize=(5, 4))
    results.data



.. image-sg:: /auto_examples/4_testing/images/sphx_glr_plot_2_overfit_reg_002.png
   :alt: Overfit Regions
   :srcset: /auto_examples/4_testing/images/sphx_glr_plot_2_overfit_reg_002.png
   :class: sphx-glr-single-img



.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>
    <style scoped>
        .dataframe tbody tr th:only-of-type {
            vertical-align: middle;
        }

        .dataframe tbody tr th {
            vertical-align: top;
        }

        .dataframe thead th {
            text-align: right;
        }
    </style>
    <table border="1" class="dataframe">
      <thead>
        <tr style="text-align: right;">
          <th></th>
          <th>[hr</th>
          <th>hr)</th>
          <th>[atemp</th>
          <th>atemp)</th>
          <th>#Test</th>
          <th>#Train</th>
          <th>test_MSE</th>
          <th>train_MSE</th>
          <th>Gap</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>0.7</td>
          <td>0.8</td>
          <td>0.5000</td>
          <td>0.6636</td>
          <td>103</td>
          <td>366</td>
          <td>0.0421</td>
          <td>0.0350</td>
          <td>0.0071</td>
        </tr>
        <tr>
          <th>1</th>
          <td>0.3</td>
          <td>0.4</td>
          <td>0.2318</td>
          <td>0.4636</td>
          <td>173</td>
          <td>645</td>
          <td>0.0250</td>
          <td>0.0198</td>
          <td>0.0052</td>
        </tr>
        <tr>
          <th>2</th>
          <td>0.6</td>
          <td>0.7</td>
          <td>0.1364</td>
          <td>0.5606</td>
          <td>240</td>
          <td>882</td>
          <td>0.0095</td>
          <td>0.0078</td>
          <td>0.0017</td>
        </tr>
        <tr>
          <th>3</th>
          <td>0.0</td>
          <td>0.1</td>
          <td>0.2546</td>
          <td>0.3940</td>
          <td>105</td>
          <td>432</td>
          <td>0.0020</td>
          <td>0.0011</td>
          <td>0.0009</td>
        </tr>
      </tbody>
    </table>
    </div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 34-35

Histogram-based overfit test for a single feature using MAE metric

.. GENERATED FROM PYTHON SOURCE LINES 35-39

.. code-block:: default

    results = exp.model_diagnose(model="XGB2", show="overfit", slice_method="histogram", 
                                 slice_features=["atemp"], threshold=1.05, min_samples=100,
                                 metric="MAE", return_data=True, figsize=(5, 4))
    results.data



.. image-sg:: /auto_examples/4_testing/images/sphx_glr_plot_2_overfit_reg_003.png
   :alt: Overfit Regions
   :srcset: /auto_examples/4_testing/images/sphx_glr_plot_2_overfit_reg_003.png
   :class: sphx-glr-single-img



.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>
    <style scoped>
        .dataframe tbody tr th:only-of-type {
            vertical-align: middle;
        }

        .dataframe tbody tr th {
            vertical-align: top;
        }

        .dataframe thead th {
            text-align: right;
        }
    </style>
    <table border="1" class="dataframe">
      <thead>
        <tr style="text-align: right;">
          <th></th>
          <th>[atemp</th>
          <th>atemp)</th>
          <th>#Test</th>
          <th>#Train</th>
          <th>test_MAE</th>
          <th>train_MAE</th>
          <th>Gap</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>0.197</td>
          <td>0.4924</td>
          <td>1649</td>
          <td>6580</td>
          <td>0.0639</td>
          <td>0.0589</td>
          <td>0.005</td>
        </tr>
      </tbody>
    </table>
    </div>
    </div>
    <br />
    <br />


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

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

**Estimated memory usage:**  31 MB


.. _sphx_glr_download_auto_examples_4_testing_plot_2_overfit_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/4_testing/plot_2_overfit_reg.ipynb
        :alt: Launch binder
        :width: 150 px



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

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

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

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


.. only:: html

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

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