HMP Documentation

Outline of the documentation:

Welcome

• Welcome

Quickstart

• Quickstart

Installation

• Installation Guide
  • Step 1: Python Installation
  • Step 2: Install PIP
  • Step 3: Install hmp
  • Step 4: Verifying Installation

Demo

• Tutorials and Demos
  • 1. How HMP works: practical, methodological and theoretical grounds
  • 2. The different model classes
  • 3. Applying HMP to real data
  • 4. Advanced - grouping models
  • Reading your own data

API

• API
  • Models
  • Transformer module
  • Input/output module
  • Distributions module
  • Patterns module
  • TrialData module
  • Visualization module
  • Utils module
  • Simulations module

Indices and tables

• Index