Update README.md

README.md

@@ -94,9 +94,9 @@ Librispeech is a corpus of read English speech, designed for training and evalua
 The Montreal Forced Aligner (MFA) was used to generate word and phoneme level alignments for the Librispeech dataset.
 
 
-- **Curated by:** Vassil Panayotov, Guoguo Chen, Daniel Povey, Sanjeev Khudanpur
+- **Curated by:** Vassil Panayotov, Guoguo Chen, Daniel Povey, Sanjeev Khudanpur (for Librispeech)
 - **Funded by:** DARPA LORELEI
-- **Shared by:** Loren Lugosch
+- **Shared by:** Loren Lugosch (for Alignments)
 - **Language(s) (NLP):** English
 - **License:** Creative Commons Attribution 4.0 International License
 
@@ -118,10 +118,32 @@ The dataset only contains read speech, so may not perform as well on spontaneous
 
 ## Dataset Structure
 
-The dataset contains 1000 hours of segmented read English speech from audiobooks. There are three subsets: 100 hours (train-clean-100), 360 hours (train-clean-360) and 500 hours (train-other-500).
+The dataset contains 1000 hours of segmented read English speech from audiobooks. There are three train subsets: 100 hours (train-clean-100), 360 hours (train-clean-360) and 500 hours (train-other-500).
 
 The alignments connect the audio to the reference text transcripts on word and phoneme level.
 
+### Data Fields
+
+- sex: M for male, F for female
+
+- subset: dev_clean, dev_other, test_clean, test_other, train_clean_100, train_clean_360, train_other_500
+
+- id: unique id of the data sample. (speaker id)-(chapter-id)-(utterance-id)
+
+- audio: the audio, 16kHz
+
+- transcript: the spoken text of the dataset, normalized and lowercased
+
+- words: a list of words with fields:
+  - word: the text of the word
+  - start: the start time in seconds
+  - end: the end time in seconds
+ 
+- phonemes: a list of phonemes with fields:
+  - phoneme: the phoneme spoken
+  - start: the start time in seconds
+  - end: the end time in seconds
+    
 ## Dataset Creation
 
 ### Curation Rationale
@@ -143,10 +165,11 @@ The audiobooks are read by volunteers for the LibriVox project. Information abou
 #### Annotation process  
 
 The Montreal Forced Aligner was used to create word and phoneme level alignments between the audio and reference texts. The aligner is based on Kaldi.
+In the process of formatting this into a HuggingFace dataset, words with empty text and phonemes with empty text, silence tokens, or spacing tokens were removed
 
 #### Who are the annotators?
 
-The alignments were generated automatically by the Montreal Forced Aligner and shared by Loren Lugosch.
+The alignments were generated automatically by the Montreal Forced Aligner and shared by Loren Lugosch. The TextGrid files were parsed and integrated into this dataset by Kim Gilkey.
 
 #### Personal and Sensitive Information
 
@@ -158,11 +181,11 @@ The dataset contains only read speech from published books, not natural conversa
 
 ### Recommendations
 
-Users should understand that the alignments may contain errors and account for this in applications.
+Users should understand that the alignments may contain errors and account for this in applications. For example, be wary of <UNK> tokens.
 
 ## Citation  
 
-**BibTeX for Librispeech:**
+**Librispeech:**
 ```
 @inproceedings{panayotov2015librispeech,  
   title={Librispeech: an ASR corpus based on public domain audio books},
@@ -173,7 +196,12 @@ Users should understand that the alignments may contain errors and account for t
 }
 ```
 
-**APA for Alignments:**
+**Librispeech Alignments:**
+```
+Loren Lugosch, Mirco Ravanelli, Patrick Ignoto, Vikrant Singh Tomar, and Yoshua Bengio, "Speech Model Pre-training for End-to-End Spoken Language Understanding", Interspeech 2019.
+```
+
+**Montreal Forced Aligner:**
 ```
-Lugosch, L. (2019). LibriSpeech Alignments (1.0) [Data set]. Zenodo. https://doi.org/10.5281/zenodo.2619474  
+Michael McAuliffe, Michaela Socolof, Sarah Mihuc, Michael Wagner, and Morgan Sonderegger. "Montreal Forced Aligner: trainable text-speech alignment using Kaldi", Interspeech 2017.
 ```