Datasets:

it-at-m
/

munich-public-services

@@ -49,7 +49,9 @@ pretty_name: Munich Public Services / Münchner Verwaltungs-Dienstleistungen
 size_categories:
 - 1K<n<10K
 ---
-# Dataset Card for Munich Public Services (🇩🇪 below)
 <!-- Provide a quick summary of the dataset. -->
 This dataset contains information about the services provided to the public by the City of Munich in the form of written articles, corresponding metadata as well as embeddings.
@@ -64,18 +66,14 @@ Next to the content of the articles, the dataset also includes metadata such the
 The dataset also includes embedding vectors computed from each article, which can be used for Retrieval or other NLP tasks.
 - **Curated by:** City of Munich, it@M, KI Competence Center
-- **Language(s) (NLP):** German, English
 - **License:** MIT
 ### Dataset Sources
 <!-- Provide the basic links for the dataset. -->
-The dataset is sourced from the city of Munich's public services website and it's underlying CMS.
-All articles were written by the city of Munich's employees.
-The other metadata was extracted from the CMS.
-The embeddings were generated using OPENAI's `text-embedding-3-large` model.
-- **Homepage:** [Munich Public Services](https://www.muenchen.de/rathaus/home.html)
 ## Uses
@@ -84,105 +82,97 @@ The embeddings were generated using OPENAI's `text-embedding-3-large` model.
 ### Direct Use
 <!-- This section describes suitable use cases for the dataset. -->
-[More Information Needed]
 ### Out-of-Scope Use
 <!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
-[More Information Needed]
 ## Dataset Structure
 <!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
-[More Information Needed]
 ## Dataset Creation
 ### Curation Rationale
 <!-- Motivation for the creation of this dataset. -->
-[More Information Needed]
 ### Source Data
 <!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
 #### Data Collection and Processing
 <!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
-[More Information Needed]
 #### Who are the source data producers?
 <!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
-[More Information Needed]
-### Annotations [optional]
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
-#### Annotation process
-<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
-[More Information Needed]
-#### Who are the annotators?
-<!-- This section describes the people or systems who created the annotations. -->
-[More Information Needed]
 #### Personal and Sensitive Information
 <!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
-[More Information Needed]
 ## Bias, Risks, and Limitations
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
 ### Recommendations
 <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Dataset Card Authors [optional]
-[More Information Needed]
 ## Dataset Card Contact
-[More Information Needed]

 size_categories:
 - 1K<n<10K
 ---
+# Dataset Card for "Munich Public Services"
+[**zur deutschen Version wechseln**](README_de.md)
 <!-- Provide a quick summary of the dataset. -->
 This dataset contains information about the services provided to the public by the City of Munich in the form of written articles, corresponding metadata as well as embeddings.
 The dataset also includes embedding vectors computed from each article, which can be used for Retrieval or other NLP tasks.
 - **Curated by:** City of Munich, it@M, KI Competence Center
+- **Language(s):** German, English
 - **License:** MIT
 ### Dataset Sources
 <!-- Provide the basic links for the dataset. -->
+- **City of Munich AI Documentation:** [ki.muenchen.de](https://ki.muenchen.de/)
+- **Dataset Source Webpages:** [Munich Public Services](https://stadt.muenchen.de/service/en-GB/)
 ## Uses
 ### Direct Use
 <!-- This section describes suitable use cases for the dataset. -->
+The dataset can be used to provide information about the public services provided by the City of Munich.
+This is especially useful for grounding information retrieval systems or Large Language Models in the context of public services.
+The data can also be used to analyze itself for patterns or trends in the public services provided by the City of Munich.
 ### Out-of-Scope Use
 <!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+The dataset should not be used for any purpose other than the intended use case of providing information about the public services provided by the City of Munich.
+This also includes other cities or government entities, as the information is specific to Munich.
+The dataset should not be used for any malicious purposes like desinformation or fake news generation.
+Also using the dataset as input to an LLM for generation of more 'fake' articles should not be done.
 ## Dataset Structure
 <!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+The dataset consists of the following fields:
+| Field             | Type       | Description                                                                                   |
+|-------------------|------------|-----------------------------------------------------------------------------------------------|
+| `id`              | int      | The unique identifier of the article.                                                         |
+| `name`            | string     | The title of the article.                                                                     |
+| `content`         | string     | The full text content of the article, formatted in Markdown.                                  |
+| `language`        | string     | The language of the article, either German (`de`) or English (`en`).                          |
+| `description`     | string     | A short description of the article content with a maximum length of x characters, formatted in HTML. |
+| `source`          | string     | Link to the source webpage of the article.                                                    |
+| `public`          | bool       | Boolean value indicating if the article is public or not, always `True`.                      |
+| `lastModification`| timestamp  | Timestamp of the last modification of the article in UTC.                                     |
+| `keywords`        | sequence [string]   | A list of keywords associated with the article, the keywords might be in German or English.   |
+| `embedding`       | sequence [float]  | A 3072 dimensional embedding vector computed from the article content, using OpenAI's [`text-embedding-3-large`](https://platform.openai.com/docs/guides/embeddings/#embedding-models) model. |
 ## Dataset Creation
 ### Curation Rationale
 <!-- Motivation for the creation of this dataset. -->
+The dataset was created as a side product of a project to provide a better information retrieval system for the City of Munich's public services.
+Periodically the dataset is updated to include new articles and to update the embeddings.
 ### Source Data
 <!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+The dataset is sourced from the city of Munich's public services website and it's underlying CMS.
+All articles were written by the city of Munich's employees.
 #### Data Collection and Processing
 <!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
+The data was collected by querying an internal API of the city of Munich's CMS.
+The data was then processed to extract the metadata and the content of the articles.
+The article content was transformed from HTML to Markdown by using the [markdownify](https://pypi.org/project/markdownify/) library.
+The embeddings were generated using OpenAI's [`text-embedding-3-large`](https://platform.openai.com/docs/guides/embeddings/#embedding-models) model.
 #### Who are the source data producers?
 <!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
+The source data producers are the employees of the City of Munich who wrote the articles, there is no attribution to individual authors.
+The employees are a diverse group of people working in the city's administration with special knowledge about the public services of their respective departments and skills in writing understandable articles.
 #### Personal and Sensitive Information
 <!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
+The dataset does not contain any personal or sensitive information.
 ## Bias, Risks, and Limitations
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
+The provided dataset is only a subset of all public services provided by the City of Munich.
+Besides that, the data can contain biases in the form of
+- the language used in the articles (so called "Beamtendeutsch" / "administrative German")
+- the quality and information richness of the articles
+- the number of articles for one topic
+- and the keywords associated with the articles.
+This can lead to biases in the embeddings and the information retrieval system built on top of the dataset.
 ### Recommendations
 <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+To mitigate the biases in the dataset, it is recommended to use the dataset in combination with other sources of information.
+Another approach is to evaluate the dataset with a custom evaluation set to identify biases for the specific use case and to mitigate them.
+## More Information
+For more information about the AI projects of the City of Munich, please visit the [ki.muenchen.de](https://ki.muenchen.de/) website.
+## Dataset Card Authors
+Fabian Reinold, City of Munich, it@M, AI Competence Center
 ## Dataset Card Contact
+For any questions about the dataset, please [contact us](mailto:[email protected])

README_de.md ADDED Viewed

	@@ -0,0 +1,135 @@

+# Dataset Card für "Münchner Verwaltungs-Dienstleistungen"
+[**switch to English version**](README.md)
+<!-- Provide a quick summary of the dataset. -->
+Dieser Datensatz enthält Informationen über die von der Landeshauptstadt München angebotenen Dienstleistungen in Form von schriftlichen Artikeln, zugehörigen Metadaten sowie Einbettungen.
+## Datensatzdetails
+### Datensatzbeschreibung
+<!-- Provide a longer summary of what this dataset is. -->
+Der Datensatz "Münchner Verwaltungs-Dienstleistungen" enthält etwa 1.400 Artikel über verschiedene öffentliche Dienstleistungen der Landeshauptstadt München.
+Neben dem Inhalt der Artikel enthält der Datensatz auch Metadaten wie die Sprache des Artikels, das Datum der letzten Änderung und die mit dem Artikel verbundenen Schlüsselwörter.
+Der Datensatz enthält auch Einbettungsvektoren, die aus jedem Artikel berechnet wurden und für Retrieval- oder andere NLP-Aufgaben verwendet werden können.
+- **Kuratiert von:** Landeshauptstadt München, it@M, KI Competence Center
+- **Sprache(n) (NLP):** Deutsch, Englisch
+- **Lizenz:** MIT
+### Datenquellen
+<!-- Provide the basic links for the dataset. -->
+- **KI-Dokumentation der Landeshauptstadt München:** [ki.muenchen.de](https://ki.muenchen.de/)
+- **Datensatz-Quellwebseiten:** [Münchner Verwaltungs-Dienstleistungen](https://stadt.muenchen.de/service/en-GB/)
+## Verwendungszwecke
+<!-- Address questions around how the dataset is intended to be used. -->
+### Direkte Nutzung
+<!-- This section describes suitable use cases for the dataset. -->
+Der Datensatz kann verwendet werden, um Informationen über die öffentlichen Dienstleistungen der Landeshauptstadt München bereitzustellen.
+Dies ist besonders nützlich für KI-basierte Suchsysteme oder das Anreichern großer Sprachmodelle im Kontext öffentlicher Dienstleistungen.
+Die Daten können auch verwendet werden, um Muster oder Trends in den von der Landeshauptstadt München angebotenen öffentlichen Dienstleistungen zu analysieren.
+### Nicht geeignete Nutzung
+<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+Der Datensatz sollte nicht für andere Zwecke als den vorgesehenen Verwendungszweck der Bereitstellung von Informationen über die öffentlichen Dienstleistungen der Landeshauptstadt München verwendet werden.
+Dies gilt auch für andere Städte oder Regierungsstellen, da die Informationen spezifisch für München sind.
+Der Datensatz sollte nicht für böswillige Zwecke wie Desinformation oder die Erstellung von Fake News verwendet werden.
+Auch die Verwendung des Datensatzes als Eingabe für ein LLM zur Erstellung weiterer "Fake"-Artikel sollte unterlassen werden.
+## Datenstruktur
+<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+Der Datensatz besteht aus den folgenden Feldern:
+| Feld              | Typ        | Beschreibung                                                                                   |
+|-------------------|------------|-----------------------------------------------------------------------------------------------|
+| `id`              | int        | Die eindeutige ID des Artikels.                                                           |
+| `name`            | string     | Der Titel des Artikels.                                                                        |
+| `content`         | string     | Der vollständige Textinhalt des Artikels, formatiert in Markdown.                              |
+| `language`        | string     | Die Sprache des Artikels, entweder Deutsch (`de`) oder Englisch (`en`).                        |
+| `description`     | string     | Eine kurze Beschreibung des Artikelinhalts mit einer maximalen Länge von x Zeichen, formatiert in HTML. |
+| `source`          | string     | Link zur Quellwebseite des Artikels.                                                           |
+| `public`          | bool       | Wahrheitswert, der angibt, ob der Artikel öffentlich ist oder nicht, immer `True`.           |
+| `lastModification`| timestamp  | Zeitstempel der letzten Änderung des Artikels in UTC.                                          |
+| `keywords`        | sequence [string] | Eine Liste von Schlüsselwörtern, die mit dem Artikel verbunden sind; die Schlüsselwörter können auf Deutsch oder Englisch sein. |
+| `embedding`       | sequence [float]  | Ein 3072-dimensionaler Einbettungsvektor, der aus dem Artikelinhalt berechnet wurde, unter Verwendung von OpenAI's [`text-embedding-3-large`](https://platform.openai.com/docs/guides/embeddings/#embedding-models) KI-Modell. |
+## Datensatz-Erstellung
+### Kurationsgrund
+<!-- Motivation for the creation of this dataset. -->
+Der Datensatz wurde als Nebenprodukt eines Projekts zur Bereitstellung eines besseren Informationsabrufsystems für die öffentlichen Dienstleistungen der Landeshauptstadt München erstellt.
+Der Datensatz wird regelmäßig aktualisiert, um neue Artikel aufzunehmen und die Einbettungen zu aktualisieren.
+### Quelldaten
+<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+Der Datensatz stammt von der Website der öffentlichen Dienstleistungen der Landeshauptstadt München und dem zugrunde liegenden CMS.
+Alle Artikel wurden von Mitarbeitenden der Landeshauptstadt München geschrieben.
+#### Datensammlung und -verarbeitung
+<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
+Die Daten wurden durch Abfragen einer internen API des CMS der Landeshauptstadt München gesammelt.
+Die Daten wurden dann weiterverarbeitet, um die Metadaten und den Inhalt der Artikel zu extrahieren.
+Der Artikelinhalt wurde mit der [markdownify](https://pypi.org/project/markdownify/) Bibliothek von HTML in Markdown umgewandelt.
+Die Einbettungen wurden mit dem [`text-embedding-3-large`](https://platform.openai.com/docs/guides/embeddings/#embedding-models) Modell von OpenAI generiert.
+#### Wer sind die Ersteller der Quelldaten?
+<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
+Die Ersteller der Quelldaten sind die Mitarbeiter der Landeshauptstadt München, die die Artikel geschrieben haben, es gibt keine Zuordnung zu einzelnen Autoren.
+Die Mitarbeiter sind eine vielfältige Gruppe von Menschen, die in der Stadtverwaltung arbeiten und über spezielles Wissen über die öffentlichen Dienstleistungen ihrer jeweiligen Referaten und Fähigkeiten im Verfassen verständlicher Artikel verfügen.
+#### Persönliche und sensible Informationen
+<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
+Der Datensatz enthält keine persönlichen oder sensiblen Informationen.
+## Verzerrungen, Risiken und Einschränkungen
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+Der bereitgestellte Datensatz ist nur ein Teil aller öffentlichen Dienstleistungen der Landeshauptstadt München.
+Darüber hinaus können die Daten Verzerrungen in Form von
+- der in den Artikeln verwendeten Sprache (sogenanntes "Beamtendeutsch")
+- der Qualität und Informationsfülle der Artikel
+- der Anzahl der Artikel zu einem Thema
+- und den mit den Artikeln verbundenen Schlüsselwörtern enthalten.
+Dies kann zu Verzerrungen in den Einbettungen und dem auf dem Datensatz aufgebauten Systeme führen
+### Empfehlungen
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+Um die Verzerrungen im Datensatz zu mindern, wird empfohlen, den Datensatz in Kombination mit anderen Informationsquellen zu verwenden.
+Ein weiterer Ansatz besteht darin, den Datensatz mit einem benutzerdefinierten Evaluationsset zu bewerten, um Verzerrungen für den spezifischen Anwendungsfall zu identifizieren und zu mindern.
+## Glossar
+- **Retrieval:** Abruf von Informationen aus einem Datensatz.
+- **NLP:** Natural Language Processing, Verarbeitung natürlicher Sprache.
+- **Embedding:** Einbettung, eine Darstellung von Text in Form von Vektoren.
+- **LLM:** Large Language Model, großes Sprachmodell.
+- **Desinformation:** Verbreitung falscher oder irreführender Informationen.
+## Weitere Informationen
+Für weitere Informationen über die KI-Projekte der Landeshauptstadt München besuchen Sie bitte [ki.muenchen.de](https://ki.muenchen.de/).
+## Autoren der Dataset Card
+Fabian Reinold - Landeshauptstadt München, it@M, KI Competence Center
+## Kontakt für die Dataset Card
+Bei Fragen zum Datensatz kontaktieren Sie uns bitte [hier](mailto:[email protected]).