Change readme

README.md

@@ -1,3 +1,142 @@
----
-license: cc
----
+# Dataset Card for Speech Wikimedia
+
+## Table of Contents
+- [Dataset Card for Speech Wikimedia](#dataset-card-for-speech-wikimedia)
+  - [Table of Contents](#table-of-contents)
+  - [Dataset Description](#dataset-description)
+    - [Dataset Summary](#dataset-summary)
+    - [Transcription languages](#transcription-languages)
+    - [Dataset distribution](#dataset-distribution)
+    - [Hours of Audio for each language](#hours-of-audio-for-each-language)
+  - [Dataset Structure](#dataset-structure)
+    - [reformat](#reformat)
+    - [transcription and transcription_2](#transcription-and-transcription_2)
+    - [real_correspondence.json](#real_correspondencejson)
+    - [license.json](#licensejson)
+    - [Data License](#data-license)
+  - [Dataset Creation](#dataset-creation)
+    - [Source Data](#source-data)
+      - [Initial Data Collection and Normalization](#initial-data-collection-and-normalization)
+      - [Preprocessing](#preprocessing)
+    - [Annotations](#annotations)
+      - [Annotation process](#annotation-process)
+    - [Personal and Sensitive Information](#personal-and-sensitive-information)
+  - [Considerations for Using the Data](#considerations-for-using-the-data)
+    - [Discussion of Biases](#discussion-of-biases)
+  - [Additional Information](#additional-information)
+    - [Licensing Information](#licensing-information)
+
+## Dataset Description
+
+- **Point of Contact:** [[email protected]](mailto:[email protected])
+
+### Dataset Summary
+
+The Speech Wikimedia Dataset is a compilation of audiofiles with transcriptions extracted from wikimedia commons that is licensed for academic and commercial usage under CC and Public domain. It includes 2,000+ hours of transcribed speech in different languages with a diverse set of speakers. 
+Each audiofile should have one or more transcriptions in different languages.
+
+### Transcription languages
+- English
+- German
+- Dutch
+- Arabic
+- Hindi
+- Portuguese
+- Spanish
+- Polish
+- French
+- Russian
+- Esperanto
+- Swedish
+- Korean	
+- Bengali
+- Hungarian
+- Oriya
+- Thai
+
+### Dataset distribution
+
+![Transcriptions](img/transcriptions_amount.jpg)
+
+### Hours of Audio for each language
+
+For each audio file with a single transcript, we assume that that audio is in that transcript's language, giving us the following table.
+This means that we ignore the files with more than one transcript in this table!
+
+![languages](img/languages.jpg)
+
+## Dataset Structure
+
+### reformat
+
+Folder with audios in flac format and sampling_rate=16,000 Hz.
+
+### transcription and transcription_2
+
+Folders with transcriptions in srt format.
+
+We split this into two directories because Hugging Face does not support more than 10,000 files in a single directory.
+
+### real_correspondence.json
+
+File with relationship between audios and transcriptions, as one large json dictionary.
+
+Key is the name of an audio file in the "reformat" directory, value is the list of corresponding transcript files, which sit in either the transcription or transcription_2 directory.
+
+
+### license.json
+
+File with license information. The key is the name of the original audio file on Wikimedia Commons.
+
+### Data License
+
+Here is an excerpt from license.json:
+
+"""
+'"Berlin Wall" Speech - President Reagan\'s Address at the Brandenburg Gate - 6-12-87.webm': {'author': '<td>\n<a class="external text" href="https://www.youtube.com/user/ReaganFoundation" rel="nofollow">ReaganFoundation</a></td>',
+  'source': '<td>\n<bdo dir="ltr" lang="en"><a href="/wiki/Commons:YouTube_files" [...],
+  'html_license': '[\'<table class="layouttemplate mw-content-ltr" lang="en" style="width:100%; [...],
+  'license': 'Public Domain'},
+
+
+## Dataset Creation
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+Data was downloaded from https://commons.wikimedia.org/.
+
+#### Preprocessing
+
+As the original format of most of the files was video, we decided to convert them to flac format with samplerate=16_000 using ffmpeg
+
+### Annotations
+
+#### Annotation process
+
+No manual annotation is done. We download only source audio with already existing transcripts. 
+
+In particular, there is no "forced alignment" or "segmentation" done on this dataset.
+
+### Personal and Sensitive Information
+
+Several of our sources are legal and government proceedings, spoken stories, speeches, and so on. Given that these were intended as public documents and licensed as such, it is natural that the involved individuals are aware of this.
+
+## Considerations for Using the Data
+
+### Discussion of Biases
+
+Our data is downloaded from commons.wikimedia.org. As such, the data is biased towards whatever users decide to upload there.
+
+The data is also mostly English, though this has potential for multitask learning because several audio files have more than one transcription.
+
+## Additional Information
+
+### Licensing Information
+
+The source data contains data under Public Domain and Creative Commons Licenses. 
+
+We license this dataset under https://creativecommons.org/licenses/by-sa/4.0/
+
+The appropriate attributions are in license.json