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


Reliability: Regression
=====================================

.. GENERATED FROM PYTHON SOURCE LINES 8-9

Experiment initialization and data preparation

.. GENERATED FROM PYTHON SOURCE LINES 9-17

.. 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 18-19

Train Model

.. GENERATED FROM PYTHON SOURCE LINES 19-21

.. code-block:: default

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








.. GENERATED FROM PYTHON SOURCE LINES 22-23

Show empirical coverage and average bandwidth for regression tasks

.. GENERATED FROM PYTHON SOURCE LINES 23-26

.. code-block:: default

    results = exp.model_diagnose(model="XGB2", show="reliability_table", alpha=0.1, return_data=True)
    results.data





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

 .. code-block:: none

      Empirical Coverage Average Bandwidth
    0             0.9014            0.2231


.. 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>Empirical Coverage</th>
          <th>Average Bandwidth</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>0.9014</td>
          <td>0.2231</td>
        </tr>
      </tbody>
    </table>
    </div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 27-28

Calculate distribution shift distance of each feature between reliable and un-reliable data

.. GENERATED FROM PYTHON SOURCE LINES 28-31

.. code-block:: default

    exp.model_diagnose(model="XGB2", show="reliability_distance", alpha=0.1,
                       threshold=1.1, distance_metric="PSI", figsize=(5, 4))




.. image-sg:: /auto_examples/4_testing/images/sphx_glr_plot_3_reliability_reg_001.png
   :alt: Distribution Shift: Unreliable vs. Remaining Regions
   :srcset: /auto_examples/4_testing/images/sphx_glr_plot_3_reliability_reg_001.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 32-33

Plot the histogram of bandwidth against a given feature

.. GENERATED FROM PYTHON SOURCE LINES 33-36

.. code-block:: default

    exp.model_diagnose(model="XGB2", show="reliability_marginal", alpha=0.1,
                       show_feature="hr", bins=10, threshold=1.1,
                       original_scale=True, figsize=(5, 4))



.. image-sg:: /auto_examples/4_testing/images/sphx_glr_plot_3_reliability_reg_002.png
   :alt: Segmented Bandwidth
   :srcset: /auto_examples/4_testing/images/sphx_glr_plot_3_reliability_reg_002.png
   :class: sphx-glr-single-img






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

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

**Estimated memory usage:**  32 MB


.. _sphx_glr_download_auto_examples_4_testing_plot_3_reliability_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_3_reliability_reg.ipynb
        :alt: Launch binder
        :width: 150 px



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

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

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

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


.. only:: html

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

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