HDDM is a python module that implements Hierarchical Bayesian estimation of Drift Diffusion Models.
Project description
- Contact:
- thomas_wiecki@brown.edu, imri_sofer@brown.edu, michael_frank@brown.edu
- Web site:
- Github:
- Mailing list:
- Copyright:
- This document has been placed in the public domain.
- License:
HDDM is released under the BSD 2 license.
- Version:
- 0.5.1.dev
Purpose
HDDM is a python toolbox for hierarchical Bayesian parameter estimation of the Drift Diffusion Model (via PyMC). Drift Diffusion Models are used widely in psychology and cognitive neuroscience to study decision making.
Features
Uses hierarchical Bayesian estimation (via PyMC) of DDM parameters to allow simultaneous estimation of subject and group parameters, where individual subjects are assumed to be drawn from a group distribution. HDDM should thus produce better estimates when less RT values are measured compared to other methods using maximum likelihood for individual subjects (i.e. DMAT or fast-dm).
Heavily optimized likelihood functions for speed (Navarro & Fuss, 2009).
Flexible creation of complex models tailored to specific hypotheses (e.g. estimation of separate drift-rates for different task conditions; or predicted changes in model parameters as a function of other indicators like brain activity).
Estimate trial-by-trial correlations between a brain measure (e.g. fMRI BOLD) and a diffusion model parameter using the HDDMRegression model.
Built-in Bayesian hypothesis testing and several convergence and goodness-of-fit diagnostics.
Quick-start
The following is a minimal python script to load data, run a model and examine its parameters and fit.
import hddm
# Load data from csv file into a NumPy structured array
data = hddm.load_csv('simple_difficulty.csv')
# Create a HDDM model multi object
model = hddm.HDDM(data, depends_on={'v':'difficulty'})
# Create model and start MCMC sampling
model.sample(2000, burn=20)
# Print fitted parameters and other model statistics
model.print_stats()
# Plot posterior distributions and theoretical RT distributions
model.plot_posteriors()
model.plot_posterior_predictive()
For more information about the software and theories behind it, please see the main publication.
Installation
Windows
The easiest way is to download and install Anaconda.
Then install pymc, kabuki and HDDM:
- ::
pip install pymc pip install kabuki pip install hddm
Linux (Debian based, such as Ubuntu)
Most of HDDM’s dependencies are available from your repository, you can install them by typing
apt-get install python python-dev python-numpy python-scipy python-matplotlib cython python-pip gfortran liblapack-dev
which requires sudo rights.
Optional dependencies for hddm_demo.py can be installed via
apt-get install python-wxgtk2.8 python-traitsui
Then install kabuki and HDDM:
sudo pip install pandas sudo pip install pymc sudo pip install kabuki sudo pip install hddm
OSX
We recommend installing the SciPy Superpack maintained by Chris Fonnesbeck.
The Superpack requires you to install XCode which apparently does not bundle with gcc anymore (which is required by HDDM). This repository provides some appropriate installers:
https://github.com/kennethreitz/osx-gcc-installer/downloads
Then install kabuki and HDDM:
sudo pip install kabuki sudo pip install hddm
How to cite
If HDDM was used in your research, please cite the publication (link to pdf):
Wiecki TV, Sofer I and Frank MJ (2013). HDDM: Hierarchical Bayesian estimation of the Drift-Diffusion Model in Python. Front. Neuroinform. 7:14. doi: 10.3389/fninf.2013.00014
Getting started
Check out the tutorial on how to get started. Further information can be found in howto and the documentation.
Join our low-traffic mailing list.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file HDDM-0.5.2.beta.tar.gz.
File metadata
- Download URL: HDDM-0.5.2.beta.tar.gz
- Upload date:
- Size: 564.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | af6a60c152ceb72196d9654b73b1098154349ccef45f6b3114821cd9edb71636 |
|
| MD5 | 80a6d5b5b869c646f48a021ffcca7dea |
|
| BLAKE2b-256 | 5563e6dc4b3bed8e76671ad24225c7deffbe318968eff8b4a60e7e6e6bd7326d |
