Update README.md after loading script refactoring

README.md

@@ -160,6 +160,60 @@ three columns are present within each file:
 - `keyword_transcription`/`adversary_keyword_transcription` - audio transcription,
 - `keyword_phonetic_transcription`/`adversary_keyword_phonetic_transcription` - audio phonetic transcription.
 
+## Using the Dataset
+
+The dataset can be used by:
+- downloading the archive and constructing all the test cases based on the provided `tsv` files,
+- `datasets` package.
+
+In the latter case the following should work:
+```load_dataset(path="voiceintelligenceresearch/MOCKS", name="en.LS-clean", split="offline")```
+
+The allowed values for `name` are:
+- `en.LS-{clean,other}`,
+- `en.LS-{clean,other}.positive`,
+- `en.LS-{clean,other}.similar`,
+- `en.LS-{clean,other}.different`,
+- `en.LS-{clean,other}.subset`,
+- `en.LS-{clean,other}.positive_subset`,
+- `en.LS-{clean,other}.similar_subset`,
+- `en.LS-{clean,other}.different_subset`,
+- `{de,en,es,fr,it}.MCV.positive`,
+- `{de,en,es,fr,it}.MCV.positive.similar`,
+- `{de,en,es,fr,it}.MCV.positive.different`,
+- `{de,en,es,fr,it}.MCV.positive.subset`,
+- `{de,en,es,fr,it}.MCV.positive.positive_subset`,
+- `{de,en,es,fr,it}.MCV.positive.similar_subset`,
+- `{de,en,es,fr,it}.MCV.positive.different_subset`.
+
+The allowed values for `split` are:
+- `offline`,
+- `online`.
+
+`load_dataset` provides a list of the dictionary objects with the following contents:
+```
+{
+  "keyword_id": datasets.Value("string"),
+  "keyword_transcription": datasets.Value("string"),
+  "test_id": datasets.Value("string"),
+  "test_transcription": datasets.Value("string"),
+  "test_audio": datasets.Audio(sampling_rate=16000),
+  "label": datasets.Value("bool"),
+}
+```
+
+Each element of this list represents a single test case for the QbyT KWS:
+- `keyword_id` - the name of the keyword audio file in `data.tar.gz` (not used in QbyT KWS),
+- `keyword_transcription` - transcription of the keyword,
+- `test_id` - the name of the test audio file in `data.tar.gz`,
+- `test_transcription` - transcription of the test sample,
+- `test_audio` - raw data of the test audio,
+- `label` - `True` if the test case is positive (`keyword_transcription` is a substring of the `test_transcription`), `False` otherwise (`similar` and `different` subsets).
+
+Note that each test case can be extended to QbyE KWS by reading the proper `keyword_id` file. Unfortunately, there is no easy way to do that in the loading script.
+
+All the test files are provided in 16 kHz, even though `{de,en,es,fr,it}.MCV` files are stored in the original sampling (usually 48 kHz) in the `data.tar.gz` archives.
+
 ## Dataset Creation
 
 The MOCKS testset was created from LibriSpeech and Mozilla Common Voice (MCV) datasets that are publicly available. To create it: