Skip to content

Evaluation of ChoCo

Jump to bottom
Jàcopo edited this page Aug 25, 2022 · 7 revisions

JAMS-Test: a framework for test-driven evaluation

Evaluation of the JAMification process

The goal of the first validation step is to assess the quality and the expressivity of the JAMS files resulting from the JAMification process of ChoCo's partitions. Please, refer to choco/jams_test.py to create test data and run the final evaluation.

Testing scripts for the JAMification of ChoCo partitions.

positional arguments:
  {create,merge,test}   Either `create` for generating the test samples or `test` for running the JAMS-based tests.
  partition_dir         Path to the directory of the ChoCo partition in which the "meta.csv" file can be found.
  {audio,score}         Type of music content in the collection.

optional arguments:
  -h, --help            show this help message and exit
  --skip_silver         Whether to detect and skip silver JAMS files.
  --n_samples N_SAMPLES
                        Number of test samples to draw from the partition, create the test metadata, and skim the JAMS.
  --keep_n KEEP_N       Number of chord/key observations per annotation that will be retained for the evaluation.
  --seed SEED           A random seed for reproducible sampling.
  --debug               Whether to enable debugging logs.

Step 1: Create a test set for the partition

The first thing to do is to create a test set of silver JAMS files that will be manually edited, extended, revised, and eventually enriched by human annotators. For a single partition, say isophonics, the following script generates a test set of 4 samples where only the first 5 observations are retained per chord/key annotation.

cd choco
python jams_tests.py create ../partitions/isophonics/choco/ audio --n_samples 4 --keep_n 5 --seed 1234

Step 2: Run the evaluation with JAMS-Test

Once you have manually annotated/revised the silver JAMS, thereby producing gold JAMS, it is time to measure the quality of the estimated JAMS files (in ChoCo, the output of the JAMification process). This is done by comparing the latter against the gold standard, with respect to specific sections/layer (this is fairly documented in this issue). To run the evaluation, you only need to provide the path to the specific ChoCo partition to validate: which is expected to contain a test folder with the gold JAMS. Please, note that, if the test folder still contains the silver JAMS from the previous step, these can be safely ignored with the --skip_silver option.

cd choco
python jams_test.py test ../tests/data/dummy-score-partition/ score --skip_silver

Details: how gold JAMS were obtained

This section contains information on how to validate JAMS files produced by JAMification process of ChoCo.The validation consists of checking the correctness of annotations automatically converted into a standardised format (JAMS). More specifically, validation consists of comparing the annotations contained in the JAMS file (automatically generated) with the original annotation files. Generally, each dataset originally contains annotations in a different formats.

Validation will take place on two levels:

  • preliminary_test: a small number of tracks is assigned to each validator. The purpose of this validation phase is to assign a confidence score to the annotator, based on the accuracy of the test annotations produced;
  • validation: the ChoCo datasets will be divided equally between the annotators and multiple tracks per dataset will be assigned to each annotator.

Validation Guidelines

The annotations to be validated are assigned to validators in a csv file called validator_map.csv. This file has the following structure:

dataset_name dataset_type validator perliminary_test
Isophonics audio validator_name True

The fields are described as follows:

  • dataset_name: the dataset that needs to be validated;
  • dataset_type: the type of the chord annotations contained in the dataset, which can be either score or audio;
  • validator: the person who will take care of the validation of the dataset;
  • preliminary_test: boolean that indicates whether the dataset is part of the preliminary validation or not.

What to validate?

There are several fields that need to be checked in the validation process, which can be grouped into the following categories:

  • file metadata: the metadata of the file being analyzed, which include the title the composer, the artist, etc. This information is contained in the file_metadata and in the sandbox section of the JAMS files;
  • annotations: general category that contains annotations related to the song. Specifically within this section it is important to validate:
    • annotation metadata: metadata related to the annotation and the annotator;
    • chord observations: chord annotations, including timing information. For each observation, it is therefore essential to validate both the accuracy of the chord itself, its duration and its starting time;
    • key annotations: annotations about the song's key, including temporal indications. For each key annotation, it is therefore essential to validate both the accuracy of the key label, its duration and its starting time.

There can be two main types of annotations contained in a JAMS file:

  1. Audio annotations: contain time information expressed in real time (seconds);
  2. Score annotations: contain time expressed symbolically. In particular, timing information is expressed through the convention beasure.beat while duration is expressed in quarter_beat.

You can get more information regarding these conventions and the structure of the JAMS files in the Wiki section of the ChoCo repository, at this link.

In order to make validation faster and simpler, the JAMS files have been further simplified, as documented here, in order to reduce the number of chords to be validated and consequently the complexity of the files. Each file was in fact simplified using one of the following strategies:

  • last_n: only the last n chords are taken into account;
  • first_n: only the first n chords are considered.

Within the partitions/partition_name/test folder, files simplified according to the aforementioned strategies (i.e. first_n or last_n) have already been generated.
In the same folder, you can also find the file test_meta.csv, which contains information concerning the creation of the validation files, such as the simplification strategy used, their name, and the path of both the original file and the file to be validated.

Instructions for Validators

The validation process should be organised as follows:

  1. fork the ChoCo repository, by clicking on the fork button on the top right of the repository page

  2. clone the forked repository:

git clone <link_to_your_repository>
  1. enter the repository:
cd choco
  1. switch to the 'validation' branch via:
git switch validation
  1. check in the validator_map file which dataset has been associated with you
  2. look for the JAMS files to validate in the partitions/dataset_name/test folder
  3. duplicate each file by adding your name to the file name, e.g., isophonics_73_silver.jams will become isophonics_3_silver_yourname.jams
  4. for each file in the validation folder of the assigned dataset, look for the corresponding original file that is mapped to the meta.csv file, that can be found in the partitions/dataset_name/choco folder
  5. validate the JAMS against the original files, taking into account the simplification strategy used for each file, which can be found in partitions/dataset_name/test/test_meta.csv
  6. edit the renamed file (isophonics_3_silver_yourname.jams from the example at point 2.) by fixing any errors and/or inaccuracies
  7. once a validation step is finished (i.e. both the preliminary_validation and final_validation levels, see above), open a pull request on the validation branch of the ChoCo repository.

Music expert evaluation of conversions (S2)

To generate more readable annotations for evaluating the output of the chord conversion rules, you can use the following command. This will merge the original and the converted JAMS, and the resulting annotation will be flattened in a CSV file in 'flattened/'.

cd choco
python jams_test.py merge ../partitions/when-in-rome/choco score
Clone this wiki locally