Added card and loading scripts

README.md

@@ -0,0 +1,130 @@
+---
+annotations_creators:
+- no-annotation
+language_creators:
+- found
+languages:
+- it
+licenses:
+- cc-by-nc-sa-4.0
+multilinguality:
+- monolingual
+pretty_name: change-it
+size_categories:
+- unknown
+source_datasets:
+- original
+task_categories:
+- conditional-text-generation
+task_ids:
+- conditional-text-generation-other-style-transfer
+- summarization
+paperswithcode_id: glue
+---
+
+# Dataset Card for CHANGE-IT
+
+## Table of Contents
+
+- [Dataset Card for CHANGE-IT](#dataset-card-for-change-it)
+  - [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)
+  - [Additional Information](#additional-information)
+    - [Dataset Curators](#dataset-curators)
+    - [Licensing Information](#licensing-information)
+    - [Citation Information](#citation-information)
+
+## Dataset Description
+
+- **Homepage:** [https://live.european-language-grid.eu/catalogue/corpus/7373](https://live.european-language-grid.eu/catalogue/corpus/7373)
+- **Repository:** [Github](https://github.com/michelecafagna26/CHANGE-IT)
+- **Paper:** [CEUR-ws.org](http://ceur-ws.org/Vol-2765/paper169.pdf)
+- **Video** [Vimeo](https://vimeo.com/484098874)
+- **Point of Contact:** [Lorenzo De Mattei]([email protected])
+- **Size of downloaded dataset files:** 955.33 MB
+- **Size of the generated dataset:** 229.68 MB
+- **Total amount of disk used:** 1185.01 MB
+
+### Dataset Summary
+
+The CHANGE-IT dataset contains approximately 152,000 article-headline pairs, collected from two Italian newspapers situated at opposite ends of the political spectrum, namely la Repubblica (left) and Il Giornale (right), with the two newspapers equally represented. The dataset has been used in the context 
+of the [CHANGE-IT task](https://sites.google.com/view/change-it) during the [Evalita 2020 evaluation campaign](http://www.evalita.it/2020). CHANGE-IT is a generation task for Italian – more specifically, a style transfer task for headlines of Italian newspapers. Given a (collection of) headlines from one newspaper, namely Il Giornale (G) or La Repubblica (R), it challenges automatic systems to change all G-headlines to headlines in style R, and all R-headlines to headlines in style G. Although the task only concerns headline change, the dataset comprehends both the headlines as well as their respective full articles.
+
+### Supported Tasks and Leaderboards
+
+
+
+### Languages
+
+The language data in GLUE is in Italian (BCP-47 `it`)
+
+## Dataset Structure
+
+### Data Instances
+
+A sample from the `test` split of the `ilgiornale` config is provided below. The other configuration, `ilgiornale`, has the same structure.
+
+```json
+{
+  "id": 0,
+  "headline": "Ucraina, coalizione della Timoshenko denuncia irruzione nella sede",
+  "full_text": "Rimane alta la tensione in Ucraina , dove da giorni i manifestanti scendono in piazza per protestare contro la decisione del presidente Viktor Yanukovich, che ha deciso di congelare l'accordo di associazione con l'Unione Europea. Il momento è molto delicato. L'opposizione teme una repressione violenza della protesta, con le forze speciali che hanno costretto i manifestanti a Kiev ad allontanarsi dalla sede del governo, per ripiegare su piazza Indipendenza. Il leader d'opposizione Vitaly Klitschko ha invitato il presidente a non utilizzare la forza, se non vuole avere il sangue dei manifestanti sulle sue mani. Nel frattempo il presidente Yanukovich ha aperto alla possibilità di un dialogo, annunciando per domani un incontro con i suoi due predecessori, Leonid Kuchma e Viktor Yushchenko. Ieri un milioni di persone sono scese in piazza, scaduti i due giorni di ultimatum dati al governo per indire nuove elezioni, I manifestanti hanno rovesciato la grande statua di Lenin posta sul boulevard Shevchenko. Piazza Indipendenza (Maidan Nezalezhnosti) resta il punto più caldo della capitale. Qui sono state erette barricate davanti agli ingressi della metropolitana, nel tentativo di preparsi a un'azione della polizia, che al momento non ha però preso iniziative contro i dimostranti. In serata Batkivshcyna, la coalizione dell'ex premier Yulia Timoshenko , ha denunciato l'irruzione di almeno venti agenti della polizia antisommossa nel proprio quartier generale. Il portavoce della polizia, Olga Bilyk, ha smentito: \"Né la polizia di Kiev, né la Berkut - ha dichiarato - hanno condotto operazioni nella sede\".",
+  "alignment": "A2"
+}
+```
+
+The text is provided as-is, without further preprocessing or tokenization.
+
+### Data Fields
+
+- `headline`: The original headline for the newspaper.
+- `full_text`: The article full text associated to the respective headline.
+- `alignment`: The alignment value used for the style transfer experiments. Values:
+  - `A1`: Top 5K pairs, highly aligned.
+  - `A2`: Test set, highly aligned.
+  - `A3`: 10K to 20K pairs, fairly aligned.
+  - `R`: Bottom ~50K pairs, weakly/not aligned.
+
+### Data Splits
+
+|    config|                                 train|        test|
+|---------:|-------------------------------------:|-----------:|
+|`ilgiornale`|5'000 (A1) + 10'000 (A3) + 48'701 (R) | 5'000 (A2) |
+|`repubblica`|5'000 (A1) + 10'000 (A3) + 48'701 (R) | 5'000 (A2) |
+
+### Dataset Creation
+
+Please refer to the original article [CHANGE-IT @ EVALITA 2020: Change Headlines, Adapt News, GEnerate](http://ceur-ws.org/Vol-2765/paper169.pdf) for additional information on dataset creation.
+
+## Additional Information
+
+### Dataset Curators
+
+The organizers of the CHANGE-IT shared tasks are the curators of the original dataset. For problems or updates on the 🤗 Datasets version, please contact [[email protected]](mailto:[email protected]).
+
+### Licensing Information
+
+Licensed with Creative Commons Attribution Non Commercial Share Alike 4.0. License available [here](https://creativecommons.org/licenses/by-nc-sa/4.0/).
+
+### Citation Information
+
+Please cite the authors if you use these corpora in your work:
+
+```
+@inproceedings{demattei-etal-2020-changeit,
+    author = {De Mattei, Lorenzo and Cafagna, Michele and Dell'Orletta, Felice and Nissim, Malvina and Gatt, Albert},
+    title = {{CHANGE-IT @ EVALITA 2020}: Change Headlines, Adapt News, GEnerate},
+    booktitle = {Proceedings of Seventh Evaluation Campaign of Natural Language Processing and Speech Tools for Italian. Final Workshop (EVALITA 2020)},
+    editor = {Basile, Valerio and Croce, Danilo and Di Maro, Maria, and Passaro, Lucia C.},
+    publisher = {CEUR.org},
+    year = {2020},
+    address = {Online}
+}

change_it.py

@@ -0,0 +1,157 @@
+import csv
+import os
+
+import datasets
+
+
+_CITATION = """\
+@inproceedings{demattei-etal-2020-changeit,
+    author = {De Mattei, Lorenzo and Cafagna, Michele and Dell'Orletta, Felice and Nissim, Malvina and Gatt, Albert},
+    title = {{CHANGE-IT @ EVALITA 2020}: Change Headlines, Adapt News, GEnerate},
+    booktitle = {Proceedings of Seventh Evaluation Campaign of Natural Language Processing and Speech Tools for Italian. Final Workshop (EVALITA 2020)},
+    editor = {Basile, Valerio and Croce, Danilo and Di Maro, Maria, and Passaro, Lucia C.},
+    publisher = {CEUR.org},
+    year = {2020},
+    address = {Online}
+}
+"""
+
+_DESCRIPTION = """\
+The CHANGE-IT dataset contains approximately 152,000 article-headline pairs, collected from two Italian 
+newspapers situated at opposite ends of the political spectrum, namely la Repubblica (left) and 
+Il Giornale (right), with the two newspapers equally represented. The dataset has been used in the context 
+of the CHANGE-IT task (https://sites.google.com/view/change-it) during the Evalita 2020 evaluation campaign 
+(http://www.evalita.it/2020). CHANGE-IT is a generation task for Italian – more specifically, a style transfer 
+task for headlines of Italian newspapers. Given a (collection of) headlines from one newspaper, namely 
+Il Giornale (G) or La Repubblica (R), it challenges automatic systems to change all G-headlines to headlines in 
+style R, and all R-headlines to headlines in style G. Although the task only concerns headline change, the dataset 
+comprehends both the headlines as well as their respective full articles.
+"""
+
+_HOMEPAGE = "https://live.european-language-grid.eu/catalogue/corpus/7373"
+
+_LICENSE = "Creative Commons Attribution Non Commercial Share Alike 4.0 International"
+
+_CONFIGS = ["repubblica", "ilgiornale"]
+
+_SPLITS = {
+    "train": "train", 
+    "test": "change-it-test-set"
+}
+
+_PATHS = {
+    cfg:{
+        split:os.path.join("CHANGE-it", split_path, f"change-it.{cfg}.{split}.csv")
+        for (split, split_path) in _SPLITS.items()
+    } for cfg in _CONFIGS
+}
+
+
+class ChangeItConfig(datasets.BuilderConfig):
+    """BuilderConfig for MATINF."""
+
+    def __init__(
+        self,
+        **kwargs,
+    ):
+        """BuilderConfig for CHANGE-IT.
+
+        Args:
+          **kwargs: keyword arguments forwarded to super.
+        """
+        super().__init__(version=datasets.Version("1.0.0"), **kwargs)
+
+
+class ChangeIt(datasets.GeneratorBasedBuilder):
+    VERSION = datasets.Version("1.0.0")
+
+    BUILDER_CONFIGS = [
+        ChangeItConfig(
+            name=_CONFIGS[0],
+        ),
+        ChangeItConfig(
+            name=_CONFIGS[1],
+        ),
+    ]
+
+    @property
+    def manual_download_instructions(self):
+        return (
+            "To use CHANGE-IT you have to download it manually from the European Language Grid website."
+            "Please visit https://live.european-language-grid.eu/catalogue/corpus/7373, download and unizip"
+            "the folder. The root must contain a CHANGE-it subfolder, that contains the train and change-it-test-set subfolders."
+            "Then, load the dataset with: `datasets.load_dataset('gsarti/change_it', data_dir='path/to/root/folder')`"
+        )
+
+    def get_alignment_rating(self, id, split):
+        if split == "train":
+            if id <= 5000:
+                return "A1"
+            elif 5000 < id < 15000:
+                return "A3"
+            else:
+                return "R"
+        elif split == "test":
+            return "A2"
+        else:
+            raise ValueError("Unknown split {}".format(split))
+
+    def _info(self):
+        features = datasets.Features(
+            {
+                "id": datasets.Value("int32"),
+                "headline": datasets.Value("string"),
+                "full_text": datasets.Value("string"),
+                "alignment": datasets.Value("string")
+            }
+        )
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=features,
+            supervised_keys=None,
+            homepage=_HOMEPAGE,
+            license=_LICENSE,
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        data_dir = os.path.abspath(os.path.expanduser(dl_manager.manual_dir))
+
+        if not os.path.exists(data_dir):
+            raise FileNotFoundError(
+                "{} does not exist. Make sure you insert the unzipped CHANGE-IT dir via "
+                "`datasets.load_dataset('gsarti/change_it', data_dir=...)`"
+                "Manual download instructions: {}".format(
+                    data_dir, self.manual_download_instructions
+                )
+            )
+        cfg_paths = _PATHS[self.config.name]
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={
+                    "filepath": os.path.join(data_dir, cfg_paths["train"]),
+                    "split": "train"
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.TEST,
+                gen_kwargs={
+                    "filepath": os.path.join(data_dir, cfg_paths["test"]),
+                    "split": "test"
+                },
+            ),
+        ]
+
+    def _generate_examples(self, filepath: str, split: str):
+        """Yields examples as (key, example) tuples."""
+        with open(filepath, encoding="utf8") as f:
+            reader = csv.DictReader(f)
+            for id_, row in enumerate(reader):
+                yield id_, {
+                    "id": id_,
+                    "headline": row["headline"],
+                    "full_text": row["full_text"],
+                    "alignment": self.get_alignment_rating(id_, split)
+                }