Update README.md

README.md

@@ -17,9 +17,45 @@ dataset_info:
 ---
 
 
+## Dataset Description
+
+- **Repository:** [GitHub Repository](https://github.com/Galsenaicommunity/waxal-project)
+
+### Dataset Summary
 
 Keyword spotting refers to the task of learning to detect spoken keywords. It interfaces all modern voice-based virtual assistants on the market: Amazon’s Alexa, Apple’s Siri, and the Google Home device. Contrarily to speech recognition models, keyword spotting doesn’t run on the cloud, but directly on the device. 
 
 The motivation of this paper is to extend the Speech commands dataset (Warden 2018) with African languages. In particular, we are going to focus on 6 Senegalese languages: Wolof, Pulaar, Serer, Mandinka, Diola, Soninke. 
 
 The choice of these languages is guided, on the one hand, by their status as languages considered to be the languages of the first generation, that is to say, the first codified languages (endowed with a writing system and considered by the state of Senegal as national languages) with decree n ° 68-871 of July 24, 1968. On the other hand, they represent the languages that are most spoken in Senegal.
+
+### Languages
+The ID of the languages are the following:
+- Wolof: `7`
+- Pulaar: `5`
+- Serer: `6`
+- Mandinka: `4`
+- Diola: `3`
+- Soninke: `8`
+
+
+
+## Dataset Structure
+
+```python
+from datasets import load_dataset
+dataset = load_dataset("galsenai/waxal_dataset")
+DatasetDict({
+    train: Dataset({
+        features: ['audio', 'label', 'locale_id'],
+        num_rows: 24385
+    })
+})
+```
+
+### Data Fields
+
+- `audio`: audio file in WAV format
+- `label`: label of the audio file
+- `locale_id`: ID of the language
+