Update README.md

README.md

@@ -1,4 +1,59 @@
 # SoccerNet-Echoes
 Official repo for the paper: [SoccerNet-Echoes: A Soccer Game Audio Commentary Dataset](https://arxiv.org/abs/2405.07354).
-## Dataset
-Coming soon ⏳⏳⏳
+
+## Dataset 
+Each folder inside the **Dataset** directory is categorized by league, season, and game. Within these folders, JSON files contain the transcribed and translated game commentary.
+
+```python
+
+
+📂 Dataset
+├── 📁 whisper_v1
+│   ├── 🏆 england_epl
+│   │   ├── 📅 2014-2015
+│   │   │   └── ⚽ 2016-03-02 - 23-00 Liverpool 3 - 0 Manchester City
+│   │   │       ├── ☁️ 1_asr.json
+│   │   │       └── ☁️ 2_asr.json
+│   │   ├── 📅 2015-2016
+│   │   └── ...
+│   ├── 🏆 europe_uefa-champions-league
+│   └── ...
+├── 📁 whisper_v1_en
+│   └── ...
+├── 📁 whisper_v2
+│   └── ...
+├── 📁 whisper_v2_en
+│   └── ...
+├── 📁 whisper_v3
+│   └── ...
+
+whisper_v1: Contains ASR from Whisper v1.
+whisper_v1_en: English-translated datasets from Whisper v1.
+whisper_v2:  Contains ASR from Whisper v2.
+whisper_v2_en:  English-translated datasets from Whisper v2.
+whisper_v3: Contains ASR from Whisper v3.
+```
+
+Each JSON file has the following format:
+```python
+
+{
+  "segments": {
+    segment index (int):[
+      start time in second (float),
+      end time in second (float),
+      transcribed text from ASR
+    ]
+    ....
+  }
+}
+```
+The top-level object is named segments.
+It contains an object where each key represents a unique segment index (e.g., "0", "1", "2", etc.).
+Each segment index object has the following properties:
+```python
+start_time: A number representing the starting time of the segment in seconds.
+end_time: A number representing the ending time of the segment in seconds.
+text: A string containing the textual content of the commentary segment.
+```
+