Update README.md with data structure description (#2)

- Update README.md with data structure description (faaa0755cac3bce1643192df360dfb7f4cbd98a1)


Co-authored-by: Mateusz Wosik <m-wosik@users.noreply.huggingface.co>

README.md

@@ -8,7 +8,8 @@ language:
 - fr
 - it
 license:
-- mit
+- cc-by-4.0
+- mpl-2.0
 multilinguality:
 - monolingual
 dataset_info:
@@ -25,7 +26,7 @@ dataset_info:
 ---
 
 
-# MOCKS dataset
+# MOCKS: Multilingual Open Custom Keyword Spotting Testset
 
 ## Table of Contents
 - [Table of Contents](#table-of-contents)
@@ -54,11 +55,7 @@ dataset_info:
 
 ## Dataset Description
 
-- **Homepage:**
-- **Repository:**
 - **Paper:**
-- **Leaderboard:**
-- **Point of Contact:**
 
 ### Dataset Summary
 
@@ -72,8 +69,6 @@ MOCKS contains both positive and negative examples selected based on phonetic tr
 
 Please refer to our [paper]() for further details.
 
-[More Information Needed - add link to paper]
-
 ### Supported Tasks and Leaderboards
 
 The MOCKS dataset can be used for Open-Vocabulary Keyword Spotting (OV-KWS) task. It supports two OV-KWS types:
@@ -95,22 +90,75 @@ The MOCKS incorporates 5 languages:
 
 ## Dataset Structure
 
-### Data Instances
-
-[More Information Needed]
+The MOCKS testset is split by language, source dataset and OV-KWS type:
+```
+MOCKS
+│
+└───de
+│   └───MCV
+│   │   └───test
+│   │   │   └───offline
+│   │   │   │   │   all.pair.different.tsv
+│   │   │   │   │   all.pair.positive.tsv
+│   │   │   │   │   all.pair.similar.tsv
+│   │   │   │   │   data.tar.gz
+│   │   │   │   │   subset.pair.different.tsv
+│   │   │   │   │   subset.pair.positive.tsv
+│   │   │   │   │   subset.pair.similar.tsv
+│   │   │   │
+│   │   │   └───online
+│   │   │   │   │   all.pair.different.tsv
+│   │   │   │   │   ...
+│   │   │   │   data.offline.transcription.tsv
+│   │   │   │   data.online.transcription.tsv
+│
+└───en
+│   └───LS-clean
+│   │   └───test
+│   │   │   └───offline
+│   │   │   │   │   all.pair.different.tsv
+│   │   │   │   │   ...
+│   │   │   │   ...
+│   │
+│   └───LS-other
+│   │   └───test
+│   │   │   └───offline
+│   │   │   │   │   all.pair.different.tsv
+│   │   │   │   │   ...
+│   │   │   │   ...
+│   │
+│   └───MCV
+│   │   └───test
+│   │   │   └───offline
+│   │   │   │   │   all.pair.different.tsv
+│   │   │   │   │   ...
+│   │   │   │   ...
+│
+└───...
+```
 
-### Data Fields
+Each split is divided into:
+- positive examples (`all.pair.positive.tsv`) - test examples with true keyword, 5000-8000 keywords in each subset,
+- similar examples (`all.pair.similar.tsv`) - test examples with similar phrases to keyword selected based on phonetic transcription distance,
+- different examples (`all.pair.different.tsv`) - test examples with completaly different prases.
 
-[More Information Needed]
+All those files contain columns separated by tab:
+- `keyword_path` - path to audio containing keyword phrase.
+- `adversary_keyword_path` - path to test audio.
+- `adversary_keyword_timestamp_start` - start time in seconds of phrase of interest for given keyword from `keyword_path`, field only available in **offline** split.
+- `adversary_keyword_timestamp_end` - end time in seconds of phrase of interest for given keyword from `keyword_path`, field only available in **offline** split.
+- `label` - whether the `adversary_keyword_path` contain keyword from `keyword_path` or not (1 - contains keyword, 0 - doesn't contain keyword).
 
-### Data Splits
+Each split also contains subset of whole data with the same field sctructure to allow faster evaluation (`subset.pair.*.tsv`).
 
-The MOCKS testset is split by language, source dataset and OV-KWS type. Each split is divided into:
-- positive examples - test examples with true keyword, 5000-8000 keywords in each subset,
-- similar examples - test examples with similar phrases to keyword selected based on phonetic transcription distance,
-- different examples - test examples with completaly different prases.
+Also, trascriptions are provided for each audio in:
+- `data_offline_transcription.tsv` - transcriptions for **offline** examples and `keyword_path` from **online** scenario,
+- `data_online_transcription.tsv` - transcriptions for adversary, test examples from **online** scenario,
 
-Each split also contains subset of whole data to allow faster evaluation.
+three columns are present within each file:
+- `path_to_keyword`/`path_to_adversary_keyword` - path to audio file,
+- `keyword_transcription`/`adversary_keyword_transcription` - audio transcription,
+- `keyword_phonetic_transcription`/`adversary_keyword_phonetic_transcription` - audio phonetic transcription.
 
 ## Dataset Creation
 
@@ -124,59 +172,9 @@ and 48kHz sampling rate for MCV based testset.
 The offline testset contains additional 0.1 second at the beginning and end of extracted audio sample to mitigate the cut-speech effect.
 The online version contrains additional 1 second or so at the beginning and end of extracted audio sample.
 
-### Curation Rationale
-
-[More Information Needed]
-
-### Source Data
-
-#### Initial Data Collection and Normalization
-
-[More Information Needed]
-
-#### Who are the source language producers?
-
-[More Information Needed]
-
-### Annotations
-
-#### Annotation process
-
-[More Information Needed]
-
-#### Who are the annotators?
-
-[More Information Needed]
-
-### Personal and Sensitive Information
+The MOCKS testset is gender balanced.
 
-[More Information Needed]
-
-## Considerations for Using the Data
-
-### Social Impact of Dataset
-
-[More Information Needed]
-
-### Discussion of Biases
-
-The MOCKS testset is speaker gender balanced.
-
-### Other Known Limitations
-
-[More Information Needed]
-
-## Additional Information
-
-### Dataset Curators
-
-[More Information Needed]
-
-### Licensing Information
-
-[More Information Needed]
-
-### Citation Information
+## Citation Information
 
 ```bibtex
 @inproceedings{pudo23_interspeech,
@@ -185,8 +183,4 @@ The MOCKS testset is speaker gender balanced.
   year={in press.},
   booktitle={Proc. Interspeech 2023},
 }
-```
-
-### Contributions
-
-Thanks to [@github-username](https://github.com/<github-username>) for adding this dataset.
+```