Skip to content

Commit d5eed25

Browse files
author
LegrandNico
committed
docs
1 parent 9f56f77 commit d5eed25

12 files changed

+178
-114
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<img src="https://github.com/embodied-computation-group/metadpy/raw/master/docs/source/images/logo.png" align="left" alt="metadpy" height="250" HSPACE=30>
66

7-
**metadpy** is a Python implementation of standard Bayesian models of behavioural metacognition. It is aimed to provide simple yet powerful functions to compute standard indexes and metrics of signal detection theory (SDT) and metacognitive efficiency (meta-d’ and hierarchical meta-d’) [**1**, **2**, **3**]. The only input required is a data frame encoding task performances and confidence ratings at the trial level.
7+
**metadpy** is a Python implementation of standard Bayesian models of behavioural metacognition. It is aimed to provide simple yet powerful functions to compute standard indexes and metrics of signal detection theory (SDT) and metacognitive efficiency (meta-d’ and hierarchical meta-d’). The only input required is a data frame encoding task performances and confidence ratings at the trial level.
88

99
**metadpy** is written in Python 3. It uses [Numpy](https://numpy.org/), [Scipy](https://www.scipy.org/) and [Pandas](https://pandas.pydata.org/>) for most of its operation, comprizing meta-d’ estimation using maximum likelihood estimation (MLE). The (Hierarchical) Bayesian modelling is implemented in [Aesara](https://github.com/aesara-devs/aesara) (now renamed [PyTensor](https://github.com/pymc-devs/pytensor) for versions of [pymc](https://docs.pymc.io/>) >=5.0).
1010

docs/source/examples/1-What metacognition looks like.ipynb

Lines changed: 9 additions & 2 deletions
Large diffs are not rendered by default.

docs/source/examples/1-What metacognition looks like.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,3 +123,7 @@ You can see in this figure that a higher task performance (d') results in a bigg
123123
```{admonition} Exercise 2
124124
Change any of the parameters above and re-run this section to get an idea as to how each parameter may change the observed confidence scores.
125125
```
126+
127+
```{code-cell} ipython3
128+
129+
```

docs/source/examples/2-Fitting the model-MLE.ipynb

Lines changed: 14 additions & 7 deletions
Large diffs are not rendered by default.

docs/source/examples/2-Fitting the model-MLE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,3 +275,7 @@ Here we can see that there is some variance in the model fits for each value of
275275
```{Exercise 5}
276276
Drop the trial numbers (Ntrials) per simulation down to just 100, and re-run the simulation and recovery procedure you just performed. What happens to the recovered values of meta-d with lower numbers of trials per subject? Do you think this may or may not be a problem? Feel free to try other trial numbers if you are interested.
277277
```
278+
279+
```{code-cell} ipython3
280+
281+
```

docs/source/examples/3-Comparison with the hmeta-d toolbox.ipynb

Lines changed: 33 additions & 11 deletions
Large diffs are not rendered by default.

docs/source/examples/Example 1 - Fitting MLE - Subject and group level.ipynb

Lines changed: 8 additions & 9 deletions
Large diffs are not rendered by default.

docs/source/examples/Example 1 - Fitting MLE - Subject and group level.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ kernelspec:
1515
+++ {"id": "copyrighted-border"}
1616

1717
(example_1)=
18-
Author: Nicolas Legrand <nicolas.legrand@cfin.au.dk>
18+
Author: Nicolas Legrand <nicolas.legrand@cfin.au.dk>
1919

2020
```{code-cell} ipython3
2121
:id: unavailable-groove
@@ -211,7 +211,7 @@ sns.despine()
211211

212212
```{code-cell} ipython3
213213
%load_ext watermark
214-
%watermark -n -u -v -iv -w -p metadpy,jax,numpyro,pymc
214+
%watermark -n -u -v -iv -w -p metadpy,pytensor,pymc
215215
```
216216

217217
```{code-cell} ipython3

docs/source/examples/Example 2 - Fitting Bayesian - Subject level (pymc).ipynb

Lines changed: 100 additions & 78 deletions
Large diffs are not rendered by default.

docs/source/examples/Example 2 - Fitting Bayesian - Subject level (pymc).md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ from metadpy.bayesian import hmetad
3232
+++ {"id": "operating-aerospace"}
3333

3434
## From response-signal arrays
35-
### Using pymc
3635

3736
```{code-cell} ipython3
3837
:id: worldwide-utility
@@ -83,7 +82,7 @@ az.summary(traces, var_names=["c1", "d1", "meta_d", "cS1", "cS2"])
8382

8483
```{code-cell} ipython3
8584
%load_ext watermark
86-
%watermark -n -u -v -iv -w -p metadpy,pymc
85+
%watermark -n -u -v -iv -w -p metadpy,pytensor,pymc
8786
```
8887

8988
```{code-cell} ipython3

0 commit comments

Comments
 (0)