w11wo commited on
Commit
6c12ac8
1 Parent(s): 5627ebc

Added Model Card

Browse files
Files changed (1) hide show
  1. README.md +150 -0
README.md CHANGED
@@ -1,3 +1,153 @@
1
  ---
 
 
 
2
  license: cc-by-sa-4.0
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ pretty_name: OpenBible Swahili
3
+ language:
4
+ - swa
5
  license: cc-by-sa-4.0
6
+ task_categories:
7
+ - automatic-speech-recognition
8
+ - text-to-speech
9
  ---
10
+
11
+ # Dataset Card for OpenBible Swahili
12
+
13
+ OpenBible Swahili is a verse-level segmented audio of [Swahili: Biblica® Open Kiswahili Contemporary Version (Neno)](https://open.bible/bibles/swahili-biblica-audio-bible/). This dataset/project is inspired by [masakhane-io/bibleTTS](https://github.com/masakhane-io/bibleTTS) and [coqui-ai/open-bible-scripts](https://github.com/coqui-ai/open-bible-scripts), with a twist of applying the more recent [Massively Multilingual Speech (MMS)](https://arxiv.org/abs/2305.13516) for audio alignment.
14
+
15
+ ## Dataset Details
16
+
17
+ ### Dataset Description
18
+
19
+ > For a more detailed description, please refer to [OpenBible-TTS](https://github.com/bookbot-hive/OpenBible-TTS/tree/main).
20
+
21
+ We followed the [CTC Forced Alignment API Tutorial](https://pytorch.org/audio/main/tutorials/ctc_forced_alignment_api_tutorial.html) graciously provided by PyTorch. We used the [Massively Multilingual Speech (MMS)](https://arxiv.org/abs/2305.13516) model to align the audio to the text.
22
+
23
+ Like the challenges explained in the MMS paper, we also faced the same noisy audio alignment issues:
24
+
25
+ - Chapter introduction narration
26
+ - Occasional verse number reading
27
+ - Digits/number handling
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/)
35
+ - **Point of Contact:** [Wilson Wongso](mailto:wilson@bookbotkids.com)
36
+
37
+ ## Usage
38
+
39
+ ```py
40
+ 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
49
+
50
+ ### Data Instances
51
+
52
+ ```python
53
+ {
54
+ "id": "GEN_001_001",
55
+ "verse_id": "GEN 1:1",
56
+ "audio": {
57
+ "path": "GEN/GEN_001/GEN_001_001.wav",
58
+ "array": array([0.0010376, 0.0007019, 0.00015259, ..., 0.00817871, 0.00482178, 0.01132202]),
59
+ "sampling_rate": 44100,
60
+ },
61
+ "verse_text": "Hapo mwanzo Mungu aliumba mbingu na dunia.",
62
+ "transcript": "hapo mwanzo mungu aliumba mbingu na dunia",
63
+ }
64
+ ```
65
+
66
+ ### Data Fields
67
+
68
+ - `id`: a unique identifier for the verse, formatted as `BOOK_CHAPTER_VERSE`.
69
+ - `verse_id`: the verse identifier, formatted as `BOOK CHAPTER:VERSE`.
70
+ - `audio`: a dictionary containing the path to the audio file, the decoded audio array, and the sampling rate.
71
+ - `path`: the path to the audio file.
72
+ - `array`: the decoded audio array.
73
+ - `sampling_rate`: the sampling rate of the audio.
74
+ - `verse_text`: the verse text, with proper capitalization and punctuations.
75
+ - `transcript`: the lowercased, punctuation-removed version of `verse_text`, used during forced-alignment.
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
+
151
+ ### Licensing Information
152
+
153
+ [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)