Reference Guide
===============
This guide regroup all the functions and classes that are present in this package.

Package architecture
--------------------
The HIBOU package can be represented as::

    ┌──────────┐   ┌───────────┐          Modules for configuration
    │ utils.py ├─┬─┤ config.py │          and utilities
    └──────────┘ │ └───────────┘
    ─ ─ ─ ─ ─ ─ ─│─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─              
                 │ ┌──────────────────┐   
                 ├─┤ preprocessing.py │   Modules for data
                 │ └──────────────────┘   processing (filtering,
                 │ ┌────────────┐         synchronization and split)
                 ├─┤ filters.py │ 
                 │ └────────────┘
    ─ ─ ─ ─ ─ ─ ─│─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─               
                 │ ┌───────┐                
                 ├─┤ nn.py │              Modules for neural network
                 │ └───────┘              and statistics
                 │ ┌──────────┐
                 └─┤ stats.py │
                   └──────────┘
    ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─    


Modules for configuration and utilities
---------------------------------------
.. toctree::
	:maxdepth: 2
	
	hibou.utils
	hibou.config


Modules for processing data
---------------------------
.. toctree::
	:maxdepth: 2
	
	hibou.preprocessing
	hibou.filters

Modules for neural network
--------------------------
.. toctree::
	:maxdepth: 2
	
	hibou.nn
	hibou.stats