Update README.md

README.md

@@ -1,35 +1,52 @@
 ---
 license: mit
+task_categories:
+- text-to-speech
+language:
+- pt
 ---
 
 ## How to Load the Dataset
 
-There are 2 configurations: **"prosodic"** and **"automatic"**. Below are the parameters for each configuration:
+There are 3 configurations: **"prosodic"**, **"automatic"** and **"audioCorpus"**. To load the dataset with the HuggingFace *datasets* library, use the following code: 
 
 ``` python
 prosodic = load_dataset("nilc-nlp/NURC-SP_ENTOA_TTS", name="prosodic", trust_remote_code=True)
 automatic = load_dataset("nilc-nlp/NURC-SP_ENTOA_TTS", name = "automatic", trust_remote_code=True)
+audioCorpus = load_dataset("nilc-nlp/NURC-SP_ENTOA_TTS", name = "audioCorpus", trust_remote_code=True)
 ```
 
+## Parameters of each configuration
+
 ### Prosodic Parameters
-- `"path": datasets.Value("string")`
-- `"name": datasets.Value("string")`
-- `"speaker": datasets.Value("string")`
-- `"start_time": datasets.Value("string")`
-- `"end_time": datasets.Value("string")`
-- `"normalized_text": datasets.Value("string")`
-- `"text": datasets.Value("string")`
-- `"duration": datasets.Value("string")`
-- `"type": datasets.Value("string")`
-- `"year": datasets.Value("string")`
-- `"gender": datasets.Value("string")`
-- `"age_range": datasets.Value("string")`
-- `"total_duration": datasets.Value("string")`
-- `"quality": datasets.Value("string")`
-- `"theme": datasets.Value("string")`
-- `"audio": datasets.Audio(sampling_rate=16_000)`
+- path: The path to the audio file.
+- name: The name of the original audio.
+- speaker: The speaker in the segment (each different speaker in the original source was given an integer id). This field was automatically writter by WhisperX, so it might not be accurate.
+- start_time: The time the audio segment starts in the original source in seconds.
+- end_time: The time the audio segment ends in the original source in seconds.
+- normalized_text: The human-made trancription without prosodic markings for the given audio.
+- text: The human-made trancription with prosodic markings for the given audio.
+- duration: The duration of the audio segment in seconds.
+- type: The type of the audio according to the original NURC-SP classification.
+- year: The year the audio was recorded
+- gender: he speaker's sex. Divided into 'F', 'M', 'F e F', 'F e M' and 'M e M' ('F' stands for female and 'M' stands for male). Note that some audio sources have more than one speaker, so in that case the sex refers to the main speaker or speakers.
+- age_range: The speaker's age range. Divided into 'I' (25 to 35), 'II' (36 to 55) and 'III' (over 55). Note that some audio sources have more than one speaker, so in that case the age range refers to the main speaker or speakers.
+- total_duration: The duration of the original audio in minutes.
+- quality: The human-determined quality of the audio
+- theme: The theme of the speech.
+- audio: The audio data of the segment.
 
 ### Automatic Parameters
+- path: The path to the audio file.
+- name: The name of the original audio.
+- speaker: The speaker in the segment (each different speaker in the original source was given an integer id). This field was automatically writter by WhisperX, so it might not be accurate.
+- start_time: The time the audio segment starts in the original source in seconds.
+- end_time: The time the audio segment ends in the original source in seconds.
+- text: The automatic trancription for the given audio.
+- duration: The duration of the audio segment in seconds.
+- audio: The audio data of the segment.
+  
+### AudioCorpus Parameters
 - audio_name: The name given to the audio in the database. All audios extracted from the same source have the same name.
 - file_path: The path to the audio file.
 - text: The human-verified trancription for the given audio.
@@ -44,4 +61,4 @@ automatic = load_dataset("nilc-nlp/NURC-SP_ENTOA_TTS", name = "automatic", trust
 - sex: The speaker's sex. Divided into 'F', 'M', 'F e F', 'F e M' and 'M e M' ('F' stands for female and 'M' stands for male). Note that some audio sources have more than one speaker, so in that case the sex refers to the main speaker or speakers.
 - age_range: The speaker's age range. Divided into 'I' (25 to 35), 'II' (36 to 55) and 'III' (over 55). Note that some audio sources have more than one speaker, so in that case the age range refers to the main speaker or speakers.
 - num_speakers: The number of speakers in the original source of the segment. This field was automatically writter by WhisperX, so it might not be accurate.
-- speaker_id: The speaker in the segment (each different speaker in the original source was given an integer id). This field was automatically writter by WhisperX, so it might not be accurate.
+- speaker_id: The speaker in the segment (each different speaker in the original source was given an integer id). This field was automatically writter by WhisperX, so it might not be accurate.