add missing information

README.md

@@ -12,20 +12,31 @@ pretty_name: GOVDATA dataset titles labelled
 
 # Dataset Card for MDK
 
-This dataset was created as part of the (Bertelsmann Foundation's)[https://www.bertelsmann-stiftung.de/de/startseite] 
-(Musterdatenkatalog (MDK)["https://www.bertelsmann-stiftung.de/de/unsere-projekte/smart-country/musterdatenkatalog"] project. The MDK provides an 
-overview of Open Data in municipalities in Germany. For more information, see: 
+This dataset was created as part of the [Bertelsmann Foundation's](https://www.bertelsmann-stiftung.de/de/startseite) 
+[Musterdatenkatalog (MDK)]("https://www.bertelsmann-stiftung.de/de/unsere-projekte/smart-country/musterdatenkatalog") project. The MDK provides an overview of Open Data in municipalities in Germany. It is intended to help municipalities in Germany, as well as data analysts and journalists, to get an overview of the topics and the extent to which cities have already published data sets.
 
 ## Dataset Description
 
 ### Dataset Summary
 
-The dataset is an annotated corpus of 1258 records based on the metadata of the datasets from (GOVDATA)[https://www.govdata.de/]. 
-The annotation maps the titles of the datasets to a taxonomy containing categories such as 'Verkehr - KFZ - Messung' or 'Abfallwirtschaft - Abfallkalender'.  
-Through the assignment the names of the data sets can be normalized and grouped. 
-In total, the taxonomy consists 250 categories. /n 
-The repository contains a small and a large version of the data. 
-The small version is for testing purposes only. The large data set contains all 1009 entries. The large and small datasets are split into a training and a testing dataset. In addition, each folder contains a validation dataset that has been annotated separately.
+The dataset is an annotated corpus of 1258 records based on the metadata of the datasets from [GOVDATA](https://www.govdata.de/).
+
+The annotation maps the titles of the datasets to a taxonomy containing categories such as 'Verkehr - KFZ - Messung' or 'Abfallwirtschaft - Abfallkalender'. Through the assignment the names of the data sets can be normalized and grouped. In total, the taxonomy consists 250 categories. Each category is divided into two levels:
+
+- Level 1: "Thema" (topic)
+  
+  <img src="taxonomy_elinor.png" width="300" height="150">
+
+- Level 2: "Bezeichnung" (label).
+
+The first dash divides the levels. For example:
+
+<img src="topic_label_example.png"  width="100" height="50">
+
+
+You can find an interactive view of the taxonomy with all labels [here](https://huggingface.co/spaces/and-effect/Musterdatenkatalog).
+
+The repository contains a small and a large version of the data. The small version is for testing purposes only. The large data set contains all 1258 entries. The large and small datasets are split into a training and a testing dataset. In addition, the large dataset folder contains of a validation dataset that has been annotated separately. The validation dataset is an additional dataset that we created for the evaluation of the algorithm. It also consists of data from GOVDATA and has the same structure as the test and training data set.
 
 ### Languages
 
@@ -33,10 +44,6 @@ The language data is German.
 
 ## Dataset Structure
 
-### Data Instances
-
-[More Information Needed]
-
 ### Data Fields
 
 | dataset | size |
@@ -47,33 +54,32 @@ The language data is German.
 | large/test | 118.66 KB |
 
 
-An example of the 'train' looks as follows:
+An example of looks as follows:
 
-```
+```json
 {
-    'doc_id': 'a063d3b7-4c09-421e-9849-073dc8939e76'
-    'title': 'Dienstleistungen Alphabetisch sortiert April 2019'
-    'description': 'CSV-Datei mit allen Dienstleistungen der Kreisverwaltung Kleve. Sortiert nach AlphabetStand 01.04.2019'
-    'labels_name': 'Sonstiges - Sonstiges'
-    'labels': 166
+    "doc_id": "a063d3b7-4c09-421e-9849-073dc8939e76"
+    "title": "Dienstleistungen Alphabetisch sortiert April 2019"
+    "description": "CSV-Datei mit allen Dienstleistungen der Kreisverwaltung Kleve. Sortiert nach AlphabetStand 01.04.2019"
+    "labels_name": "Sonstiges - Sonstiges"
+    "labels": 166
 }
 ```
 
 The data fields are the same among all splits:
 
 - doc_id (uuid): identifier for each document
-- title (str): dataset title from GovData
+- title (str): dataset title from GOVDATA
 - description (str): description of the dataset
 - labels_name (str): annotation with labels from taxonomy
 - labels (int): labels indexed from 0 to 250
 
 ### Data Splits
 
-| dataset_name | dataset_splits | train_size | test_size: |
-|-----|-----|-----|-----|
-| dataset_large | train, test | 1009 | 249 |
-| dataset_small | train, test | 37 | 13 |
-
+| dataset_name | dataset_splits | train_size | test_size | validation_size
+|-----|-----|-----|-----|-----|
+| dataset_large | train, test, validation | 1009 | 249 | 101
+| dataset_small | train, test | 37 | 13 | None
 
 ## Dataset Creation
 
@@ -81,11 +87,11 @@ The dataset was created through multiple manual annotation rounds.
 
 ### Source Data
 
-The data comes from GovData (GovData)[https://www.govdata.de/], an open data portal of Germany. It aims to provide central access to administrative data from the federal, state and local governments. Their aim is to make data available in one place and thus easier to use. The data available is structured in 13 categories ranging from finance, to international topics, health, education and science and technology. GovData offers a CKAN API to make requests and provides metadata for each data entry.
+The data comes from [GOVDATA](https://www.govdata.de/), an open data portal of Germany. It aims to provide central access to administrative data from the federal, state and local governments. Their aim is to make data available in one place and thus easier to use. The data available is structured in 13 categories ranging from finance, to international topics, health, education and science and technology. [GOVDATA](https://www.govdata.de/) offers a CKAN API to make requests and provides metadata for each data entry.
 
 #### Initial Data Collection and Normalization
 
-Several sources were used for the annotation process. A sample was collected from GovData with actual datasets. For the sample, 50 records were drawn for each group. Additional samples are from (this project)[https://github.com/bertelsmannstift/Musterdatenkatalog] that contain older data from GovData. Some of the datasets from that project already contained an annotation, but since the taxonomy is not the same, the data were re-annotated. A sample was drawn from each source (randomly and by manual selection), resulting in a total of 1258 titles.
+Several sources were used for the annotation process. A sample was collected from [GOVDATA](https://www.govdata.de/) with actual datasets. For the sample, 50 records were drawn for each group. Additional samples are from the previous version of the [MDK](https://github.com/bertelsmannstift/Musterdatenkatalog) that contain older data from [GOVDATA](https://www.govdata.de/). Some of the datasets from the old [MDK](https://github.com/bertelsmannstift/Musterdatenkatalog) already contained an annotation, but since the taxonomy is not the same, the data were re-annotated. A sample was drawn from each source (randomly and by manual selection), resulting in a total of 1258 titles.
 
 ### Annotations
 
@@ -103,48 +109,31 @@ The following table shows the results of the of the annotations:
 | **Round 4**        |       .87        | 2                        | 416                     |
 | **Validation set** |        -         | 1                        | 177                     |
 
-In addition, a validation set was generated by
+In addition, a validation set was generated by the dataset curators.
 
 #### Who are the annotators?
 
-Annotators are all employees of from and-effect.
+Annotators are all employees from [&effect data solutions GmbH](https://www.and-effect.com/). The taxonomy as well as rules and problems in the assignment of datasets were discussed and debated in advance of the development of the taxonomy and the annotation in two workshops with experts and representatives of the open data community and local governments as well as with the project members of the [Musterdatenkatalog]("https://www.bertelsmann-stiftung.de/de/unsere-projekte/smart-country/musterdatenkatalog") from the Bertelsmann Foundation. On this basis, the [&effect](https://www.and-effect.com/) employees were instructed in the annotation by the curators of the datasets.  
 
 ## Considerations for Using the Data
 
-The dataset for the annotation process was generated by sampling from GovData and data previously collected from GovData. The data on GovData is continuously updated and data can get deleted. Thus, there is no guarantee that data entries included here will also be available on GovData.
-
-<!-- [More Information Needed] -->
+The dataset for the annotation process was generated by sampling from [GOVDATA](https://www.govdata.de/) and data previously collected from GOVDATA. The data on GOVDATA is continuously updated and data can get deleted. Thus, there is no guarantee that data entries included here will still be available.
 
 ### Social Impact of Dataset
 
-[More Information Needed]
-
-### Discussion of Biases
-
-The data was mainly sampled at random from the categories available on GovData. Although all categories were sampled there is still some imbalance in the data. For example: entries for the concept 'Raumordnung, Raumplanung und Raumentwicklung - Bebauungsplan' make up the majority class. Although manual selection of data was also used for not all previous concepts data entries was found. However, for 95% of concepts at least one data entry is available.
-
-<!-- [More Information Needed] -->
+Since 2017, the German government has been promoting access to public administration data with the first laws on open data in municipalities. In this way, a contribution is to be made to the development of a [knowledge society](https://www.verwaltung-innovativ.de/DE/Startseite/startseite_node.html). The categorization of open data of cities in a standardized and detailed taxonomy supports this process of making data of municipalities freely, openly and structured accessible.
 
-### Other Known Limitations
+### Discussion of Biases (non-ethical)
 
-We know from training with the data that for some concepts there are too few entries to calculate all evaluation metrics.
-
-<!-- [More Information Needed] -->
+The data was mainly sampled at random from the categories available on GOVDATA. Although all categories were sampled there is still some imbalance in the data. For example: entries for the concept 'Raumordnung, Raumplanung und Raumentwicklung - Bebauungsplan' make up the majority class. Although manual selection of data was also used for not all previous concepts data entries was found. However, for 95% of concepts at least one data entry is available.
 
 ## Additional Information
 
 ### Dataset Curators
 
-[More Information Needed]
+Friederike Bauer
+Rahkakavee Baskaran
 
 ### Licensing Information
 
-[More Information Needed]
-
-### Citation Information
-
-[More Information Needed]
-
-### Contributions
-
 [More Information Needed]