.. mcfly documentation master file, created by
   sphinx-quickstart on Wed Oct  5 10:42:14 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to mcfly's documentation!
=================================

The goal of mcfly is to ease using deep learning technology for time series classification and regression.
The advantages of deep learning algorithms is that it can handle raw data directly with no need
to compute signal features, it does not require a expert domain knowledge about the data,
and it has been shown to be competitive with conventional machine learning techniques.
As an example, you can apply mcfly on accelerometer data for activity classification,
as shown in the mcfly `tutorial <https://github.com/NLeSC/mcfly-tutorial>`_.

If you use mcfly in your research, please cite the following software paper:

D. van Kuppevelt, C. Meijer, F. Huber, A. van der Ploeg, S. Georgievska, V.T. van Hees. Mcfly: Automated deep learning on time series.
SoftwareX,
Volume 12,
2020.
`doi: 10.1016/j.softx.2020.100548 <https://doi.org/10.1016/j.softx.2020.100548>`_

Contents:

.. toctree::
   :maxdepth: 2

   introduction
   installation
   user_manual
   technical_doc


Reference
==================
.. toctree::
  :maxdepth: 2

  reference

* :ref:`search`