Fill out relevant parts of the dataset card template

Signed-off-by: Ingerid Dale <[email protected]>

README.md

@@ -39,45 +39,104 @@ We greatly appreciate feedback and suggestions for improvements.
 
 ### Languages
 
-- Norwegian dialects: eastern, western, south-western, central, northern (audio)
-- Norwegian bokmål (text)
-- Norwegian nynorsk (text)
+The transcription texts are in either Norwegian bokmål or Norwegian nynorsk.
+
+The audio is in Norwegian, in the speakers' respective dialects.
+We have categorized them into five dialect areas:
+
+Dialect area  (en) | Dialect area  (nb) | Counties
+--- | --- | ---
+Eastern Norway | Østlandet | Agder, Innlandet, Oslo, Vestfold og Telemark, Viken
+Southwest Norway | Sørvestlandet | Rogaland
+Western Norway | Vestlandet | Møre og Romsdal, Vestland
+Central Norway | Midt-Norge |Trøndelag
+Northern Norway | Nord-Norge | Nordland, Troms og Finnmark
+
 
 ## Dataset Structure
 
 ### Data Instances
 
-[More Information Needed]
+A data point is an audio segment
+
+```
+{'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.'}
+```
 
 ### Data Fields
 
-[More Information Needed]
+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. |
+`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 |
 
 ### Data Splits
 
-train, dev, test
-
-## Dataset Creation
-
-### Curation Rationale
+The data is split into a training, development, and test set, stratified on three parameters: source type, gender and dialect.
+Gender and dialect naturally refers to the gender and dialect of the speakers.
+The data has not been split on speaker ID to avoid speaker overlap in the various sets because this proved impossible
+while still maintaining a decent distribution of the other parameters, especially dialect variation.
 
-See the [official dataset documentation](https://www.nb.no/sbfil/taledata/NB_Samtale_About_the_corpus.pdf) for more details.
+The source type refers to whether the source material is one of the two podcasts (50f, tr) or
+a National Library live event (nb).
+The two types have different features.
+The podcasts are overall good quality studio recordings with little background noise, echo and such.
+The live events are recorded in rooms or reception halls at the National Library and have more background
+noise, echo and inconsistent audio quality.
+Many also have a live audience.
 
-### Source Data
+## Dataset Creation
 
-#### Initial Data Collection and Normalization
+### Source data
 
-[More Information Needed]
+The audio is collected from podcasts we have been permitted to share openly – namely 50
+forskere from UiT and Trondheim kommunes podkast from Trondheim municipality – as well
+as some of The National Library’s own recordings of live events. The podcasts are studio
+recordings, while the National Library events take place in rooms and reception halls at the
+National Library, sometimes in front of an audience.
 
 #### Who are the source language producers?
 
-[More Information Needed]
+Guests and hosts of the respective recording events, either podcasts produced in a studio or lectures, debates and conversations in a public live event.
 
 ### Annotations
 
 #### Annotation process
 
-[More Information Needed]
+The recordings were segmented and transcribed in the transcription software ELAN. The
+recordings were transcribed automatically using a Norwegian ASR system created by the AI-
+lab at the National Library of Norway. The speech was segmented and transcribed with
+speaker diarization, separating the speakers into separate transcription tiers. These
+segments and transcriptions were then manually corrected by a transcriber according to a
+set of guidelines. All the manual transcriptions were reviewed by a second person in order to
+avoid substantial discrepancies between transcribers. Finally all the transcriptions were
+spell-checked, and checked for any unwanted numbers or special characters.
+
+See the [official dataset documentation](https://www.nb.no/sbfil/taledata/NB_Samtale_About_the_corpus.pdf) for more details.
+The full set of guidelines for segmentation and transcription are given in Norwegian in  [NB_Samtale_transcription_guidelines.pdf](https://www.nb.no/sbfil/taledata/NB_Samtale_transcription_guidelines.pdf).
 
 #### Who are the annotators?
 
@@ -85,21 +144,19 @@ The Norwegian Language Bank (Språkbanken).
 
 ### Personal and Sensitive Information
 
-[More Information Needed]
+The data fields `gender`, `dialect` and `speaker_id` pertain to the speakers themselves.
+A single speaker will have the same `speaker_id` if they appear in several different source files.
 
 ## Considerations for Using the Data
 
-### Social Impact of Dataset
-
-[More Information Needed]
-
 ### Discussion of Biases
 
-[More Information Needed]
-
-### Other Known Limitations
-
-[More Information Needed]
+The recordings were for the most part selected based on the gender and dialect of the
+speakers to ensure gender balance and broad dialectal representation. The corpus has a
+near 50/50 divide between male and female speakers (male 54%, female 46%). The
+Norwegian dialects have been divided into five broad dialect areas that are all represented in
+the corpus. However, Eastern Norwegian has the greatest representation at about 50%
+speaker time, while the other areas fall between 8% and 20% speaker time.
 
 ## Additional Information
 
@@ -109,15 +166,6 @@ The content of the dataset was created by the Norwegian Language Bank (Språkban
 [Per Erik Solberg](mailto:[email protected]), [Marie Iversdatter Røsok](mailto:[email protected]), and [Ingerid Løyning Dale](mailto:[email protected]) all contributed in making this into a HuggingFace Dataset.
 <!-- Thanks to the HuggingFace team for assistance.  -->
 
-
 ### Licensing Information
 
-The sound and the transcriptions are released under the [CC-ZERO-license](https://creativecommons.org/publicdomain/zero/1.0/). The curation of the HuggingFace Dataset is released under [CC-BY-SA-3-license](https://creativecommons.org/licenses/by-sa/3.0/).
-
-### Citation Information
-
-[More Information Needed]
-
-### Contributions
-
-[More Information Needed]
+The NB Samtale dataset is released with the [CC-ZERO-license](https://creativecommons.org/publicdomain/zero/1.0/), i.e., it is public domain and can be used for any purpose and reshared without permission.