QR-AN.py

import json
import os

import datasets
from datasets.tasks import TextClassification


_CITATION = None


_DESCRIPTION = """\
 QR-AN Dataset: a classification dataset on french Parliament debates
 This is a dataset for theme/topic classification, made of questions and answers from https://www2.assemblee-nationale.fr/recherche/resultats_questions.
 It contains 188 unbalanced classes, 80k questions-answers divided into 3 splits: train (60k), val (10k) and test (10k).
"""


_LABELS = [
    'administration', 'agriculture', 'agroalimentaire', 'aménagement du territoire', 'anciens combattants et victimes de guerre', 
    'animaux', 'aquaculture et pêche professionnelle', 'architecture', 'archives et bibliothèques', 'armes', 'arts et spectacles', 
    'associations', 'assurance invalidité décès', 'assurance maladie maternité : généralités', 'assurance maladie maternité : prestations', 
    'assurances', 'audiovisuel et communication', 'automobiles et cycles', 'avortement', 'banques et établissements financiers', 
    'bâtiment et travaux publics', 'baux', 'bioéthique', 'bois et forêts', "bourses d'études", 'cérémonies publiques et fêtes légales', 
    'chambres consulaires', 'chasse et pêche', 'chômage : indemnisation', 'collectivités territoriales', 'commerce et artisanat', 
    'commerce extérieur', 'communes', 'consommation', 'contributions indirectes', 'coopération intercommunale', 'copropriété', 
    'corps diplomatique et consulaire', "cours d'eau, étangs et lacs", 'cultes', 'culture', 'déchéances et incapacités', 
    'déchets, pollution et nuisances', 'décorations, insignes et emblèmes', 'défense', 'démographie', 'départements', 
    'donations et successions', 'drogue', 'droit pénal', "droits de l'Homme et libertés publiques", 'eau', 'économie sociale', 
    'éducation physique et sportive', 'élections et référendums', 'élevage', 'emploi', 'énergie et carburants', 'enfants', 
    'enregistrement et timbre', 'enseignement', 'enseignement : personnel', 'enseignement agricole', 
    'enseignement maternel et primaire', 'enseignement maternel et primaire : personnel', 'enseignement privé', 
    'enseignement secondaire', 'enseignement secondaire : personnel', 'enseignement supérieur', 
    'enseignement supérieur : personnel', 'enseignement technique et professionnel', 
    'enseignement technique et professionnel : personnel', 'enseignements artistiques', 
    'entreprises', 'environnement', 'ésotérisme', 'espace', 'établissements de santé', 'État', 
    'état civil', 'étrangers', 'famille', 'femmes', 'finances publiques', "fonction publique de l'État", 
    'fonction publique hospitalière', 'fonction publique territoriale', 'fonctionnaires et agents publics',
    'formation professionnelle', "Français de l'étranger", 'frontaliers', 'gendarmerie', 'gens du voyage', 
    'grandes écoles', 'handicapés', 'heure légale', 'hôtellerie et restauration', 'impôt de solidarité sur la fortune', 
    'impôt sur le revenu', 'impôt sur les sociétés', 'impôts et taxes', 'impôts locaux', 'industrie', 'informatique', 
    'institutions sociales et médico-sociales', 'jeunes', 'jeux et paris', 'justice', 'langue française', 'logement', 
    'logement : aides et prêts', 'marchés financiers', 'marchés publics', 'matières premières', 'médecines parallèles', 
    'mer et littoral', 'mines et carrières', "ministères et secrétariats d'État", 'mort', 'moyens de paiement', 'nationalité', 
    'ordre public', 'organisations internationales', 'outre-mer', "papiers d'identité", 'Parlement', 
    'partis et mouvements politiques', 'patrimoine culturel', "pensions militaires d'invalidité", 'personnes âgées', 
    'pharmacie et médicaments', 'plus-values : imposition', 'police', 'politique économique', 'politique extérieure', 
    'politique sociale', 'politiques communautaires', 'postes', 'préretraites', 'presse et livres', 'prestations familiales', 
    'produits dangereux', 'professions de santé', 'professions immobilières', 'professions judiciaires et juridiques', 
    'professions libérales', 'professions sociales', 'propriété', 'propriété intellectuelle', 'publicité', 'rapatriés', 
    'recherche', 'régions', 'relations internationales', 'retraites : fonctionnaires civils et militaires', 
    'retraites : généralités', 'retraites : régime agricole', 'retraites : régime général', 'retraites : régimes autonomes et spéciaux', 
    'risques professionnels', 'saisies et sûretés', 'sang et organes humains', 'santé', 'secteur public', 'sécurité publique', 
    'sécurité routière', 'sécurité sociale', 'services', 'sociétés', 'sports', 'syndicats', 'système pénitentiaire', 'taxis', 
    'télécommunications', 'tourisme et loisirs', 'traités et conventions', 'transports', 'transports aériens', 
    'transports ferroviaires', 'transports par eau', 'transports routiers', 'transports urbains', 'travail', 'TVA', 
    'Union européenne', 'urbanisme', 'ventes et échanges', 'voirie'
    ]


