kelhad00 / cba-toolkit

The Conversation Behavior Analysis toolkit aims at offering the means for analyzing phenomena occurring in conversations such as mimicry, overlapping expressions, expressions timing, etc.

CBA

The Conversation Behavior Analysis toolkit aims at offering the means for analyzing phenomena occurring in conversations such as mimicry, overlapping expressions, expressions timing, etc.

Content

• [annotations]: contains ELAN Template Files (etf) for annotation to use in your own projects.
• [app]: contains the needed files to display the Non Verbal Expressions and ML statistics done in the corresponding folders in an interactive web page.
• [data]: contains the data used for the statistics and machine learning parts of the project. This folder is not included in the repository, it will be created thanks to the MainPage of the Streamlit interface with your database of choice.
• [IBPY]: submodule containing all the utils functions needed to extract data from the database.
• [src]: contains all functions we need to process data from our datasets for the machine learning part and all extraction and vizualisation functions related to the statistics of expressions in our datasets. This also creates the custom json according to the contents of the data folder.
• pair_data.py : example code

Installation

To install the toolkit, clone the repository and install the dependencies with the following command:

pip install -r requirements.txt

You also should install the IBPY submodule with the following command:

git submodule sync

How to run the code

To launch the application, run the following command from the terminal:

cd Dash
python app.py

IMPORTANT

For the proper functioning of this toolbox, it is necessary to implement your different datasets with annotated files in EAF format under the same template. You will be asked to provide them to the interface in zip format, one folder at a time.

If your eaf files do not follow the naming convention "A_number_..." & "B_number_..." for each interaction, you are asked to create in the "db.py" script or in the MainPage:

• a function to return a list of files in pairs according to the way of naming them defined such as: form_pairs_foldername.

Rely on the already existing functions on this subject such as "form_pairs_ab".

Examples

To print corresponding pairs of interlocutors in the ccdb, ifadv or ndc datasets, run the following from the examples directory:

To print pairs from CCDB, IFADV or NDC-ME.

python pair_data.py --path_ccdb <path to the CCDB audio, video or eaf files>
python pair_data.py --path_ifadv <path to the IFADV audio, video or eaf files>
python pair_data.py --path_ndc <path to the NDC-ME audio, video or eaf files>