Add dataset script

uk_legal_ner.py

@@ -0,0 +1,125 @@
+# coding=utf-8
+# Copyright 2020 HuggingFace Datasets Authors.
+#
+# 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.
+
+# Lint as: python3
+
+import os
+
+import datasets
+
+
+logger = datasets.logging.get_logger(__name__)
+
+
+_CITATION = """\
+"""
+
+_DESCRIPTION = """\
+"""
+
+_URL = "https://../.zip"
+_TRAINING_FILE = "train.json"
+_DEV_FILE = "valid.json"
+_TEST_FILE = "test.json"
+
+
+class UKlegalNERConfig(datasets.BuilderConfig):
+    """BuilderConfig for uk_legal_ner"""
+
+    def __init__(self, **kwargs):
+        """BuilderConfig for uk_legal_ner.
+
+        Args:
+          **kwargs: keyword arguments forwarded to super.
+        """
+        super(UKlegalNERConfig, self).__init__(**kwargs)
+
+
+class UKlegalNER(datasets.GeneratorBasedBuilder):
+    """uk_legal_ner dataset."""
+
+    BUILDER_CONFIGS = [
+        UKlegalNERConfig(name="uk_legal_ner", version=datasets.Version("0.0.1"), description="uk-legal-ner dataset"),
+    ]
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "id": datasets.Value("string"),
+                    "tokens": datasets.Sequence(datasets.Value("string")),
+                    "ner_tags": datasets.Sequence(
+                        datasets.features.ClassLabel(
+                            names=[
+                                "O",
+                                "CLAUSE_NUMBER",
+                                "CLAUSE_TITLE",
+                                "CONTRACT_TYPE",
+                                "DEFINITION_TITLE",
+                            ]
+                        )
+                    ),
+                }
+            ),
+            supervised_keys=None,
+            homepage="",
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        downloaded_file = dl_manager.download_and_extract(_URL)
+        data_files = {
+            "train": os.path.join(downloaded_file, _TRAINING_FILE),
+            "dev": os.path.join(downloaded_file, _DEV_FILE),
+            "test": os.path.join(downloaded_file, _TEST_FILE),
+        }
+
+        return [
+            datasets.SplitGenerator(name=datasets.Split.TRAIN, gen_kwargs={"filepath": data_files["train"]}),
+            datasets.SplitGenerator(name=datasets.Split.VALIDATION, gen_kwargs={"filepath": data_files["dev"]}),
+            datasets.SplitGenerator(name=datasets.Split.TEST, gen_kwargs={"filepath": data_files["test"]}),
+        ]
+
+    def _generate_examples(self, filepath):
+        logger.info("⏳ Generating examples from = %s", filepath)
+        with open(filepath, encoding="utf-8") as f:
+            guid = 0
+            tokens = []
+            ner_tags = []
+            for line in f:
+                if line.startswith("-DOCSTART-") or line == "" or line == "\n":
+                    if tokens:
+                        yield guid, {
+                            "id": str(guid),
+                            "tokens": tokens,
+                            "ner_tags": ner_tags,
+                        }
+                        guid += 1
+                        tokens = []
+                        ner_tags = []
+                else:
+                    # conll2003 tokens are space separated
+                    splits = line.split(" ")
+                    tokens.append(splits[0])
+                    ner_tags.append(splits[3].rstrip())
+            # last example
+            if tokens:
+                yield guid, {
+                    "id": str(guid),
+                    "tokens": tokens,
+                    "ner_tags": ner_tags,
+                }