:orphan:

.. _examples:

========
Examples
========

Practical examples for using *auto-sklearn*.



.. raw:: html

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


.. raw:: html

    </div>


==============
Basic Examples
==============

Examples for basic classification, regression, multi-output regression, and multi-label classification datasets.



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The following example shows how to fit a simple classification model with *auto-sklearn*.">

.. only:: html

  .. image:: /examples/20_basic/images/thumb/sphx_glr_example_classification_thumb.png
    :alt: Classification

  :ref:`sphx_glr_examples_20_basic_example_classification.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The following example shows how to fit a multioutput regression model with *auto-sklearn*.">

.. only:: html

  .. image:: /examples/20_basic/images/thumb/sphx_glr_example_multioutput_regression_thumb.png
    :alt: Multi-output Regression

  :ref:`sphx_glr_examples_20_basic_example_multioutput_regression.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Multi-output Regression</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The following example shows how to fit a simple regression model with *auto-sklearn*.">

.. only:: html

  .. image:: /examples/20_basic/images/thumb/sphx_glr_example_regression_thumb.png
    :alt: Regression

  :ref:`sphx_glr_examples_20_basic_example_regression.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This examples shows how to format the targets for a multilabel classification problem. Details ...">

.. only:: html

  .. image:: /examples/20_basic/images/thumb/sphx_glr_example_multilabel_classification_thumb.png
    :alt: Multi-label Classification

  :ref:`sphx_glr_examples_20_basic_example_multilabel_classification.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Multi-label Classification</div>
    </div>


.. raw:: html

    </div>


=================
Advanced Examples
=================

Examples on customizing Auto-sklearn to ones use case by changing the
metric to optimize, the train-validation split, giving feature types,
using pandas dataframes as input and inspecting the results of the search
procedure.



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The following example shows how to inspect the models which *auto-sklearn* optimizes over and h...">

.. only:: html

  .. image:: /examples/40_advanced/images/thumb/sphx_glr_example_interpretable_models_thumb.png
    :alt: Interpretable models

  :ref:`sphx_glr_examples_40_advanced_example_interpretable_models.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Interpretable models</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In *auto-sklearn* it is possible to specify the feature types of a dataset when calling the met...">

.. only:: html

  .. image:: /examples/40_advanced/images/thumb/sphx_glr_example_feature_types_thumb.png
    :alt: Feature Types

  :ref:`sphx_glr_examples_40_advanced_example_feature_types.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Feature Types</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The example below shows how we can use the get_trials_callback parameter of auto-sklearn to imp...">

.. only:: html

  .. image:: /examples/40_advanced/images/thumb/sphx_glr_example_early_stopping_and_callbacks_thumb.png
    :alt: Early stopping and Callbacks

  :ref:`sphx_glr_examples_40_advanced_example_early_stopping_and_callbacks.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Early stopping and Callbacks</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In *Auto-sklearn*, model is optimized over a metric, either built-in or custom metric. Moreover...">

.. only:: html

  .. image:: /examples/40_advanced/images/thumb/sphx_glr_example_calc_multiple_metrics_thumb.png
    :alt: Metrics

  :ref:`sphx_glr_examples_40_advanced_example_calc_multiple_metrics.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The following example shows how to fit *auto-sklearn* to optimize for two competing metrics: pr...">

.. only:: html

  .. image:: /examples/40_advanced/images/thumb/sphx_glr_example_multi_objective_thumb.png
    :alt: Classification

  :ref:`sphx_glr_examples_40_advanced_example_multi_objective.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The following example shows how to fit a simple NLP problem with *auto-sklearn*.">

.. only:: html

  .. image:: /examples/40_advanced/images/thumb/sphx_glr_example_text_preprocessing_thumb.png
    :alt: Text preprocessing

  :ref:`sphx_glr_examples_40_advanced_example_text_preprocessing.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Text preprocessing</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The following example shows how to fit a simple classification model with *auto-sklearn* and us...">

.. only:: html

  .. image:: /examples/40_advanced/images/thumb/sphx_glr_example_inspect_predictions_thumb.png
    :alt: Model Explanation

  :ref:`sphx_glr_examples_40_advanced_example_inspect_predictions.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Model Explanation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="    - ensemble_optimization_score     - ensemble_test_score     - single_best_optimization_scor...">

.. only:: html

  .. image:: /examples/40_advanced/images/thumb/sphx_glr_example_pandas_train_test_thumb.png
    :alt: Performance-over-time plot

  :ref:`sphx_glr_examples_40_advanced_example_pandas_train_test.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Performance-over-time plot</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="*Auto-sklearn* searches for the best combination of machine learning algorithms and their hyper...">

.. only:: html

  .. image:: /examples/40_advanced/images/thumb/sphx_glr_example_single_configuration_thumb.png
    :alt: Fit a single configuration

  :ref:`sphx_glr_examples_40_advanced_example_single_configuration.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Fit a single configuration</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to provide a custom logging configuration to *auto-sklearn*. We will be ...">

.. only:: html

  .. image:: /examples/40_advanced/images/thumb/sphx_glr_example_debug_logging_thumb.png
    :alt: Logging and debugging

  :ref:`sphx_glr_examples_40_advanced_example_debug_logging.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Logging and debugging</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In *auto-sklearn* it is possible to use different resampling strategies by specifying the argum...">

