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

• Utility (hibou.utils)
  • Description
  • License
  • Class
  • Functions
  • Decorator
• Configuration (hibou.config)
  • Description
  • License
  • Class
  • Data

Modules for processing data

• Data preprocessing (hibou.preprocessing)
  • Description
  • License
  • Functions
• Filters (hibou.filters)
  • Description
  • Using a filter
  • Creating a new filter
  • Examples
  • License
  • Class
  • Filters

Modules for neural network

• Artificial Neural Network (hibou.nn)
  • Description
  • License
  • Class
  • Functions
• Statistics (hibou.stats)
  • Description
  • License
  • Functions