.. _user_guide:

User Guide
==========


This guides provides you with a topical introduction to use onTime. Its aim
is to showcase concrete use case of the library.


.. note::

    This guide is a work in progress. If you have any questions or suggestions, please feel free to contact us.
    

The user guide is divided into several sections:

1. `core` : for all basic features
2. `module` : for all features using core features. E.g. benchmarking, ml preprocessing, etc.
3. `context` : for all features related to the usage of onTime in an applied scenario


Core
----

.. toctree::
    :maxdepth: 1

    0_core/0.1_time-series
    0_core/0.1.1_time-series_data-loading
    0_core/0.1.2_time-series_custom-class
    0_core/0.2_detectors
    0_core/0.3_generators
    0_core/0.4_models
    0_core/0.5_plots
    0_core/0.6-processors

Module
------

.. toctree::
    :maxdepth: 1

    1_module/0-preprocessing/1.0-preprocessing-common

Context
-------

.. toctree::
    :maxdepth: 1

    2_context/2.0-context-common