Update README.md

README.md

@@ -61,4 +61,87 @@ configs:
     path: read_aloud/val-*
   - split: test
     path: read_aloud/test-*
+license: other
+task_categories:
+- automatic-speech-recognition
+- audio-classification
+language:
+- da
+pretty_name: CoRal
+size_categories:
+- 100K<n<1M
 ---
+
+# CoRal: Danish Conversational and Read-aloud Dataset
+
+## Dataset Overview
+
+**CoRal** is a comprehensive Automatic Speech Recognition (ASR) dataset designed to capture the  diversity of the Danish language across various dialects, accents, genders, and age groups. The primary goal of the CoRal dataset is to provide a robust resource for training and evaluating ASR models that can understand and transcribe spoken Danish in all its variations.
+
+### Key Features
+
+- **Dialect and Accent Diversity**: The dataset includes speech samples from all major Danish dialects as well as multiple accents, ensuring broad geographical coverage and the inclusion of regional linguistic features.
+- **Gender Representation**: Both male and female speakers are well-represented, offering balanced gender diversity.
+- **Age Range**: The dataset includes speakers from a wide range of age groups, providing a comprehensive resource for age-agnostic ASR model development.
+- **High-Quality Audio**: All recordings are of high quality, ensuring that the dataset can be used for both training and evaluation of high-performance ASR models.
+
+## Data Fields
+
+- `id_recording`: Unique identifier for the recording.
+- `id_sentence`: Unique identifier for the text being read aloud.
+- `id_speaker`: Unique identifier for each speaker.
+- `text`: transcription of recording
+- `dialect`: Dialect classification
+- `gender`: Gender of the speaker (Male/Female/Non-binary).
+- `age`: Age of the speaker (Integer)
+- `country_birth`: Country of where speaker was born
+- `location`: adress of recording place.
+- `location_roomdim`: dimension of recording room.
+- `noise_level`: Noise level in the room given in dB.
+- `noise_type`: Noise exposed to the speaker while recording. Note the noise is not present in the audio (ingen/human/trafik).
+- `validated`: Manual 
+validation state of the recording (approved, maybe, rejected, "null").
+- `asr_validation_model`: Model id used for auto validation of the recodings.
+- `asr_prediction`: ASR output prediction.
+- `asr_wer`: Word error rate between `asr_prediction` and `text`
+- `asr_cer`: Character error rate between `asr_prediction` and `text`
+
+## Usage
+
+The CoRal dataset is ideal for training ASR models that need to generalise across different dialects and speaker demographics within the Danish language. Below is an example of how to load and use the dataset with Hugging Face's `datasets` library:
+
+```python
+from datasets import load_dataset
+
+# Load the Coral dataset
+coral = load_dataset("alexandrainst/coral", "read_aloud")
+
+# Example: Accessing an audio sample and its transcription
+sample = coral['train'][0]
+audio = sample['audio']
+transcription = sample['text']
+
+print(f"Audio: {audio['array']}")
+print(f"Text: {transcription}")
+```
+
+## Example Applications
+- ASR Model Training: Train robust ASR models that can handle dialectal variations and diverse speaker demographics in Danish.
+- Dialect Studies: Analyse the linguistic features of different Danish dialects.
+
+**Note** Speech Synthesis and Biometric Identification are not allowed using CoRal. For more information see [license](https://huggingface.co/datasets/alexandrainst/coral/blob/main/CoRal_Data_License_v0.2.txt) ad. 4  
+
+## License
+Custom license allowing commercial use with a few restrictions (speech synthesis and biometric identification). See [license](https://huggingface.co/datasets/alexandrainst/coral/blob/main/CoRal_Data_License_v0.2.txt).
+
+## Citation
+We will submit a research paper soon, but until then, if you use the CoRal dataset in your research or development, please cite it as follows:
+
+```bibtex
+@dataset{coral2024,
+  author    = {Sif Bernstorff Lehmann, Dan Saattrup Nielsen, Simon Leminen Madsen, Anders Jess Pedersen, Torben Blach},
+  title     = {CoRal: A Diverse Danish ASR Dataset Covering Dialects, Accents, Genders, and Age Groups},
+  year      = {2024},
+  url       = {https://hf.co/datasets/alexandrainst/coral},
+}
+```