ABX discrimination task in python
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
ABXpy
bin
docs
examples
license
.gitignore
.travis.yml
README.rst
makefile
requirements.txt
setup.py

README.rst

https://travis-ci.org/bootphon/ABXpy.svg?branch=master

ABX discrimination test

ABX discrimination is a term that is used for three stimuli presented on an ABX trial. The third is the focus. The first two stimuli (A and B) are standard, S1 and S2 in a randomly chosen order, and the subjects' task is to choose which of the two is matched by the final stimulus (X). (Glottopedia)

This package contains the operations necessary to initialize, calculate and analyse the results of an ABX discrimination task.

Check out the full documentation at readthedocs.

Organisation

It is composed of 3 main modules and other submodules.

The features can be calculated in numpy via external tools, and made compatible with this package with the h5features module, or directly calculated with one of our tools like the feature_extraction module.

The pipeline

In Module Out
  • data.item
  • parameters
task
  • data.abx
  • data.abx
  • data.features
  • distance
distance
  • data.distance
  • data.abx
  • data.distance
score
  • data.score
  • data.abx
  • data.score
analyse
  • data.csv

See Files Format for a description of the files used as input and output.

The task

According to what you want to study, it is important to characterise the ABX triplets. You can characterise your task along 3 axes: on, across and by a certain label.

An example of ABX triplet:

A B X
on_1 on_2 on_1
ac_1 ac_1 ac_2
by by by

A and X share the same 'on' attribute; A and B share the same 'across' attribute; A,B and X share the same 'by' attribute.

Example of use

See examples/complete_run.sh for a command line run and examples/complete_run.py for a python utilisation.

Installation

The package installation requires cython, and it must be installed by hand for the moment.

pip install cython

or

conda install cython

You can then install the package using pip:

pip install git+https://github.com/bootphon/ABXpy

The module should work with the anaconda distribution of python. However, you may get some (unrelevant) warnings while running task.py.

Run the tests

make test

Generate the documentation

Note that you will get warnings if you don't have the h5features module in your path.

cd docs make html

(you can also generate the doc in several other formats, see the Makefile)

Citation

If you use this software in your research, please cite:
ABX discriminability, Schatz T., Bach F. and Dupoux E., in preparation.