docs: update data instance example

README.md

@@ -90,9 +90,9 @@ configs:
 
 ## Dataset Description
 
-- **Homepage:** <https://www.nb.no/sprakbanken/>
-- **Repository:** <https://www.nb.no/sprakbanken/en/resource-catalogue/oai-nb-no-sbr-85/>
-- **Paper:** <https://www.nb.no/sbfil/taledata/NB_Samtale_About_the_corpus.pdf>
+- **Homepage:** [nb.no/sprakbanken](https://www.nb.no/sprakbanken/)
+- **Repository:** [Resource catalogue, no. 85](https://www.nb.no/sprakbanken/en/resource-catalogue/oai-nb-no-sbr-85/)
+- **Paper:** [NB_Samtale_About_the_corpus.pdf](https://www.nb.no/sbfil/taledata/NB_Samtale_About_the_corpus.pdf)
 - **Point of Contact:** [Språkbanken](mailto:[email protected])
 
 ### Dataset Summary
@@ -130,41 +130,47 @@ Northern Norway | Nord-Norge | Nordland, Troms og Finnmark
 
 ### Data Instances
 
-A data point is an audio segment
+A data point is an audio segment, including a relative path to the `.wav`-file, and the transcription.  Additional information is provided about the speaker, the orthographic standard for the transcriptuion, whether the segment overlaps with the previous or next, and the setting for the recording.
 
 ```
 {'source_file_id': 'nb-1',
-'segment_id': '0008970-0013860',
-'segment_order': 0,
-'duration': 4.89,
-'overlap_previous': False,
-'overlap_next': False,
-'speaker_id': 'P36',
-'gender': 'm',
-'dialect': 'e',
-'orthography': 'bm',
-'source_type': 'live-event',
-'file_name': 'data/train/bm/nb-1_0008970-0013860.wav',
-'transcription': 'hallo og velkommen hit til Nasjonalbiblioteket.'}
-```
+ 'segment_id': '0008970-0013860',
+ 'segment_order': 0,
+ 'duration': 4.89,
+ 'overlap_previous': False,
+ 'overlap_next': False,
+ 'speaker_id': 'P36',
+ 'gender': 1,
+ 'dialect': 0,
+ 'orthography': 0,
+ 'source_type': 0,
+ 'file_name': 'nb-1_0008970-0013860.wav',
+ 'transcription': 'hallo og velkommen hit til Nasjonalbiblioteket.',
+ 'audio': {
+    'path': 'data/train/bm/nb-1_0008970-0013860.wav',
+    'array': array([-0.00033569,  0.00222778, -0.0005188 , ...,  0.00057983,  0.0005188 ]),
+    'sampling_rate': 16000}
+  }
+ ```
 
 ### Data Fields
 
 data field  | description  | Value type / example
 --- | --- | ---
-`source_file_id` | original file the segment appears in. | `50f-X`, `tr-X` or `nb-X`, where X is an int
-`segment_id` | segment start and end timestamp. |
+`source_file_id` | original file the segment appears in. | (str) e.g. `50f-X`, `tr-X` or `nb-X`, where X is a number.
+`segment_id` | segment start and end timestamp. | `{starttime}-{endtime}` (str)
 `segment_order` | order of segment in the original file. | (int)
 `duration` | duration of segment in seconds. | (float)
-`overlap_previous` | whether the beginning of the segment overlaps with the previous segment | `True` or `False`
-`overlap_next` | whether the end of the segment overlaps with the next segment. | `True` or `False`
-`speaker_id` | speaker ID for the speaker transcribed in the segment. | `P0` - `P69`
-`gender` | speaker’s gender | female (`f`) or male (`m`).
-`dialect` | speaker’s dialect | east (`e`), `w` (west), `sw` (southwest), `t` (central) or `n` (north)
-`orthography` |  the written norm of the transcription | bokmål (`bm`) or nynorsk (`nn`)
-`source_type` | type of recording of original file  | `live-event` or `podcast`
-`file_name` | file path to audio segment |
-`transcription` | orthographic transcription text |
+`overlap_previous` | whether the beginning of the segment overlaps with the previous segment | `True` or `False` (bool)
+`overlap_next` | whether the end of the segment overlaps with the next segment. | `True` or `False` (bool)
+`speaker_id` | speaker ID for the speaker transcribed in the segment. | `P0` - `P69` (str)
+`gender` | speaker’s binary gender (female or male), mapped to a HuggingFace datasets ClassLabel index number | `0`: f or `1`: m (int)
+`dialect` | the speaker’s dialect area, as a ClassLabel index number for the areas east (e), north (n), southwest (sw), central (t), west (w). | `0`: e, `1`: n, `2`: sw, `3`: t, or `4`: w (int)
+`orthography` |  the written norm of the transcription, either bokmål (`bm`) or nynorsk (`nn`) as a ClassLabel index number | `0`: bm or `1`: nn (int)
+`source_type` | type of recording of original file, either `live-event` or `podcast`, as a ClassLabel index number |  `0`: live-event or `1`: podcast (int)
+`file_name` | file name of the audio segment, without the path | `{source_file_id}_{segment_id}.wav` (str)
+`transcription` | orthographic transcription text | (str)
+`audio` | the audio segment data, with the relative file `path`, the bytes `array`, and the `sampling_rate` | (dict)
 
 ### Data Splits