w11wo commited on
Commit
1998c81
1 Parent(s): b2a420e

Updated Dataset Card for clean subsets

Browse files
Files changed (1) hide show
  1. README.md +86 -70
README.md CHANGED
@@ -28,7 +28,19 @@ Like the challenges explained in the MMS paper, we also faced the same noisy aud
28
 
29
  While [masakhane-io/bibleTTS](https://github.com/masakhane-io/bibleTTS) proposes a solution by manually (1) inserting chapter introduction transcript and (2) spells out numbers, we decided to use a mix of MMS' method by (1) inserting `*` token for additional speech (e.g. chapter introduction, verse number reading) and (2) converting digits to words using [num2words](https://github.com/rhasspy/num2words), if available.
30
 
31
- The aligned verse text and audio are then segmented into verse-level segments for TTS model training. We recommend reading the MMS paper for better understanding.
 
 
 
 
 
 
 
 
 
 
 
 
32
 
33
  - **Homepage:** [https://github.com/bookbot-hive/OpenBible-TTS/](https://github.com/bookbot-hive/OpenBible-TTS/)
34
  - **Repository:** [https://github.com/bookbot-hive/OpenBible-TTS/](https://github.com/bookbot-hive/OpenBible-TTS/)
@@ -41,8 +53,12 @@ from datasets import load_dataset
41
 
42
  # all 66 books
43
  dataset = load_dataset("bookbot/OpenBible_Swahili", trust_remote_code=True)
 
 
44
  # only Genesis
45
  dataset = load_dataset("bookbot/OpenBible_Swahili", "GEN", trust_remote_code=True)
 
 
46
  ```
47
 
48
  ## Dataset Structure
@@ -76,75 +92,75 @@ dataset = load_dataset("bookbot/OpenBible_Swahili", "GEN", trust_remote_code=Tru
76
 
77
  ### Data Splits
78
 
79
- | USX Code | Book Name | #verses |
80
- | :------: | --------------- | --------: |
81
- | GEN | Genesis | 1533 |
82
- | EXO | Exodus | 1213 |
83
- | LEV | Leviticus | 859 |
84
- | NUM | Numbers | 1288 |
85
- | DEU | Deuteronomy | 959 |
86
- | JOS | Joshua | 658 |
87
- | JDG | Judges | 618 |
88
- | RUT | Ruth | 85 |
89
- | 1SA | 1 Samuel | 810 |
90
- | 2SA | 2 Samuel | 695 |
91
- | 1KI | 1 Kings | 816 |
92
- | 2KI | 2 Kings | 719 |
93
- | 1CH | 1 Chronicles | 942 |
94
- | 2CH | 2 Chronicles | 822 |
95
- | EZR | Ezra | 280 |
96
- | NEH | Nehemiah | 406 |
97
- | EST | Esther | 167 |
98
- | JOB | Job | 1070 |
99
- | PSA | Psalms | 2461 |
100
- | PRO | Proverbs | 915 |
101
- | ECC | Ecclesiastes | 222 |
102
- | SNG | Song of Songs | 117 |
103
- | ISA | Isaiah | 1292 |
104
- | JER | Jeremiah | 1364 |
105
- | LAM | Lamentations | 154 |
106
- | EZK | Ezekiel | 1273 |
107
- | DAN | Daniel | 357 |
108
- | HOS | Hosea | 197 |
109
- | JOL | Joel | 73 |
110
- | AMO | Amos | 146 |
111
- | OBA | Obadiah | 21 |
112
- | JON | Jonah | 48 |
113
- | MIC | Micah | 105 |
114
- | NAM | Nahum | 47 |
115
- | HAB | Habakkuk | 56 |
116
- | ZEP | Zephaniah | 53 |
117
- | HAG | Haggai | 38 |
118
- | ZEC | Zechariah | 211 |
119
- | MAL | Malachi | 55 |
120
- | MAT | Matthew | 1071 |
121
- | MRK | Mark | 678 |
122
- | LUK | Luke | 1151 |
123
- | JHN | John | 879 |
124
- | ACT | Acts | 1007 |
125
- | ROM | Romans | 433 |
126
- | 1CO | 1 Corinthians | 437 |
127
- | 2CO | 2 Corinthians | 257 |
128
- | GAL | Galatians | 149 |
129
- | EPH | Ephesians | 155 |
130
- | PHP | Philippians | 104 |
131
- | COL | Colossians | 95 |
132
- | 1TH | 1 Thessalonians | 89 |
133
- | 2TH | 2 Thessalonians | 47 |
134
- | 1TI | 1 Timothy | 113 |
135
- | 2TI | 2 Timothy | 83 |
136
- | TIT | Titus | 46 |
137
- | PHM | Philemon | 25 |
138
- | HEB | Hebrews | 303 |
139
- | JAS | James | 108 |
140
- | 1PE | 1 Peter | 105 |
141
- | 2PE | 2 Peter | 61 |
142
- | 1JN | 1 John | 105 |
143
- | 2JN | 2 John | 13 |
144
- | 3JN | 3 John | 15 |
145
- | JUD | Jude | 25 |
146
- | REV | Revelation | 404 |
147
- | | **Total** | **31103** |
148
 
149
  ## Additional Information
150
 
 
28
 
29
  While [masakhane-io/bibleTTS](https://github.com/masakhane-io/bibleTTS) proposes a solution by manually (1) inserting chapter introduction transcript and (2) spells out numbers, we decided to use a mix of MMS' method by (1) inserting `*` token for additional speech (e.g. chapter introduction, verse number reading) and (2) converting digits to words using [num2words](https://github.com/rhasspy/num2words), if available.
30
 
31
+ The aligned verse text and audio are then segmented into verse-level segments for TTS model training.
32
+
33
+ As proposed in §3.1.5 of [MMS](https://arxiv.org/abs/2305.13516), we also implemented a length-normalized probability difference filtering to remove noisy alignments based on the following equation:
34
+
35
+ $$\frac{1}{T} \left[\log P\left(Y^{\text {aligned}} \mid X\right)-\log P\left(Y^{\text {greedy}} \mid X\right)\right]$$
36
+
37
+ where $T$ is the length of the audio, $P\left(Y^{\text{aligned}} \mid X\right)$ is the probability of the forced-alignment path, and $P\left(Y^{\text{greedy}} \mid X\right)$ is the probability of the greedy sequence.
38
+
39
+ Like MMS, we select `−0.2` as the default threshold and choose samples with scores greater than this threshold. We call the resultant subsets `clean`, which you can load as shown in the [Usage section](#usage).
40
+
41
+ > ⚠️ **2 Chronicles 13 and 14 (2CH_013, 2CH_014) have a corrupt source audio.** In the non-`clean` subsets, these chapters might be problematic for training!
42
+
43
+ We recommend reading the MMS paper for better understanding.
44
 
45
  - **Homepage:** [https://github.com/bookbot-hive/OpenBible-TTS/](https://github.com/bookbot-hive/OpenBible-TTS/)
46
  - **Repository:** [https://github.com/bookbot-hive/OpenBible-TTS/](https://github.com/bookbot-hive/OpenBible-TTS/)
 
53
 
54
  # all 66 books
55
  dataset = load_dataset("bookbot/OpenBible_Swahili", trust_remote_code=True)
56
+ # all 66 books, clean subset
57
+ dataset = load_dataset("bookbot/OpenBible_Swahili", "clean", trust_remote_code=True)
58
  # only Genesis
59
  dataset = load_dataset("bookbot/OpenBible_Swahili", "GEN", trust_remote_code=True)
60
+ # only Genesis, clean subset
61
+ dataset = load_dataset("bookbot/OpenBible_Swahili", "GEN_clean", trust_remote_code=True)
62
  ```
63
 
64
  ## Dataset Structure
 
92
 
93
  ### Data Splits
94
 
95
+ | USX Code | Book Name | #verses | #verses (clean) |
96
+ | :------: | --------------- | --------: | --------------: |
97
+ | GEN | Genesis | 1533 | 1498 |
98
+ | EXO | Exodus | 1213 | 1070 |
99
+ | LEV | Leviticus | 859 | 813 |
100
+ | NUM | Numbers | 1288 | 1188 |
101
+ | DEU | Deuteronomy | 959 | 940 |
102
+ | JOS | Joshua | 658 | 585 |
103
+ | JDG | Judges | 618 | 610 |
104
+ | RUT | Ruth | 85 | 83 |
105
+ | 1SA | 1 Samuel | 810 | 799 |
106
+ | 2SA | 2 Samuel | 695 | 672 |
107
+ | 1KI | 1 Kings | 816 | 773 |
108
+ | 2KI | 2 Kings | 719 | 597 |
109
+ | 1CH | 1 Chronicles | 942 | 859 |
110
+ | 2CH | 2 Chronicles | 822 | 692 |
111
+ | EZR | Ezra | 280 | 226 |
112
+ | NEH | Nehemiah | 406 | 353 |
113
+ | EST | Esther | 167 | 166 |
114
+ | JOB | Job | 1070 | 1050 |
115
+ | PSA | Psalms | 2461 | 2367 |
116
+ | PRO | Proverbs | 915 | 893 |
117
+ | ECC | Ecclesiastes | 222 | 221 |
118
+ | SNG | Song of Songs | 117 | 114 |
119
+ | ISA | Isaiah | 1292 | 1223 |
120
+ | JER | Jeremiah | 1364 | 1297 |
121
+ | LAM | Lamentations | 154 | 149 |
122
+ | EZK | Ezekiel | 1273 | 1258 |
123
+ | DAN | Daniel | 357 | 335 |
124
+ | HOS | Hosea | 197 | 194 |
125
+ | JOL | Joel | 73 | 70 |
126
+ | AMO | Amos | 146 | 144 |
127
+ | OBA | Obadiah | 21 | 20 |
128
+ | JON | Jonah | 48 | 48 |
129
+ | MIC | Micah | 105 | 103 |
130
+ | NAM | Nahum | 47 | 46 |
131
+ | HAB | Habakkuk | 56 | 55 |
132
+ | ZEP | Zephaniah | 53 | 53 |
133
+ | HAG | Haggai | 38 | 37 |
134
+ | ZEC | Zechariah | 211 | 211 |
135
+ | MAL | Malachi | 55 | 55 |
136
+ | MAT | Matthew | 1071 | 1004 |
137
+ | MRK | Mark | 678 | 557 |
138
+ | LUK | Luke | 1151 | 1027 |
139
+ | JHN | John | 879 | 856 |
140
+ | ACT | Acts | 1007 | 916 |
141
+ | ROM | Romans | 433 | 416 |
142
+ | 1CO | 1 Corinthians | 437 | 404 |
143
+ | 2CO | 2 Corinthians | 257 | 252 |
144
+ | GAL | Galatians | 149 | 145 |
145
+ | EPH | Ephesians | 155 | 152 |
146
+ | PHP | Philippians | 104 | 99 |
147
+ | COL | Colossians | 95 | 89 |
148
+ | 1TH | 1 Thessalonians | 89 | 86 |
149
+ | 2TH | 2 Thessalonians | 47 | 47 |
150
+ | 1TI | 1 Timothy | 113 | 109 |
151
+ | 2TI | 2 Timothy | 83 | 83 |
152
+ | TIT | Titus | 46 | 42 |
153
+ | PHM | Philemon | 25 | 24 |
154
+ | HEB | Hebrews | 303 | 278 |
155
+ | JAS | James | 108 | 108 |
156
+ | 1PE | 1 Peter | 105 | 91 |
157
+ | 2PE | 2 Peter | 61 | 56 |
158
+ | 1JN | 1 John | 105 | 103 |
159
+ | 2JN | 2 John | 13 | 13 |
160
+ | 3JN | 3 John | 15 | 15 |
161
+ | JUD | Jude | 25 | 24 |
162
+ | REV | Revelation | 404 | 370 |
163
+ | | **Total** | **31103** | **29233** |
164
 
165
  ## Additional Information
166