.. only:: html

  .. image:: /examples/40_advanced/images/thumb/sphx_glr_example_resampling_thumb.png
    :alt: Resampling Strategies

  :ref:`sphx_glr_examples_40_advanced_example_resampling.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Resampling Strategies</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The following example shows how to obtain information from a finished Auto-sklearn run. In part...">

.. only:: html

  .. image:: /examples/40_advanced/images/thumb/sphx_glr_example_get_pipeline_components_thumb.png
    :alt: Obtain run information

  :ref:`sphx_glr_examples_40_advanced_example_get_pipeline_components.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Obtain run information</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="*Auto-sklearn* supports various built-in metrics, which can be found in the metrics section in ...">

.. only:: html

  .. image:: /examples/40_advanced/images/thumb/sphx_glr_example_metrics_thumb.png
    :alt: Metrics

  :ref:`sphx_glr_examples_40_advanced_example_metrics.py`

.. raw:: html

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


.. raw:: html

    </div>


===============
Search Examples
===============

Examples of changing the search procedure of Auto-sklearn.



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="*Auto-sklearn* uses dask.distributed &lt;https://distributed.dask.org/en/latest/index.html&gt;_ for p...">

.. only:: html

  .. image:: /examples/60_search/images/thumb/sphx_glr_example_parallel_n_jobs_thumb.png
    :alt: Parallel Usage  on a single machine

  :ref:`sphx_glr_examples_60_search_example_parallel_n_jobs.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Parallel Usage  on a single machine</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="By default, *auto-sklearn* fits the machine learning models and build their ensembles in parall...">

.. only:: html

  .. image:: /examples/60_search/images/thumb/sphx_glr_example_sequential_thumb.png
    :alt: Sequential Usage

  :ref:`sphx_glr_examples_60_search_example_sequential.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Sequential Usage</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="*Auto-sklearn* uses `dask.distributed &lt;https://distributed.dask.org/en/latest/index.html&gt;`_ for...">

.. only:: html

  .. image:: /examples/60_search/images/thumb/sphx_glr_example_parallel_manual_spawning_cli_thumb.png
    :alt: Parallel Usage: Spawning workers from the command line

  :ref:`sphx_glr_examples_60_search_example_parallel_manual_spawning_cli.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Parallel Usage: Spawning workers from the command line</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A crucial feature of *auto-sklearn* is automatically optimizing the hyperparameters through SMA...">

.. only:: html

  .. image:: /examples/60_search/images/thumb/sphx_glr_example_random_search_thumb.png
    :alt: Random Search

  :ref:`sphx_glr_examples_60_search_example_random_search.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Random Search</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This advanced  example illustrates how to interact with the SMAC callback and get relevant info...">

.. only:: html

  .. image:: /examples/60_search/images/thumb/sphx_glr_example_successive_halving_thumb.png
    :alt: Successive Halving

  :ref:`sphx_glr_examples_60_search_example_successive_halving.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Successive Halving</div>
    </div>


.. raw:: html

    </div>


==================
Extension Examples
==================

Examples of extending Auto-sklearn with custom components.



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The following example demonstrates how to turn off data preprocessing step in auto-skearn.">

.. only:: html

  .. image:: /examples/80_extending/images/thumb/sphx_glr_example_extending_data_preprocessor_thumb.png
    :alt: Extending Auto-Sklearn with Data Preprocessor Component

  :ref:`sphx_glr_examples_80_extending_example_extending_data_preprocessor.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Extending Auto-Sklearn with Data Preprocessor Component</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The following example demonstrates how to create a wrapper around the linear discriminant analy...">

.. only:: html

  .. image:: /examples/80_extending/images/thumb/sphx_glr_example_extending_preprocessor_thumb.png
    :alt: Extending Auto-Sklearn with Preprocessor Component

  :ref:`sphx_glr_examples_80_extending_example_extending_preprocessor.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Extending Auto-Sklearn with Preprocessor Component</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The following example demonstrates how to replace an existing component with a new component, i...">

.. only:: html

  .. image:: /examples/80_extending/images/thumb/sphx_glr_example_restrict_number_of_hyperparameters_thumb.png
    :alt: Restricting the number of hyperparameters for an existing component

  :ref:`sphx_glr_examples_80_extending_example_restrict_number_of_hyperparameters.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Restricting the number of hyperparameters for an existing component</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The following example demonstrates how to create a new regression component for using in auto-s...">

.. only:: html

  .. image:: /examples/80_extending/images/thumb/sphx_glr_example_extending_regression_thumb.png
    :alt: Extending Auto-Sklearn with Regression Component

  :ref:`sphx_glr_examples_80_extending_example_extending_regression.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Extending Auto-Sklearn with Regression Component</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The following example demonstrates how to create a new classification component for using in au...">

.. only:: html

  .. image:: /examples/80_extending/images/thumb/sphx_glr_example_extending_classification_thumb.png
    :alt: Extending Auto-Sklearn with Classification Component

  :ref:`sphx_glr_examples_80_extending_example_extending_classification.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Extending Auto-Sklearn with Classification Component</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:

   /examples/20_basic/index.rst
   /examples/40_advanced/index.rst
   /examples/60_search/index.rst
   /examples/80_extending/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: examples_python.zip </examples/examples_python.zip>`

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

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


.. only:: html

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

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