x-stance.py

# Copyright 2022 Mads Kongsbak and Leon Derczynski
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""X-stance dataset for German and French/Italian stance detection"""


import csv
import json
import os

import datasets

_CITATION = """\
@inproceedings{vamvas2020xstance,
    author    = "Vamvas, Jannis and Sennrich, Rico",
    title     = "{X-Stance}: A Multilingual Multi-Target Dataset for Stance Detection",
    booktitle = "Proceedings of the 5th Swiss Text Analytics Conference (SwissText) \& 16th Conference on Natural Language Processing (KONVENS)",
    address   = "Zurich, Switzerland",
    year      = "2020",
    month     = "jun",
    url       = "http://ceur-ws.org/Vol-2624/paper9.pdf"
}
"""

_DESCRIPTION = """\
The x-stance dataset contains more than 150 political questions, and 67k comments written by candidates on those questions. The comments are partly German, partly French and Italian. The data have been extracted from the Swiss voting advice platform Smartvote.
"""

_HOMEPAGE = ""

_LICENSE = "cc-by-4.0"

class XStanceConfig(datasets.BuilderConfig):

    def __init__(self, **kwargs):
        super(XStanceConfig, self).__init__(**kwargs)

class XStance(datasets.GeneratorBasedBuilder):
    """The x-stance dataset split into two datasets in German and French/Italian"""

    VERSION = datasets.Version("1.0.0")

    BUILDER_CONFIGS = [
        XStanceConfig(name="de", version=VERSION, description=""),
        XStanceConfig(name="fr", version=VERSION, description="")
    ]
    
    def _info(self):
        features = datasets.Features(
            {
                "id": datasets.Value("string"),
                "question": datasets.Value("string"),
                "comment": datasets.Value("string"),
                "label": datasets.features.ClassLabel(
                    names=[
                        "AGAINST",
                        "FAVOR",
                    ]
                )
            }
        )

        return datasets.DatasetInfo(
            description=_DESCRIPTION,
            features=features,
            homepage=_HOMEPAGE,
            license=_LICENSE,
            citation=_CITATION,
        )

    def _split_generators(self, dl_manager):
        train_text = dl_manager.download_and_extract(f"x-stance-train-{self.config.name}.csv")
        valid_text = dl_manager.download_and_extract(f"x-stance-valid-{self.config.name}.csv")
        test_text  = dl_manager.download_and_extract(f"x-stance-test-{self.config.name}.csv")
        
        return [
            datasets.SplitGenerator(name=datasets.Split.TRAIN,      gen_kwargs={"filepath": train_text, "split": "train"}),
            datasets.SplitGenerator(name=datasets.Split.VALIDATION, gen_kwargs={"filepath": valid_text, "split": "validation"}),
            datasets.SplitGenerator(name=datasets.Split.TEST,       gen_kwargs={"filepath": test_text,  "split": "test"}),
        ]

    def _generate_examples(self, filepath, split):
        with open(filepath, encoding="utf-8") as f:
            reader = csv.DictReader(f, delimiter=",")
            guid = 0
            for instance in reader:
                instance["question"] = instance.pop("question")
                instance["comment"] = instance.pop("comment")
                instance["label"] = instance.pop("label")
                instance['id'] = str(guid)
                yield guid, instance
                guid += 1