:orphan:

.. _examples:

Examples
========
Examples that show how to work with custom datasets and pipelines


.. raw:: html

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


.. raw:: html

    </div>


Datasets
--------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Datasets represent a set of recordings that should all be processed in the same way. For exampl...">

.. only:: html

  .. image:: /auto_examples/datasets/images/thumb/sphx_glr__01_datasets_basics_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_datasets__01_datasets_basics.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Custom Dataset - Basics</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="To better understand how you would actually use tpcp datasets, we are going to build a dataset ...">

.. only:: html

  .. image:: /auto_examples/datasets/images/thumb/sphx_glr__02_datasets_real_world_example_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_datasets__02_datasets_real_world_example.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Custom Dataset - A real world example</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is the final ECG Example dataset, that we developed step by step in the example custom_dat...">

.. only:: html

  .. image:: /auto_examples/datasets/images/thumb/sphx_glr_datasets_final_ecg_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_datasets_datasets_final_ecg.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">The final ECG Example dataset</div>
    </div>


.. raw:: html

    </div>


Algorithms
----------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example we will implement a custom algorithm and discuss, when you might want to use an...">

.. only:: html

  .. image:: /auto_examples/algorithms/images/thumb/sphx_glr__01_algorithms_qrs_detection_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_algorithms__01_algorithms_qrs_detection.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Algorithms - A real world example: QRS-Detection</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="These are the QRS detection algorithms, that we developed step by step custom_algorithms_qrs_de...">

.. only:: html

  .. image:: /auto_examples/algorithms/images/thumb/sphx_glr_algorithms_qrs_detection_final_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_algorithms_algorithms_qrs_detection_final.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">The final QRS detection algorithms</div>
    </div>


.. raw:: html

    </div>


Parameter Optimization
----------------------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In case no better way exists to optimize a parameter of a algorithm or pipeline an exhaustive G...">

.. only:: html

  .. image:: /auto_examples/parameter_optimization/images/thumb/sphx_glr__01_gridsearch_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_parameter_optimization__01_gridsearch.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Grid Search optimal Algorithm Parameter</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Some algorithms can actively be &quot;trained&quot; to improve their performance or adapt it to a certain...">

.. only:: html

  .. image:: /auto_examples/parameter_optimization/images/thumb/sphx_glr__02_optimizable_pipelines_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_parameter_optimization__02_optimizable_pipelines.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="When trying to optimize parameters for algorithms that have trainable components, it is require...">

.. only:: html

  .. image:: /auto_examples/parameter_optimization/images/thumb/sphx_glr__03_gridsearch_cv_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_parameter_optimization__03_gridsearch_cv.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The most popular method of (hyper-)parameter optimization is GridSearch (or GridSearchCV for op...">

.. only:: html

  .. image:: /auto_examples/parameter_optimization/images/thumb/sphx_glr__04_custom_optuna_optimizer_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_parameter_optimization__04_custom_optuna_optimizer.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Custom Optuna Optimizer</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="However, there are still a number of problems that can be solved by a relative generic GridSear...">

.. only:: html

  .. image:: /auto_examples/parameter_optimization/images/thumb/sphx_glr__05_optuna_search_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_parameter_optimization__05_optuna_search.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Build-in Optuna Optimizers</div>
    </div>


.. raw:: html

    </div>


Validation
----------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Whenever using some sort of algorithm that has fixed parameters already, for example from previ...">

.. only:: html

  .. image:: /auto_examples/validation/images/thumb/sphx_glr__01_validation_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_validation__01_validation.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Whenever using some sort of trainable algorithm it is important to clearly separate the trainin...">

.. only:: html

  .. image:: /auto_examples/validation/images/thumb/sphx_glr__02_cross_validation_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_validation__02_cross_validation.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Scorer or scoring functions are used in tpcp whenever we need to rank any form of output. For e...">

.. only:: html

  .. image:: /auto_examples/validation/images/thumb/sphx_glr__03_custom_scorer_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_validation__03_custom_scorer.py`

.. raw:: html

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


.. raw:: html

    </div>


Framework Integrations
----------------------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Theoretically, tpcp is framework agnostic and can be used with any framework. However, due to t...">

.. only:: html

  .. image:: /auto_examples/integrations/images/thumb/sphx_glr__01_tensorflow_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_integrations__01_tensorflow.py`

.. raw:: html

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


.. raw:: html

    </div>


Advanced Recipies
-----------------



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="With the way tpcp Datasets and Algorithms are structured, we encourage users to build out their...">

.. only:: html

  .. image:: /auto_examples/recipies/images/thumb/sphx_glr__01_caching_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_recipies__01_caching.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="When using tpcp you have to write a lot of classes with a lot of parameters. For each class you...">

.. only:: html

  .. image:: /auto_examples/recipies/images/thumb/sphx_glr__02_dataclasses_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_recipies__02_dataclasses.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Dataclass and Attrs support</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Sometimes a pipeline or algorithms requires a list of parameters or nested objects. As we can n...">

.. only:: html

  .. image:: /auto_examples/recipies/images/thumb/sphx_glr__03_composite_objects_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_recipies__03_composite_objects.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Composite-Algorithms and Pipelines</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use the TypedIterator class, which might be helpful, when iterating o...">

.. only:: html

  .. image:: /auto_examples/recipies/images/thumb/sphx_glr__04_typed_iterator_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_recipies__04_typed_iterator.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Tpcp is focused on &quot;running&quot; pipelines and less on the &quot;optimization&quot; step. This is great for t...">

.. only:: html

  .. image:: /auto_examples/recipies/images/thumb/sphx_glr__05_optimization_info_thumb.png
    :alt:

  :ref:`sphx_glr_auto_examples_recipies__05_optimization_info.py`

.. raw:: html

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


.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /./auto_examples/datasets/index.rst
   /./auto_examples/algorithms/index.rst
   /./auto_examples/parameter_optimization/index.rst
   /./auto_examples/validation/index.rst
   /./auto_examples/integrations/index.rst
   /./auto_examples/recipies/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>`_