:orphan:

.. _auto_examples:

User guide
==========

Below is a gallery of narrated notebook examples on how and why to use skore.
They serve as our user guide.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>

Getting started
---------------

We recommend starting with these examples that provide an overall and gentle
introduction to skore.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Quick start">

.. only:: html

  .. image:: /auto_examples/getting_started/images/thumb/sphx_glr_plot_quick_start_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_getting_started_plot_quick_start.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Quick start</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Skore: getting started">

.. only:: html

  .. image:: /auto_examples/getting_started/images/thumb/sphx_glr_plot_skore_getting_started_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_getting_started_plot_skore_getting_started.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Skore: getting started</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

End-to-end data science use cases
---------------------------------

These examples showcase skore in action on real use cases.
We aimed at showing skore's ability to:

- be compatible with scikit-learn
- reduce boilerplate code for some standard *de facto* data science analysis
- speed-up exploration by optimizing some internal computation



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to leverage skore for reporting model evaluation and storing the results for further analysis.">

.. only:: html

  .. image:: /auto_examples/use_cases/images/thumb/sphx_glr_plot_employee_salaries_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_use_cases_plot_employee_salaries.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Simplified experiment reporting</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Model evaluation
----------------

These examples illustrate how skore can help data scientists to improve their
machine learning modelling thanks to methodological guidance and diagnostics.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how the skore.EstimatorReport class can be used to quickly get insights from any scikit-learn estimator.">

.. only:: html

  .. image:: /auto_examples/model_evaluation/images/thumb/sphx_glr_plot_estimator_report_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_model_evaluation_plot_estimator_report.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">EstimatorReport: Get insights from any scikit-learn estimator</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates the motivation and the use of skore&#x27;s skore.train_test_split to get assistance when developing ML/DS projects.">

.. only:: html

  .. image:: /auto_examples/model_evaluation/images/thumb/sphx_glr_plot_train_test_split_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_model_evaluation_plot_train_test_split.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">train_test_split: get diagnostics when splitting your data</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Manipulating the skore project
------------------------------

These examples illustrate how to use the skore :class:`~skore.Project` to store many
kinds of objects, along with their past versions.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates how skore can be used to track some items using their history, for example tracking some ML metrics over time.">

.. only:: html

  .. image:: /auto_examples/skore_project/images/thumb/sphx_glr_plot_tracking_items_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_skore_project_plot_tracking_items.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Tracking items</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example provides an overview of the functionalities and the different types of items that we can store in a skore Project.">

.. only:: html

  .. image:: /auto_examples/skore_project/images/thumb/sphx_glr_plot_working_with_projects_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_skore_project_plot_working_with_projects.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Working with projects</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Technical details
-----------------

These examples show some technical details at the core of skore to better understand
some of the mechanics under the hood.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how EstimatorReport and CrossValidationReport use caching to speed up computations.">

.. only:: html

  .. image:: /auto_examples/technical_details/images/thumb/sphx_glr_plot_cache_mechanism_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_technical_details_plot_cache_mechanism.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Cache mechanism</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /auto_examples/getting_started/index.rst
   /auto_examples/use_cases/index.rst
   /auto_examples/model_evaluation/index.rst
   /auto_examples/skore_project/index.rst
   /auto_examples/technical_details/index.rst


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

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

      :download:`Download all examples in Python source code: auto_examples_python.zip </auto_examples/auto_examples_python.zip>`

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

      :download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip </auto_examples/auto_examples_jupyter.zip>`


.. only:: html

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

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