class QRANConfig(datasets.BuilderConfig):
    """BuilderConfig for QR-AN."""

    def __init__(self, **kwargs):
        """BuilderConfig for QR-AN.
        Args:
          **kwargs: keyword arguments forwarded to super.
        """
        super(QRANConfig, self).__init__(**kwargs)


class QRANDataset(datasets.GeneratorBasedBuilder):
    """QR-AN Dataset: Topic dataset on french Parliament questions-answers."""
    
    _DOWNLOAD_URL = "https://huggingface.co/datasets/cassandra-themis/QR-AN/resolve/main/"
    
    _TRAIN_FILE = "train_data.txt"
    _VAL_FILE = "val_data.txt"
    _TEST_FILE = "test_data.txt"
    _LABELS_DICT = {label: i for i, label in enumerate(_LABELS)}

    BUILDER_CONFIGS = [
        QRANConfig(
            name="qran_answer",
            version=datasets.Version("1.0.0"),
            description="QRAN Dataset: A classification task of French Parliament questions-answers",
        ),
        QRANConfig(
            name="qran_question",
            version=datasets.Version("1.0.0"),
            description="QRAN Dataset: A classification task of French Parliament questions-answers",
        ),
        QRANConfig(
            name="qran_full",
            version=datasets.Version("1.0.0"),
            description="QRAN Dataset: A classification task of French Parliament questions-answers",
        ),
        QRANConfig(
            name="qran_generation",
            version=datasets.Version("1.0.0"),
            description="QRAN Dataset: A generation task of French Parliament questions-answers",
        )
    ]

    DEFAULT_CONFIG_NAME = "qran_answer"

    def _info(self):
        if self.config.name == "qran_generation":
            features = {
                    "question": datasets.Value("string"),
                    "answer": datasets.Value("string"),
                }
        else:
            features = {
                    "text": datasets.Value("string"),
                    "label": datasets.features.ClassLabel(names=_LABELS),
                }
                
        return datasets.DatasetInfo(
            description=_DESCRIPTION,
            features=datasets.Features(features),
            supervised_keys=None,
            citation=_CITATION,
        )
        

    def _split_generators(self, dl_manager):
        train_path = dl_manager.download_and_extract(self._TRAIN_FILE)
        val_path = dl_manager.download_and_extract(self._VAL_FILE)
        test_path = dl_manager.download_and_extract(self._TEST_FILE)
        
        return [
            datasets.SplitGenerator(
                name=datasets.Split.TRAIN, gen_kwargs={"filepath": train_path}
            ),
            datasets.SplitGenerator(
                name=datasets.Split.VALIDATION, gen_kwargs={"filepath": val_path}
            ),
            datasets.SplitGenerator(
                name=datasets.Split.TEST, gen_kwargs={"filepath": test_path}
            ),
        ]
    
    def _generate_examples(self, filepath):
        """Generate QRAN examples."""
        with open(filepath, encoding="utf-8") as f:
            for id_, row in enumerate(f):
                data = json.loads(row)
                answer, question = data["answer"], data["question"]

                label = self._LABELS_DICT[data["label_name"]]

                if self.config.name == "qran_generation":
                    yield id_, {"question": question, "answer": answer}
                else:
                    if self.config.name == "qran_answer":
                        text = answer
                    elif self.config.name == "qran_question":
                        text = question
                    else:
                        text = question + " " + answer
                    yield id_, {"text": text, "label": label}