Update README.md

README.md

@@ -30,19 +30,18 @@ automatic = load_dataset("nilc-nlp/NURC-SP_ENTOA_TTS", name = "automatic", trust
 - `"audio": datasets.Audio(sampling_rate=16_000)`
 
 ### Automatic Parameters
-- `"audio_name": datasets.Value("string")`
-- `"file_path": datasets.Value("string")`
-- `"text": datasets.Value("string")`
-- `"start_time": datasets.Value("string")`
-- `"end_time": datasets.Value("string")`
-- `"duration": datasets.Value("string")`
-- `"quality": datasets.Value("string")`
-- `"speech_genre": datasets.Value("string")`
-- `"speech_style": datasets.Value("string")`
-- `"variety": datasets.Value("string")`
-- `"accent": datasets.Value("string")`
-- `"sex": datasets.Value("string")`
-- `"age_range": datasets.Value("string")`
-- `"num_speakers": datasets.Value("string")`
-- `"speaker_id": datasets.Value("string")`
-- `"audio": datasets.Audio(sampling_rate=16_000)`
+- 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.
+- 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.
+- duration: The duration of the audio segment in seconds.
+- quality: Whether or not the audio had parts that could not be transcribed properly. Audios without this characteristic are rated 'high' and audios with it are rated 'low'.
+- speech_genre: The speech genre of the original source of the segment. Divided into 'dialogue', 'interview' or 'lecture and talks'.
+- speech_style: The speech style of the original source of the segment. All segments are categorized as 'spontaneous speech'.
+- variety: The audio language. All segments are categorized as 'pt-br'.
+- accent: The speaker's accent. All segments are categorized as 'sp-city'. Note that some audio sources have more than one speaker, so in that case the accent refers to the main speaker or speakers.
+- 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.