.. include:: links.inc
.. julearn documentation master file, created by
   sphinx-quickstart on Thu Oct 29 14:29:33 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to julearn's documentation!
===================================

.. image:: images/julearn_logo_it.png
   :width: 300
   :alt: julearn

julearn is a user-oriented machine-learning library.

At the Applied Machine Learning (`AML`_) group, as part of the Institute of 
Neuroscience and Medicine - Brain and Behaviour (`INM-7`_), we thought that
using ML in research could be simpler.

In the same way as `seaborn`_ provides an abstraction of `matplotlib`_'s
functionality aiming for powerful data visualization with minor coding, we 
built julearn on top of `scikit-learn`_.

This library provides users with the possibility of testing ML models directly
from `pandas`_ dataframes, while keeping the flexibiliy of using
`scikit-learn`_'s models.

You can also check out our `video tutorial`_.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   input
   pipeline
   scoring
   steps
   hyperparameters
   auto_examples/basic/index.rst
   auto_examples/advanced/index.rst
   api
   contributing
   maintaining
   whats_new


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`