Add test for CommonVoice dataset (#827)

* Add test for CommonVoice dataset

* Migrate the existing tests for `bg_iterator` and `diskcache_iterator` to `test/datasets/utils_test.py`
Co-authored-by: Leon Gao <legao@linkedin.com>

test/datasets/commonvoice_test.py

+import os
+import csv
+import random
+
+from torchaudio.datasets import commonvoice
+from ..common_utils import (
+    TempDirMixin,
+    TorchaudioTestCase,
+    get_whitenoise,
+    save_wav,
+    normalize_wav,
+)
+
+
+class TestCommonVoice(TempDirMixin, TorchaudioTestCase):
+    backend = 'default'
+
+    root_dir = None
+    data = []
+    _headers = [u"client_ids", u"path", u"sentence", u"up_votes", u"down_votes", u"age", u"gender", u"accent"]
+    # Note: extension is changed to wav for the sake of test
+    # Note: the first content is missing values for `age`, `gender` and `accent` as in the original data.
+    _train_csv_contents = [
+        ["9d16c5d980247861130e0480e2719f448be73d86a496c36d01a477cbdecd8cfd1399403d7a77bf458d211a70711b2da0845c",
+            "common_voice_en_18885784.wav",
+            "He was accorded a State funeral, and was buried in Drayton and Toowoomba Cemetery.", "2", "0", "", "", ""],
+        ["c82eb9291328620f06025a1f8112b909099e447e485e99236cb87df008650250e79fea5ca772061fb6a370830847b9c44d20",
+            "common_voice_en_556542.wav", "Once more into the breach", "2", "0", "thirties", "male", "us"],
+        ["f74d880c5ad4c5917f314a604d3fc4805159d255796fb9f8defca35333ecc002bdf53dc463503c12674ea840b21b4a507b7c",
+            "common_voice_en_18607573.wav",
+            "Caddy, show Miss Clare and Miss Summerson their rooms.", "2", "0", "twenties", "male", "canada"],
+    ]
+    _folder_audio = "clips"
+    sample_rate = 48000
+
+    @classmethod
+    def setUpClass(cls):
+        cls.root_dir = cls.get_base_temp_dir()
+        # The path convention commonvoice uses
+        base_dir = os.path.join(cls.root_dir, commonvoice.FOLDER_IN_ARCHIVE, commonvoice.VERSION, "en")
+        os.makedirs(base_dir, exist_ok=True)
+
+        # Tsv file name difference does not mean different subset, testing as a whole dataset here
+        tsv_filename = os.path.join(base_dir, commonvoice.TSV)
+        with open(tsv_filename, "w", newline='') as tsv:
+            writer = csv.writer(tsv, delimiter='\t')
+            writer.writerow(cls._headers)
+            for i, content in enumerate(cls._train_csv_contents):
+                audio_filename = audio_filename = content[1]
+                writer.writerow(content)
+
+                # Generate and store audio
+                audio_base_path = os.path.join(base_dir, cls._folder_audio)
+                os.makedirs(audio_base_path, exist_ok=True)
+                audio_path = os.path.join(audio_base_path, audio_filename)
+                data = get_whitenoise(sample_rate=cls.sample_rate, duration=1, n_channels=1, seed=i, dtype='float32')
+                save_wav(audio_path, data, cls.sample_rate)
+
+                # Append data entry
+                cls.data.append((normalize_wav(data), cls.sample_rate, dict(zip(cls._headers, content))))
+
+    def test_commonvoice(self):
+        dataset = commonvoice.COMMONVOICE(self.root_dir)
+        n_ite = 0
+        for i, (waveform, sample_rate, dictionary) in enumerate(dataset):
+            expected_dictionary = self.data[i][2]
+            expected_data = self.data[i][0]
+            self.assertEqual(expected_data, waveform, atol=5e-5, rtol=1e-8)
+            assert sample_rate == TestCommonVoice.sample_rate
+            assert dictionary == expected_dictionary
+            n_ite += 1
+        assert n_ite == len(self.data)

test/datasets/datasets_test.py

-from torchaudio.datasets.commonvoice import COMMONVOICE
-from torchaudio.datasets.utils import diskcache_iterator, bg_iterator
+from torchaudio.datasets.librispeech import LIBRISPEECH
+from torchaudio.datasets.speechcommands import SPEECHCOMMANDS
 from torchaudio.datasets.vctk import VCTK
 from torchaudio.datasets.cmuarctic import CMUARCTIC
 
@@ -20,26 +20,3 @@ class TestDatasets(TorchaudioTestCase):
     def test_cmuarctic(self):
         data = CMUARCTIC(self.path)
         data[0]
-
-
-class TestCommonVoice(TorchaudioTestCase):
-    backend = 'default'
-    path = get_asset_path()
-
-    def test_commonvoice(self):
-        data = COMMONVOICE(self.path, url="tatar")
-        data[0]
-
-    def test_commonvoice_diskcache(self):
-        data = COMMONVOICE(self.path, url="tatar")
-        data = diskcache_iterator(data)
-        # Save
-        data[0]
-        # Load
-        data[0]
-
-    def test_commonvoice_bg(self):
-        data = COMMONVOICE(self.path, url="tatar")
-        data = bg_iterator(data, 5)
-        for _ in data:
-            pass

test/datasets/utils_test.py

@@ -2,10 +2,12 @@ import os
 from pathlib import Path
 
 from torchaudio.datasets import utils as dataset_utils
+from torchaudio.datasets.commonvoice import COMMONVOICE
 
 from ..common_utils import (
     TempDirMixin,
     TorchaudioTestCase,
+    get_asset_path,
 )
 
 
@@ -45,3 +47,22 @@ class TestWalkFiles(TempDirMixin, TorchaudioTestCase):
             assert found == self.expected[i]
             n_ites += 1
         assert n_ites == len(self.expected)
+
+
+class TestIterator(TorchaudioTestCase):
+    backend = 'default'
+    path = get_asset_path()
+
+    def test_disckcache_iterator(self):
+        data = COMMONVOICE(self.path, url="tatar")
+        data = dataset_utils.diskcache_iterator(data)
+        # Save
+        data[0]
+        # Load
+        data[0]
+
+    def test_bg_iterator(self):
+        data = COMMONVOICE(self.path, url="tatar")
+        data = dataset_utils.bg_iterator(data, 5)
+        for _ in data:
+            pass