Upload README.md

README.md

@@ -1,3 +1,144 @@
----
-license: apache-2.0
----
+# XitXat
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+  - [Contributions](#contributions)
+## Dataset Description
+
+- **Point of Contact:** [Carme Armentano-Oller](carme.armentano@bsc.es) and [Carlos Rodríguez-Penagos](carlos.rodriguez1@bsc.es)
+### Dataset Summary
+XitXat is a conversacional dataset made of 950 chatbot conversations in 10 different domains. 
+Conversations have been commissioned following the Wizard-of-Oz methods. 
+User interactions have been labeled with a intent and rellevant slots.
+XitXat dataset is released under [CC-by](https://creativecommons.org/licenses/by/4.0/) licence. 
+
+### Supported Tasks and Leaderboards
+End-to-end dialog systems training, intent classification, anonymisation.
+
+### Languages
+The dataset is in Catalan (`ca-CA`)
+
+## Dataset Structure
+### Data Instances
+One json file.
+10 domains.
+950 conversations.
+7365 labeled sentences.
+
+
+### Data Fields
+#### For the conversations
+
+- `id` (str): Unique ID assigned to the conversation.
+- `nom` (str): Name of the conversation.
+- `número` (int): Number of the conversation.
+- `frases` (list): List of the sentences.
+
+#### For the sentences
+
+- `id` (str): Unique ID assigned to the sentence.
+- `text` (str): Text of the sentence.
+- `actor` (str): Role. It can ve "agent" or "usuari" (user).
+- `intent` (str): Assigned intent of the sentence.
+- `slots`(list): Slots detected in the sentence.
+
+#### For the slots
+
+- `tag` (str): Label of the slot.
+- `text` (str): Text of the slot.
+- `Start_char` (int): Initial character of the span.
+- `End_char` (int): Last character of the span.
+
+### Data Splits
+
+- XitXat.json
+
+
+## Dataset Creation
+
+### Curation Rationale
+
+We created this dataset to contribute to the development of language models in Catalan, a low-resource language.
+
+### Source Data
+
+Conversations were created for this dataset.
+
+#### Initial Data Collection and Normalization
+
+We commissioned these conversations to a specialized company. The same company did the first annotation. After a new version of the guidelines, we commissioned a revision of the annotations to an independent computational linguist.
+
+#### Who are the source language producers?
+
+Conversations were created for this dataset following the Wizard-of-Oz method.
+
+### Annotations
+
+#### Annotation process
+
+Annotations where commissioned to a specialized company. They were made following the attached guidelines for [intents](https://github.com/projecte-aina/XitXat/blob/main/Guidelines%20anotaci%C3%B3%20v2%20Intents.pdf) and [slots](https://github.com/projecte-aina/XitXat/blob/main/Guidelines%20anotaci%C3%B3%20v3%20Slots.pdf).
+
+#### Who are the annotators?
+
+Annotations were commissioned to specialized professional annotators.
+
+### Personal and Sensitive Information
+
+No personal or sensitive information included.
+
+There is some feigned personal information, created to give verisimilitude to the dataset.
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+This dataset contributes to the development of language models in Catalan, a low-resource language.
+
+### Discussion of Biases
+
+[N/A]
+
+### Other Known Limitations
+
+[N/A]
+
+## Additional Information
+
+### Dataset Curators
+
+Carlos Rodríguez-Penagos (carlos.rodriguez1@bsc.es) and Carme Armentano-Oller (carme.armentano@bsc.es) from [BSC-CNS](https://www.bsc.es/).
+
+
+This work was funded by the [Departament de la Vicepresidència i de Polítiques Digitals i Territori de la Generalitat de Catalunya](https://politiquesdigitals.gencat.cat/ca/inici/index.html) within the framework of [Projecte AINA](https://politiquesdigitals.gencat.cat/ca/economia/catalonia-ai/aina).
+
+
+### Licensing Information
+
+This work is licensed under a <a rel="license" href="https://creativecommons.org/licenses/by/4.0/">Attribution 4.0 International License</a>.
+
+### Citation Information
+[N/A]
+
+
+[DOI][N/A](https://doi.org/10.5281/zenodo.4526223)