Update README.md

README.md

@@ -28,11 +28,11 @@
 
 ## Dataset Description
 
-- **Homepage:**
-- **Repository:**
-- **Paper:**
+- **Homepage:** https://github.com/mict-zhaw/chall_e2e_stt
+- **Repository:** https://github.com/mict-zhaw/chall_e2e_stt
+- **Paper:** tbd
 - **Leaderboard:**
-- **Point of Contact:**
+- **Point of Contact:** [email protected]
 
 ### Dataset Summary
 
@@ -41,16 +41,15 @@ The recordings capture various language learning tasks designed to elicit authen
 The dataset includes detailed verbatim transcriptions with annotations for errors made by the learners.
 The transcripts were prepared by a professional transcription service, and each recording was associated with detailed metadata, including school grade, recording conditions, and error annotations.
 
-Access to the dataset is regulated to ensure the confidentiality and ethical use of the sensitive data.
-To use the ChaLL dataset, you need to download it manually. Follow the instructions provided (**yet to be detailed**) for downloading the data. Once you have downloaded the files, please extract all files into a single folder. 
+#### Data Availability
 
+> [!WARNING]  
+> The dataset that we collected contains sensitive data of minors and thus cannot be shared publicly. The
+> data can, however, be accessed as part of a joint project with one or several of the original project
+> partners, subject to a collaboration agreement (**yet to be detailed**).
 
-Examples in this dataset are generated using the `soundfile` library (for reading and chunking). To handle the audio data correctly, you need to install the soundfile library.
-
-```shell
-pip install soundfile
-```
-
+To use the ChaLL dataset, you need to download it manually.
+Once you have manually downloaded the files, please extract all files into a single folder.
 You can then load the dataset into your environment using the following command:
 
 ```python
@@ -60,6 +59,18 @@ dataset = load_dataset('chall', data_dir='path/to/folder/folder_name')
 
 Ensure the path specified in `data_dir` correctly points to the folder where you have extracted the dataset files.
 
+Examples in this dataset are generated using the `soundfile` library (for reading and chunking).
+To handle the audio data correctly, you need to install the soundfile library in your project.
+
+```shell
+pip install soundfile
+```
+
+#### Data Configuration
+
+The 
+
+
 ### Supported Tasks and Leaderboards
 
 [More Information Needed]
@@ -75,6 +86,13 @@ This includes a variety of accents and dialectal influences from the German-spea
 ### Data Instances
 
 A typical data instance in this dataset include an audio file, its full transcription, error annotations, and associated metadata such as the speaker's grade level and recording conditions.
+Here is an example:
+
+```json
+{
+  
+}
+```
 
 ### Data Fields