swiss_legislation.py

# Copyright 2020 The HuggingFace Datasets Authors and the current dataset script contributor.
#
# 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.

import json
import lzma
import os

import datasets
try:
    import lzma as xz
except ImportError:
    import pylzma as xz


# TODO: Add BibTeX citation
# Find for instance the citation on arxiv or on the dataset repo/website
_CITATION = """\
@InProceedings{huggingface:dataset,
title = {A great new dataset},
author={huggingface, Inc.
},
year={2020}
}
"""

# You can copy an official description
_DESCRIPTION = """\
This dataset contains Swiss law articles
"""

_URLS = {
    "full": "https://huggingface.co/datasets/rcds/swiss_legislation/resolve/main",
}


class SwissLegilation(datasets.GeneratorBasedBuilder):
    """This dataset contains court decision for doc2doc information retrieval task."""


    BUILDER_CONFIGS = [
        datasets.BuilderConfig(name="full", description="This part covers the whole dataset"),
    ]

    DEFAULT_CONFIG_NAME = "full"  # It's not mandatory to have a default configuration. Just use one if it make sense.

    def _info(self):
        if self.config.name == "full": 
            features = datasets.Features(
                {
                    "canton": datasets.Value("string"),
                    "language": datasets.Value("string"),
                    "uuid": datasets.Value("string"),
                    "title": datasets.Value("string"),
                    "short": datasets.Value("string"),
                    "abbreviation": datasets.Value("string"),
                    "sr_number": datasets.Value("string"),
                    "pdf_content": datasets.Value("string")
                }
            )
        return datasets.DatasetInfo(
            description=_DESCRIPTION,
            features=features,  # Here we define them above because they are different between the two configurations
        )

    def _split_generators(self, dl_manager):
        urls = _URLS[self.config.name]
        filepath = dl_manager.download(os.path.join(urls, "lexfind_v2.jsonl.xz"))
        return [
            datasets.SplitGenerator(
                name=datasets.Split.TRAIN,
                # These kwargs will be passed to _generate_examples
                gen_kwargs={
                    "filepath": filepath,
                    "split": "train",
                },
            )
        ]

    # method parameters are unpacked from `gen_kwargs` as given in `_split_generators`
    def _generate_examples(self, filepath, split):
        # The `key` is for legacy reasons (tfds) and is not important in itself, but must be unique for each example.
        line_counter = 0
        try:
            with xz.open(open(filepath, "rb"), "rt", encoding="utf-8") as f:
                for id, line in enumerate(f):
                    line_counter += 1
                    if line:
                        data = json.loads(line)
                        if self.config.name == "full":
                            yield id, {
                                "canton": data["canton"],
                                "language": data["language"],
                                "uuid": data["uuid"],
                                "short": data["short"],
                                "title": data["title"],
                                "abbreviation": data["abbreviation"],
                                "sr_number": data["sr_number"],
                                "pdf_content": data["pdf_content"],
                            }
        except lzma.LZMAError as e:
            print(split, e)
            if line_counter == 0:
                raise e