first commit

.gitattributes

@@ -53,3 +53,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.jpg filter=lfs diff=lfs merge=lfs -text
 *.jpeg filter=lfs diff=lfs merge=lfs -text
 *.webp filter=lfs diff=lfs merge=lfs -text
+train.json filter=lfs diff=lfs merge=lfs -text

README.md

@@ -1,3 +1,277 @@
 ---
-license: cc-by-nc-nd-4.0
+annotations_creators:
+- expert-generated
+language:
+- ca
+language_creators:
+- found
+license:
+- cc-by-nc-nd-4.0
+multilinguality:
+- monolingual
+pretty_name: CoQCat - Conversational Question Answering in Catalan
+size_categories:
+- 10K<n<100K
+source_datasets: []
+tags: []
+task_categories:
+- conversational
+- question-answering
+task_ids:
+- dialogue-generation
+- extractive-qa
+- closed-domain-qa
 ---
+
+# Dataset Card for CoQCat
+
+## 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
+
+- **Homepage:**
+- **Repository:**
+- **Paper:**
+- **Leaderboard:**
+- **Point of Contact:** langtech@bsc.es
+
+### Dataset Summary
+
+CoQCat is a dataset for Conversational Question Answering in Catalan. It is based on [CoQA dataset](https://stanfordnlp.github.io/coqa/).
+
+CoQCat comprises 89384 question-answer pairs, sourced from conversations related to text passages from six different domains. The questions and responses are designed to maintain a conversational tone. The answers are presented in a free-form text format, with evidence highlighted from the passage.
+
+For the development and test sets, an additional 2 responses to each question have been collected.
+
+This work is licensed under a [CC BY-NC-ND 4.0 International License](https://creativecommons.org/licenses/by-nc-nd/4.0/deed.en_GB).
+
+### Supported Tasks and Leaderboards
+
+Conversational models, question answering.
+
+### Languages
+
+The dataset is in Catalan (ca-CA).
+
+## Dataset Structure
+
+### Data Instances
+
+Three JSON files, one for each split.
+
+An example of 'test' looks as follows:
+
+```
+{
+   "source": "petites_histories",
+   "id": "petites_histories_100",
+   "filename": "coqcat_batch1",
+   "title": "Superant la crisi dels 40",
+   "story": "“Què collons estic fent aquí” es preguntà, “…fotent bots i suant a raig als meus quaranta tacos en una classe de body-step. Si no he estat mai un amant del gimnàs! Tot això és culpa del club de ‘singles', els desaparellats desesperats per trobar algú que ens escolti una mica, mentre calculem les possibilitats de fotre un clau”. Pensant tot això es va descomptar i anava a contratemps, un altre cop.\nHo acaba de decidir: sortint de la classe es donarà de baixa. Sí, serà millor oblidar els ‘singles' i dedicar els caps de setmana que no tingui les nenes a fer sortides amb el seu germà, els nebots són més grans que les seves filles i ja fan bones excursions.\nUn cop dutxat s'apropà al mostrador de l'entrada. El noi el va fer passar a l'oficina per omplir el full de baixa. Dins, una veu el va cridar: “Txume?”. Es girà estranyat ja que li deien així només a l'institut, després va ser el Jaume. Va mirar la dona que li somreia.:\n-“Estàs igual que fa vint-i-cinc anys! Has fet un pacte amb el diable?”\n-“… Alba?? Ets l'Alba?”- la seva cara li recordava a la de la noia grassoneta de la classe, però ara no ho estava pas de grassa! -“Tu sí que hi has pactat! Estàs molt millor… bé, vull dir que…”\n-“Sí, em vaig posar les piles.”\n-“Segueixes escrivint relats? Recordo que a tots ens agradaven les històries de l'Alba.”\n-“Doncs encara ho faig, just ara en plegar vaig a una sessió literària musical. Si vols venir, podem recordar batalletes.”\nS'hi apuntà. Van xerrar, van riure, van escoltar relats i poemes, van reviure les aventures de l'institut amb música de jazz de fons, … Hi estava a gust, i s'adonà que, per primer cop en molt temps, no avaluava les possibilitats d'acabar prenent la darrera copa a casa seva.",
+    "questions": [
+        {"input_text": "Està satisfet del que està fent?","turn_id": 1},
+        {"input_text": "Sua?","turn_id": 2},
+        {"input_text": "Quants anys té?","turn_id": 3},
+        {"input_text": "Li agrada anar al gimnàs?","turn_id": 4},
+        {"input_text": "Està solter?","turn_id": 5},
+        {"input_text": "Segueix bé el ritme de la música?","turn_id": 6},
+        {"input_text": "Continuarà apuntat al gimnàs?","turn_id": 7},
+        {"input_text": "Què farà els caps de setmana?","turn_id": 8},
+        {"input_text": "On li deien Txume?","turn_id": 9},
+        {"input_text": "Com l'anomenaven després?","turn_id": 10},
+        {"input_text": "En Jaume ha envellit bé?","turn_id": 11},
+        {"input_text": "L'Alba s'havia aprimat?","turn_id": 12},
+        {"input_text": "A què es dedica l'Alba?","turn_id": 13},
+        {"input_text": "On van anar plegats?","turn_id": 14},
+        {"input_text": "Volia que acabessin anant a la seva llar?","turn_id": 15}
+   ],
+    "answers": [
+        {"input_text": "No.", "span_text": "Què collons estic fent aquí", "span_start": 1, "span_end": 28,"turn_id": 1},
+        {"input_text": "Sí, a raig.", "span_text": "fotent bots i suant a raig", "span_start": 45, "span_end": 71,"turn_id": 2},
+        {"input_text": "Quaranta.", "span_text": "als meus quaranta tacos", "span_start": 72, "span_end": 95,"turn_id": 3},
+        {"input_text": "No.", "span_text": "Si no he estat mai un amant del gimnàs", "span_start": 124, "span_end": 162,"turn_id": 4},
+        {"input_text": "Sí.", "span_text": "Tot això és culpa del club de ‘singles'", "span_start": 164, "span_end": 203,"turn_id": 5},
+        {"input_text": "No.", "span_text": "es va descomptar i anava a contratemps, un altre cop", "span_start": 347, "span_end": 399,"turn_id": 6},
+        {"input_text": "No, quan surti de la classe es donarà de baixa.", "span_text": "sortint de la classe es donarà de baixa", "span_start": 422, "span_end": 461,"turn_id": 7},
+        {"input_text": "Farà sortides amb el seu germà i els seus nebots.", "span_text": "dedicar els caps de setmana que no tingui les nenes a fer sortides amb el seu germà, els nebots són més grans que les seves filles i ja fan bones excursions", "span_start": 503, "span_end": 659,"turn_id": 8},
+        {"input_text": "A l'institut.", "span_text": "Dins, una veu el va cridar: “Txume?”. Es girà estranyat ja que li deien així només a l'institut", "span_start": 776, "span_end": 871,"turn_id": 9},
+        {"input_text": "Jaume.", "span_text": "que li deien així només a l'institut, després va ser el Jaume", "span_start": 835, "span_end": 896,"turn_id": 10},
+        {"input_text": "Sí.", "span_text": "Estàs igual que fa vint-i-cinc anys", "span_start": 934, "span_end": 969,"turn_id": 11},
+        {"input_text": "Sí.", "span_text": "però ara no ho estava pas de grassa", "span_start": 1096, "span_end": 1131,"turn_id": 12},
+        {"input_text": "Escriu relats.", "span_text": "Segueixes escrivint relats? Recordo que a tots ens agradaven les històries de l'Alba.”\n-“Doncs encara ho faig", "span_start": 1232, "span_end": 1341,"turn_id": 13},
+        {"input_text": "A una sessió literària musical.", "span_text": "just ara en plegar vaig a una sessió literària musical. Si vols venir, podem recordar batalletes.”\nS'hi apuntà", "span_start": 1343, "span_end": 1453,"turn_id": 14},
+        {"input_text": "No.", "span_text": "no avaluava les possibilitats d'acabar prenent la darrera copa a casa seva", "span_start": 1641, "span_end": 1715,"turn_id": 15}
+   ],
+    "additional_answers": {
+        "0": [
+            {"input_text": "No.",  "span_text": "Què collons estic fent aquí",  "span_start": 1,  "span_end": 28, "turn_id": 1},
+            {"input_text": "Sí, molt.",  "span_text": "fotent bots i suant a raig",  "span_start": 45,  "span_end": 71, "turn_id": 2},
+            {"input_text": "Quaranta.",  "span_text": "als meus quaranta tacos",  "span_start": 72,  "span_end": 95, "turn_id": 3},
+            {"input_text": "No.",  "span_text": "Si no he estat mai un amant del gimnàs",  "span_start": 124,  "span_end": 162, "turn_id": 4},
+            {"input_text": "Sí.",  "span_text": "Tot això és culpa del club de ‘singles'", "span_start": 164,  "span_end": 203, "turn_id": 5},
+            {"input_text": "No.",  "span_text": "es va descomptar i anava a contratemps, un altre cop",  "span_start": 347,  "span_end": 399, "turn_id": 6},
+            {"input_text": "No.",  "span_text": "sortint de la classe es donarà de baixa", "span_start": 422,  "span_end": 461, "turn_id": 7},
+            {"input_text": "Farà sortides amb el seu germà i els seus nebots.", "span_text": "serà millor oblidar els ‘singles' i dedicar els caps de setmana que no tingui les nenes a fer sortides amb el seu germà, els nebots són més grans que les seves filles i ja fan bones excursions",  "span_start": 467,  "span_end": 659, "turn_id": 8},
+            {"input_text": "A l'institut.",  "span_text": "“Txume?”. Es girà estranyat ja que li deien així només a l'institut",  "span_start": 804,  "span_end": 871, "turn_id": 9},
+            {"input_text": "Jaume.",  "span_text": "després va ser el Jaume",  "span_start": 873,  "span_end": 896, "turn_id": 10},
+            {"input_text": "Sí.",  "span_text": "Estàs igual que fa vint-i-cinc anys",  "span_start": 934,  "span_end": 969, "turn_id": 11},
+            {"input_text": "Sí.",  "span_text": "però ara no ho estava pas de grassa",  "span_start": 1096,  "span_end": 1131, "turn_id": 12},
+            {"input_text": "Escriu relats.",  "span_text": "Segueixes escrivint relats? Recordo que a tots ens agradaven les històries de l'Alba.”\n-“Doncs encara ho faig",  "span_start": 1232,  "span_end": 1341, "turn_id": 13},
+            {"input_text": "A una sessió literària musical.",  "span_text": "just ara en plegar vaig a una sessió literària musical. Si vols venir, podem recordar batalletes.”\nS'hi apuntà",  "span_start": 1343,  "span_end": 1453, "turn_id": 14},
+            {"input_text": "No.",  "span_text": "no avaluava les possibilitats d'acabar prenent la darrera copa a casa seva",  "span_start": 1641,  "span_end": 1715, "turn_id": 15}
+    ],
+        "1": [
+            {"input_text": "No.",  "span_text": "Què collons estic fent aquí", "span_start": 1,  "span_end": 28, "turn_id": 1},
+            {"input_text": "Sí.",  "span_text": "fotent bots i suant",  "span_start": 45, "span_end": 64, "turn_id": 2},
+            {"input_text": "Quaranta.",  "span_text": "als meus quaranta tacos",  "span_start": 72,  "span_end": 95, "turn_id": 3},
+            {"input_text": "No.",  "span_text": "Si no he estat mai un amant del gimnàs",  "span_start": 124,  "span_end": 162, "turn_id": 4},
+            {"input_text": "Sí.",  "span_text": "Tot això és culpa del club de ‘singles', els desaparellats desesperats per trobar algú que ens escolti una mica",  "span_start": 164,  "span_end": 275, "turn_id": 5},
+            {"input_text": "No.",  "span_text": "es va descomptar i anava a contratemps, un altre cop",  "span_start": 347,  "span_end": 399, "turn_id": 6},
+            {"input_text": "No.",  "span_text": "sortint de la classe es donarà de baixa", "span_start": 422,  "span_end": 461, "turn_id": 7},
+            {"input_text": "A fer sortides amb el seu germà.",  "span_text": "serà millor oblidar els ‘singles' i dedicar els caps de setmana que no tingui les nenes a fer sortides amb el seu germà",  "span_start": 467,  "span_end": 586, "turn_id": 8},
+            {"input_text": "A l'institut.",  "span_text": "una veu el va cridar: “Txume?”. Es girà estranyat ja que li deien així només a l'institut",  "span_start": 782, "span_end": 871, "turn_id": 9},
+            {"input_text": "Jaume.",  "span_text": "després va ser el Jaume",  "span_start": 873,  "span_end": 896, "turn_id": 10},
+            {"input_text": "Sí.",  "span_text": "Estàs igual que fa vint-i-cinc anys",  "span_start": 934,  "span_end": 969, "turn_id": 11},
+            {"input_text": "Sí.",  "span_text": "però ara no ho estava pas de grassa",  "span_start": 1096,  "span_end": 1131, "turn_id": 12},
+            {"input_text": "Escriu relats.",  "span_text": "Segueixes escrivint relats? Recordo que a tots ens agradaven les històries de l'Alba.”\n-“Doncs encara ho faig",  "span_start": 1232,  "span_end": 1341, "turn_id": 13},
+            {"input_text": "A una sessió literària musical.",  "span_text": "una sessió literària musical. Si vols venir, podem recordar batalletes.”\nS'hi apuntà",  "span_start": 1369,  "span_end": 1453, "turn_id": 14},
+            {"input_text": "No.",  "span_text": "no avaluava les possibilitats d'acabar prenent la darrera copa a casa seva",  "span_start": 1641,  "span_end": 1715, "turn_id": 15}
+    ]
+ }
+}
+```
+
+### Data Fields
+
+The data fields are the same among all splits.
+
+- `source`: a `string` feature.
+- `id`: a `string` feature.
+- `filename`: a `string` feature.
+- `story`: a `string` feature.
+- `questions`: a `list` of dictionaries containing:
+   - `input_text`: a `string` feature.
+   - `turn_id`: a `int32` feature.
+- `answers`: a `list` of dictionaries containing:
+  - `input_text`: a `string` feature.
+  - `span_text`: a `string` feature.
+  - `answer_start`: a `int32` feature.
+  - `answer_end`: a `int32` feature.
+  - `turn_id`: a `int32` feature.
+- `additional_answers` (only in `dev`and `test`): a dictionary feature containing:
+  - `0`: a `list` of dictionaries equal to `answers`.
+  - `1`: a `list` of dictionaries equal to `answers`.
+
+### Data Splits
+
+* dev.json: 8909 question-answering examples. 600 text passages from 4 domains
+* test.json: 8986 question-answering examples. 600 text passages from 6 domains
+* train.json: 71489 question-answering examples. 4800 text passages from 4 domains
+
+## Dataset Creation
+
+### Curation Rationale
+
+We created this dataset to contribute to the development of language models in Catalan, a low-resource language.
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+We obtained the initial text passages from different sources, depending on the domain:
+
+* biographies: [Catalan wikipedia](ca.wikipedia.org)
+* litterature: [Gutenberg Project](gutenberg.org/)
+* news: [VilaWeb](vilaweb.cat)
+* mitology: [Catalan wikipedia](ca.wikipedia.org)
+* short histories (only in `dev`and `test`): [Petites històries](https://petiteshistories.wordpress.com/)
+* movie plot (only in `dev`and `test`): [Catalan wikipedia](ca.wikipedia.org)
+
+#### Who are the source language producers?
+
+The contents of [Catalan wikipedia](ca.wikipedia.org) are developed by a team of volunteers, and are subject to review processes also carried out by volunteers.
+
+The texts from [VilaWeb](vilaweb.cat) are prepared by journalists and communication professionals, and edited by expert proofreaders.
+
+The paragraphes extracted from the [Gutenberg Project](gutenberg.org/) are written by diferent Catalan authors.
+
+The texts of the [Petites històries website](https://petiteshistories.wordpress.com/) are written by the writer M. Carme Marí and published on her website. The author has provided them for the preparation of this dataset.
+
+### Annotations
+
+#### Annotation process
+
+The annotation process was entrusted to the company [m47 labs](https://www.m47labs.com/) through a public tender process.
+
+We asked to organize the annotators team in pairs: one of the members asking questions from the text passage and the other one answering them. For the elaboration of addicional answers for the dev and test splits, we asked the participation of a third person, not involved in the original conversation.
+
+Annotation guidelines can be found in [Zenodo](link).
+
+#### Who are the annotators?
+
+Annotation was entrusted to the company [m47 labs](https://www.m47labs.com/) through a public tender process.
+
+We asked for a team of at least 4 annotators, students or graduates of universities, ideally in the field of Humanities or Social Sciences, with optimal demonstrable knowledge of the Catalan language (minimum level C1, or equivalent), and a senior coordinator with proven experience in management and coordination of text annotation.
+
+### Personal and Sensitive Information
+
+No personal or sensitive information included.
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+We hope that this dataset will help the development of virtual assistants in Catalan, a language that is often not taken into account.
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+Language Technologies Unit at the Barcelona Supercomputing Center (langtech@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#googtrans(ca|en) within the framework of [Projecte AINA](https://politiquesdigitals.gencat.cat/ca/economia/catalonia-ai/aina).
+
+### Licensing Information
+
+This work is licensed under a [CC BY-NC-ND 4.0 International License](https://creativecommons.org/licenses/by-nc-nd/4.0/deed.en_GB).
+
+### Citation Information
+
+DOI []
+
+### Contributions
+
+The annotation was entrusted to the company [m47 labs](https://www.m47labs.com/) through a public tender process.
+
+Thanks to [M. Carme Marí](https://petiteshistories.wordpress.com/quant-a/) and the [VilaWeb](vilaweb.cat) team for allowing us to use their texts. And also to all the [Catalan wikipedia](ca.wikipedia.org) and [Gutenberg Project](gutenberg.org/) volunteers all their work.

coqcat.py

@@ -0,0 +1,80 @@
+"""CoQA dataset."""
+
+
+import json
+
+import datasets
+
+
+_HOMEPAGE = ""
+
+_CITATION = """\
+
+"""
+
+_DESCRIPTION = """\
+CoQCat - Conversational Question Answering in Catalan
+"""
+
+_TRAIN_FILE = "train.json"
+_DEV_FILE = "dev.json"
+_TEST_FILE = "test.json"
+
+class Coqa(datasets.GeneratorBasedBuilder):
+
+    VERSION = datasets.Version("1.0.0")
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "source": datasets.Value("string"),
+                    "story": datasets.Value("string"),
+                    "questions": datasets.features.Sequence(datasets.Value("string")),
+                    "answers": datasets.features.Sequence(
+                        {
+                            "input_text": datasets.Value("string"),
+                            "answer_start": datasets.Value("int32"),
+                            "answer_end": datasets.Value("int32"),
+                        }
+                    ),
+                }
+            ),
+            homepage=_HOMEPAGE,
+            citation=_CITATION,
+        )
+
+    
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        urls_to_download = {
+            "train": f"{_TRAIN_FILE}",
+            "dev": f"{_DEV_FILE}",
+            "test": f"{_TEST_FILE}",
+        }
+        downloaded_files = dl_manager.download_and_extract(urls_to_download)
+
+        return [
+            datasets.SplitGenerator(name=datasets.Split.TRAIN, gen_kwargs={"filepath": downloaded_files["train"], "split": "train"}),
+            datasets.SplitGenerator(name=datasets.Split.VALIDATION, gen_kwargs={"filepath": downloaded_files["dev"], "split": "validation"}),
+            datasets.SplitGenerator(name=datasets.Split.TEST, gen_kwargs={"filepath": downloaded_files["test"], "split": "test"}),
+        ]
+
+    def _generate_examples(self, filepath, split):
+        """Yields examples."""
+        with open(filepath, encoding="utf-8") as f:
+            data = json.load(f)
+            for row in data["data"]:
+                questions = [question["input_text"] for question in row["questions"]]
+                story = row["story"]
+                source = row["source"]
+                answers_start = [answer["span_start"] for answer in row["answers"]]
+                answers_end = [answer["span_end"] for answer in row["answers"]]
+                answers = [answer["input_text"] for answer in row["answers"]]
+                yield row["id"], {
+                    "source": source,
+                    "story": story,
+                    "questions": questions,
+                    "answers": {"input_text": answers, "answer_start": answers_start, "answer_end": answers_end},
+                }

train.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c54d9bd38b948c361840d49e8a54bc19f10ba464c3e30e74e42fc4a97f0581dd
+size 40592005