API reference#
This reference documents every public class and function in cpm, one page per object. To learn how the pieces fit together, start with the Tutorials.
Generators
Parameters, priors, model wrappers and simulators: the building blocks of every model.
Models
Learning rules, decision rules, activation and attention functions.
Optimisation
Optimisers, objective functions and model comparison.
Hierarchical
Hierarchical estimation with empirical and variational Bayes.
Applications
Ready-made models for reinforcement learning, decision making and metacognition.
BrainExplorer
Descriptive statistics and exclusion criteria for the BrainExplorer games.
Datasets
Example datasets used in the tutorials and examples.
Utilities
Helpers to convert data for the ready-made models.