Updated README

README.md

@@ -99,7 +99,7 @@ Polish
 ## Dataset Structure
 The datasets consist of audio recordings in the WAV format with corresponding metadata.<br>
 The audio and metadata can be used in a raw format (TSV) or via the Hugging Face datasets library.<br>
-References for the test split will only become available after the completion of the 23/24 PolEval challenge.<br>
+References for the test split will only become available after the completion of the 2024 PolEval challenge.<br>
 
 ### Data Instances
 The train set consists of 82 025 samples. 
@@ -115,7 +115,10 @@ Available fields:
 * `ref_orig` - original transcription of audio file
 * `samplingrate_orig` - sampling rate of the original recording
 * `sampling_rate` - sampling rate of recording in the release
-* `audiopath_bigos` - audio filepath after extraction of tar.gz archive
+* `audiopath_bigos` - relative filepath to audio file extracted from tar.gz archive
+* `audiopath_local` - absolute filepath to audio file extracted with the build script
+* `spk_sex_source` - sex of the speaker extracted from the source meta-data (N/A if not available)
+* `spk_age_source` - age group of the speaker (in CommonVoice format) extracted from the source (N/A if not available)
 <br><br>
 
 ### Data Splits

pl-asr-bigos-v2.py

@@ -110,9 +110,7 @@ class Bigos(datasets.GeneratorBasedBuilder):
                 "audiopath_bigos": datasets.Value("string"),
                 "audiopath_local": datasets.Value("string"),
                 "speaker_age": datasets.Value("string"),
-                "speaker_sex": datasets.Value("string"),
-                #"ref_spoken": datasets.Value("string"),
-                #"ref_written": datasets.Value("string")
+                "speaker_sex": datasets.Value("string")
             }
         )
 

test.py

@@ -26,35 +26,8 @@ print(dataset_local["validation"][0])
 print(dataset_local["train"][0])
 
 print("Checking build script on huggingface.co")
-dataset_hf = load_dataset(hf_db_name, "all")  
+dataset_hf = load_dataset(hf_db_name, "all", download_mode="force_redownload")  
 print(dataset_hf)
 print(dataset_hf["test"][0])
 print(dataset_hf["validation"][0])
 print(dataset_hf["train"][0])
-
-"""
-for split in splits:    
-    print("Checking split: ", split)
-    print(dataset[split][0])
-    #TODO - rename to include date of test set creation in order to check if adding new split removes the previous one
-    if split == "test":
-        assert len(dataset["test"]) == 1900
-        _BIGOS_SUBSETS = ["clarin-pjatk-mobile-15", "clarin-pjatk-studio-15", "fair-mls-20", "mailabs-19", "mozilla-common-voice-19", "pwr-azon-read-20", "pwr-azon-spont-20", "pwr-maleset-unk", "pwr-shortwords-unk", "pwr-viu-unk"]
-
-        print("Testing specific subsets")
-        for subset in _BIGOS_SUBSETS:
-            dataset = load_dataset('michaljunczyk/pl-asr-bigos', subset)
-            print("subset: ", subset)
-
-            for split in splits:
-                print("Checking split: ", split)
-                print(dataset[split][0])
-                if split == "test":
-                    if subset == "pwr-azon-spont-20":
-                        assert len(dataset["test"]) == 100
-                    else:
-                        assert len(dataset["test"]) == 200
-                    print(dataset)
-    
-    # TODO - add more tests for other splits
-"""