Update files from the datasets library (from 1.6.0)

Release notes: https://github.com/huggingface/datasets/releases/tag/1.6.0

.gitattributes

@@ -0,0 +1,27 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bin.* filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zstandard filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,233 @@
+---
+annotations_creators:
+- found
+language_creators:
+- found
+languages:
+- en
+licenses:
+- cc-by-nc-sa-4-0
+multilinguality:
+- monolingual
+size_categories:
+- 10K<n<100K
+source_datasets:
+- original
+task_categories:
+- text-retrieval
+task_ids:
+- document-retrieval
+- text-retrieval-other-document-to-document-retrieval
+---
+
+# Dataset Card for the RegIR datasets
+
+## Table of Contents
+- [Dataset Card for the RegIR datasets](#dataset-card-for-ecthr-cases)
+  - [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)
+      - [Initial Data Collection and Normalization](#initial-data-collection-and-normalization)
+      - [Who are the source language producers?](#who-are-the-source-language-producers)
+    - [Annotations](#annotations)
+      - [Annotation process](#annotation-process)
+      - [Who are the annotators?](#who-are-the-annotators)
+    - [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:** https://archive.org/details/eacl2021_regir_datasets
+- **Repository:** https://archive.org/details/eacl2021_regir_datasets
+- **Paper:** https://arxiv.org/abs/2101.10726
+- **Leaderboard:** N/A
+- **Point of Contact:** [Ilias Chalkidis](mailto:ihalk@aueb.gr)
+
+### Dataset Summary
+
+The European Union (EU) has a legislation scheme analogous to regulatory compliance for organizations. According to the Treaty on the Functioning of the European Union (TFEU), all published EU directives must take effect at the national level. Thus, all EU member states must adopt a law to transpose a newly issued directive within the period set by the directive (typically 2 years).
+
+Here, we have two datasets, EU2UK and UK2EU, containing EU directives and UK regulations, which can serve both as queries and documents under the ground truth assumption that a UK law is relevant to the EU directives it transposes and vice versa.
+
+
+
+### Supported Tasks and Leaderboards
+
+The dataset supports:
+
+**EU2UK** (`eu2uk`): Given an EU directive *Q*, retrieve the set of relevant documents from the pool of all available UK regulations. Relevant documents are those that transpose the EU directive (*Q*).
+
+**UK2EU** (`uk2eu`): Given a UK regulation *Q*, retrieve the set of relevant documents from the pool of all available EU directives. Relevant documents are those that are being transposed by the UK regulations (*Q*).
+
+
+### Languages
+
+All documents are written in English.
+
+## Dataset Structure
+
+### Data Instances
+
+```json
+{
+  "document_id": "31977L0794",
+  "publication_year": "1977",
+  "text": "Commission Directive 77/794/EEC ... of agricultural levies and customs duties",
+  "relevant_documents": ["UKPGA19800048", "UKPGA19770036"]
+}
+```
+
+### Data Fields
+
+The following data fields are provided for query documents (`train`, `dev`, `test`):
+
+`document_id`: (**str**) The ID of the document.\
+`publication_year`: (**str**) The publication year of the document.\
+`text`: (**str**) The text of the document.\
+`relevant_documents`: (**List[str]**)  The list of relevant documents, as represented by their `document_id`.
+
+The following data fields are provided for corpus documents (`corpus`):
+
+`document_id`: (**str**) The ID of the document.\
+`publication_year`: (**str**) The publication year of the document.\
+`text`: (**str**) The text of the document.\
+
+### Data Splits
+
+#### EU2UK dataset
+
+| Split         | No of Queries                        | Avg. relevant documents |
+| ------------------- | ------------------------------------  |  --- |
+| Train | 1,400 | 1.79 |
+|Development | 300 | 2.09 |
+|Test | 300  | 1.74 |
+Document Pool (Corpus): 52,515 UK regulations
+
+#### UK2EU dataset
+
+| Split         | No of Queries                         | Avg. relevant documents |
+| ------------------- | ------------------------------------  |  --- |
+| Train | 1,500 | 1.90 |
+|Development | 300 | 1.46 |
+|Test | 300  | 1.29 |
+Document Pool (Corpus): 3,930 EU directives
+
+## Dataset Creation
+
+### Curation Rationale
+
+The dataset was curated by Chalkidis et al. (2021).\
+The transposition pairs are publicly available by the Publications Office of EU (https://publications.europa.eu/en).
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+The original data are available at EUR-Lex portal (https://eur-lex.europa.eu) and Legislation.GOV.UK (http://legislation.gov.uk/) in an unprocessed format.\
+The transposition pairs are provided by the EU member states (in our case, UK) and were downloaded from the SPARQL endpoint of the Publications Office of EU (http://publications.europa.eu/webapi/rdf/sparql).\
+For more information on the dataset curation, read Chalkidis et al. (2021).
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation process
+
+* The original data are available at EUR-Lex portal (https://eur-lex.europa.eu) and Legislation.GOV.UK (http://legislation.gov.uk/) in an unprocessed format.
+* The transposition pairs are provided by the EU member states (in our case, UK) and were downloaded from the SPARQL endpoint of the Publications Office of EU (http://publications.europa.eu/webapi/rdf/sparql).
+
+
+#### Who are the annotators?
+
+Publications Office of EU (https://publications.europa.eu/en)
+
+### Personal and Sensitive Information
+
+The dataset does not include personal or sensitive information.
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+Chalkidis et al. (2021)
+
+### Licensing Information
+
+**EU Data**
+
+© European Union, 1998-2021
+
+The Commission’s document reuse policy is based on Decision 2011/833/EU. Unless otherwise specified, you can re-use the legal documents published in EUR-Lex for commercial or non-commercial purposes.
+
+The copyright for the editorial content of this website, the summaries of EU legislation and the consolidated texts, which is owned by the EU, is licensed under the Creative Commons Attribution 4.0 International licence​​ . This means that you can re-use the content provided you acknowledge the source and indicate any changes you have made.
+
+Source: https://eur-lex.europa.eu/content/legal-notice/legal-notice.html \
+Read more:  https://eur-lex.europa.eu/content/help/faq/reuse-contents-eurlex.html
+
+**UK Data**
+
+You are encouraged to use and re-use the Information that is available under this licence freely and flexibly, with only a few conditions.
+
+You are free to:
+
+- copy, publish, distribute and transmit the Information;
+- adapt the Information;
+- exploit the Information commercially and non-commercially for example, by combining it with other Information, or by including it in your own product or application.
+
+You must (where you do any of the above):
+
+acknowledge the source of the Information in your product or application by including or linking to any attribution statement specified by the Information Provider(s) and, where possible, provide a link to this licence: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/.
+
+### Citation Information
+
+*Ilias Chalkidis, Manos Fergadiotis, Nikos Manginas, Eva Katakalou and Prodromos Malakasiotis.*
+*Regulatory Compliance through Doc2Doc Information Retrieval: A case study in EU/UK legislation where text similarity has limitations* 
+*Proceedings of the 16th Conference of the European Chapter of the Association for Computational Linguistics (EACL 2021). Online. 2021*
+```
+@inproceedings{chalkidis-etal-2021-regir,
+    title = "Regulatory Compliance through Doc2Doc Information Retrieval: A case study in EU/UK legislation where text similarity has limitations",
+    author = "Chalkidis, Ilias  and Fergadiotis, Manos and Manginas, Nikos and Katakalou, Eva,  and Malakasiotis, Prodromos",
+    booktitle = "Proceedings of the 16th Conference of the European Chapter of the Association for Computational Linguistics (EACL 2021)",
+    year = "2021",
+    address = "Online",
+    publisher = "Association for Computational Linguistics",
+    url = "https://arxiv.org/abs/2101.10726",
+}
+```
+
+### Contributions
+
+Thanks to [@iliaschalkidis](https://github.com/iliaschalkidis) for adding this dataset.

dataset_infos.json

@@ -0,0 +1 @@
+{"eu2uk": {"description": "EURegIR: Regulatory Compliance IR (EU/UK)\n", "citation": "@inproceedings{chalkidis-etal-2021-regir,\n    title = \"Regulatory Compliance through Doc2Doc Information Retrieval: A case study in EU/UK legislation where text similarity has limitations\",\n    author = \"Chalkidis, Ilias  and Fergadiotis, Emmanouil and Manginas, Nikos and Katakalou, Eva,  and Malakasiotis, Prodromos\",\n    booktitle = \"Proceedings of the 16th Conference of the European Chapter of the Association for Computational Linguistics (EACL 2021)\",\n    year = \"2021\",\n    address = \"Online\",\n    publisher = \"Association for Computational Linguistics\",\n    url = \"https://arxiv.org/abs/2101.10726\",\n}\n", "homepage": "https://archive.org/details/eacl2021_regir_dataset", "license": "CC BY-SA (Creative Commons / Attribution-ShareAlike)", "features": {"document_id": {"dtype": "string", "id": null, "_type": "Value"}, "publication_year": {"dtype": "string", "id": null, "_type": "Value"}, "text": {"dtype": "string", "id": null, "_type": "Value"}, "relevant_documents": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}}, "post_processed": null, "supervised_keys": null, "builder_name": "eu_regulatory_ir", "config_name": "eu2uk", "version": {"version_str": "1.1.0", "description": null, "major": 1, "minor": 1, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 20665038, "num_examples": 1400, "dataset_name": "eu_regulatory_ir"}, "test": {"name": "test", "num_bytes": 8844145, "num_examples": 300, "dataset_name": "eu_regulatory_ir"}, "validation": {"name": "validation", "num_bytes": 5852814, "num_examples": 300, "dataset_name": "eu_regulatory_ir"}, "uk_corpus": {"name": "uk_corpus", "num_bytes": 502468359, "num_examples": 52515, "dataset_name": "eu_regulatory_ir"}}, "download_checksums": {"https://archive.org/download/eacl2021_regir_datasets/eu2uk.zip": {"num_bytes": 119685577, "checksum": "8afc26fbd3559aa800ce0adb3c35c0e4c2c99b93529bc20d5f32ce44f55ba286"}}, "download_size": 119685577, "post_processing_size": null, "dataset_size": 537830356, "size_in_bytes": 657515933}, "uk2eu": {"description": "EURegIR: Regulatory Compliance IR (EU/UK)\n", "citation": "@inproceedings{chalkidis-etal-2021-regir,\n    title = \"Regulatory Compliance through Doc2Doc Information Retrieval: A case study in EU/UK legislation where text similarity has limitations\",\n    author = \"Chalkidis, Ilias  and Fergadiotis, Emmanouil and Manginas, Nikos and Katakalou, Eva,  and Malakasiotis, Prodromos\",\n    booktitle = \"Proceedings of the 16th Conference of the European Chapter of the Association for Computational Linguistics (EACL 2021)\",\n    year = \"2021\",\n    address = \"Online\",\n    publisher = \"Association for Computational Linguistics\",\n    url = \"https://arxiv.org/abs/2101.10726\",\n}\n", "homepage": "https://archive.org/details/eacl2021_regir_dataset", "license": "CC BY-SA (Creative Commons / Attribution-ShareAlike)", "features": {"document_id": {"dtype": "string", "id": null, "_type": "Value"}, "publication_year": {"dtype": "string", "id": null, "_type": "Value"}, "text": {"dtype": "string", "id": null, "_type": "Value"}, "relevant_documents": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}}, "post_processed": null, "supervised_keys": null, "builder_name": "eu_regulatory_ir", "config_name": "uk2eu", "version": {"version_str": "1.1.0", "description": null, "major": 1, "minor": 1, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 55144655, "num_examples": 1500, "dataset_name": "eu_regulatory_ir"}, "test": {"name": "test", "num_bytes": 14810460, "num_examples": 300, "dataset_name": "eu_regulatory_ir"}, "validation": {"name": "validation", "num_bytes": 15175644, "num_examples": 300, "dataset_name": "eu_regulatory_ir"}, "eu_corpus": {"name": "eu_corpus", "num_bytes": 57212422, "num_examples": 3930, "dataset_name": "eu_regulatory_ir"}}, "download_checksums": {"https://archive.org/download/eacl2021_regir_datasets/uk2eu.zip": {"num_bytes": 31835104, "checksum": "767d4edc0c5210b80ccf24c31a6d28a62b64edffc69810f7027d34b0e1401194"}}, "download_size": 31835104, "post_processing_size": null, "dataset_size": 142343181, "size_in_bytes": 174178285}}

dummy/eu2uk/1.1.0/dummy_data.zip

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

dummy/uk2eu/1.1.0/dummy_data.zip

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

eu_regulatory_ir.py

@@ -0,0 +1,149 @@
+# coding=utf-8
+# 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.
+"""EURegIR: Regulatory Compliance IR (EU/UK)"""
+
+
+import json
+import os
+
+import datasets
+
+
+_CITATION = """\
+@inproceedings{chalkidis-etal-2021-regir,
+    title = "Regulatory Compliance through Doc2Doc Information Retrieval: A case study in EU/UK legislation where text similarity has limitations",
+    author = "Chalkidis, Ilias  and Fergadiotis, Emmanouil and Manginas, Nikos and Katakalou, Eva,  and Malakasiotis, Prodromos",
+    booktitle = "Proceedings of the 16th Conference of the European Chapter of the Association for Computational Linguistics (EACL 2021)",
+    year = "2021",
+    address = "Online",
+    publisher = "Association for Computational Linguistics",
+    url = "https://arxiv.org/abs/2101.10726",
+}
+"""
+
+_DESCRIPTION = """\
+EURegIR: Regulatory Compliance IR (EU/UK)
+"""
+
+_HOMEPAGE = "https://archive.org/details/eacl2021_regir_dataset"
+
+_LICENSE = "CC BY-SA (Creative Commons / Attribution-ShareAlike)"
+
+_URLs = {
+    "eu2uk": "https://archive.org/download/eacl2021_regir_datasets/eu2uk.zip",
+    "uk2eu": "https://archive.org/download/eacl2021_regir_datasets/uk2eu.zip",
+}
+
+
+class EuRegulatoryIr(datasets.GeneratorBasedBuilder):
+    """EURegIR: Regulatory Compliance IR (EU/UK)"""
+
+    VERSION = datasets.Version("1.1.0")
+
+    BUILDER_CONFIGS = [
+        datasets.BuilderConfig(name="eu2uk", version=VERSION, description="EURegIR: Regulatory Compliance IR (EU2UK)"),
+        datasets.BuilderConfig(name="uk2eu", version=VERSION, description="EURegIR: Regulatory Compliance IR (UK2EU)"),
+    ]
+
+    def _info(self):
+        if self.config.name == "eu2uk":
+            features = datasets.Features(
+                {
+                    "document_id": datasets.Value("string"),
+                    "publication_year": datasets.Value("string"),
+                    "text": datasets.Value("string"),
+                    "relevant_documents": datasets.features.Sequence(datasets.Value("string")),
+                }
+            )
+        else:
+            features = datasets.Features(
+                {
+                    "document_id": datasets.Value("string"),
+                    "publication_year": datasets.Value("string"),
+                    "text": datasets.Value("string"),
+                    "relevant_documents": datasets.features.Sequence(datasets.Value("string")),
+                }
+            )
+        return datasets.DatasetInfo(
+            # This is the description that will appear on the datasets page.
+            description=_DESCRIPTION,
+            # This defines the different columns of the dataset and their types
+            features=features,  # Here we define them above because they are different between the two configurations
+            # If there's a common (input, target) tuple from the features,
+            # specify them here. They'll be used if as_supervised=True in
+            # builder.as_dataset.
+            supervised_keys=None,
+            # Homepage of the dataset for documentation
+            homepage=_HOMEPAGE,
+            # License for the dataset if available
+            license=_LICENSE,
+            # Citation for the dataset
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        my_urls = _URLs[self.config.name]
+        data_dir = dl_manager.download_and_extract(my_urls)
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={
+                    "filepath": os.path.join(data_dir, "train.jsonl"),
+                    "split": "train",
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.TEST,
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={"filepath": os.path.join(data_dir, "test.jsonl"), "split": "test"},
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.VALIDATION,
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={
+                    "filepath": os.path.join(data_dir, "dev.jsonl"),
+                    "split": "dev",
+                },
+            ),
+            datasets.SplitGenerator(
+                name=f"{self.config.name.split('2')[1]}_corpus",
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={
+                    "filepath": os.path.join(data_dir, "corpus.jsonl"),
+                    "split": f"{self.config.name.split('2')[1]}_corpus",
+                },
+            ),
+        ]
+
+    def _generate_examples(
+        self, filepath, split  # method parameters are unpacked from `gen_kwargs` as given in `_split_generators`
+    ):
+        """ Yields examples as (key, example) tuples. """
+        # This method handles input defined in _split_generators to yield (key, example) tuples from the dataset.
+        # The `key` is here for legacy reason (tfds) and is not important in itself.
+
+        with open(filepath, encoding="utf-8") as f:
+            for id_, row in enumerate(f):
+                data = json.loads(row)
+                yield id_, {
+                    "document_id": data["document_id"],
+                    "text": data["text"],
+                    "publication_year": data["publication_year"],
+                    "relevant_documents": data["relevant_documents"]
+                    if split != f"{self.config.name.split('2')[1]}_corpus"
+                    else [],
+                }