init

README.md

@@ -0,0 +1,72 @@
+---
+language:
+- en
+license:
+- other
+multilinguality:
+- monolingual
+size_categories:
+- 10K<n<100K
+task_categories:
+- token-classification
+task_ids:
+- named-entity-recognition
+pretty_name: MIT Restaurant
+---
+
+# Dataset Card for "tner/mit_restaurant"
+
+## Dataset Description
+
+- **Repository:** [T-NER](https://github.com/asahi417/tner)
+- **Paper:** [https://aclanthology.org/U15-1010.pdf](https://aclanthology.org/U15-1010.pdf)
+- **Dataset:** MIT restaurant
+- **Domain:** Restaurant
+- **Number of Entity:** 8
+
+### Dataset Summary
+MIT Restaurant NER dataset formatted in a part of [TNER](https://github.com/asahi417/tner) project.
+
+- Entity Types: `Rating`, `Amenity`, `Location`, `Restaurant_Name`, `Price`, `Hours`, `Dish`, `Cuisine`.
+
+## Dataset Structure
+
+### Data Instances
+An example of `train` looks as follows.
+
+```
+{
+    "tags": [0, 0, 0, 0, 0, 3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
+    "tokens": ["1", ".", "1", ".", "4", "Borrower", "engages", "in", "criminal", "conduct", "or", "is", "involved", "in", "criminal", "activities", ";"]
+}
+```
+
+### Label ID
+The label2id dictionary can be found at [here](https://huggingface.co/datasets/tner/mit_restaurant/raw/main/dataset/label.json).
+```python
+{
+    "O": 0,
+    "B-Rating": 1,
+    "I-Rating": 2,
+    "B-Amenity": 3,
+    "I-Amenity": 4,
+    "B-Location": 5,
+    "I-Location": 6,
+    "B-Restaurant_Name": 7,
+    "I-Restaurant_Name": 8,
+    "B-Price": 9,
+    "B-Hours": 10,
+    "I-Hours": 11,
+    "B-Dish": 12,
+    "I-Dish": 13,
+    "B-Cuisine": 14,
+    "I-Price": 15,
+    "I-Cuisine": 16
+}
+```
+
+### Data Splits
+
+|  name   |train|validation|test|
+|---------|----:|---------:|---:|
+|mit_restaurant      |6899  |       759| 1520|

dataset/label.json

@@ -0,0 +1 @@
+{"O": 0, "B-Rating": 1, "I-Rating": 2, "B-Amenity": 3, "I-Amenity": 4, "B-Location": 5, "I-Location": 6, "B-Restaurant_Name": 7, "I-Restaurant_Name": 8, "B-Price": 9, "B-Hours": 10, "I-Hours": 11, "B-Dish": 12, "I-Dish": 13, "B-Cuisine": 14, "I-Price": 15, "I-Cuisine": 16}

mit_restaurant.py

@@ -0,0 +1,67 @@
+""" NER dataset compiled by T-NER library https://github.com/asahi417/tner/tree/master/tner """
+import json
+from itertools import chain
+import datasets
+
+logger = datasets.logging.get_logger(__name__)
+_DESCRIPTION = """[mit_restaurant NER dataset](https://groups.csail.mit.edu/sls/downloads/)"""
+_NAME = "mit_restaurant"
+_VERSION = "1.0.0"
+
+_HOME_PAGE = "https://github.com/asahi417/tner"
+_URL = f'https://huggingface.co/datasets/tner/{_NAME}/raw/main/dataset'
+_URLS = {
+    str(datasets.Split.TEST): [f'{_URL}/test.json'],
+    str(datasets.Split.TRAIN): [f'{_URL}/train.json'],
+    str(datasets.Split.VALIDATION): [f'{_URL}/valid.json'],
+}
+
+
+class MITRestaurantConfig(datasets.BuilderConfig):
+    """BuilderConfig"""
+
+    def __init__(self, **kwargs):
+        """BuilderConfig.
+
+        Args:
+          **kwargs: keyword arguments forwarded to super.
+        """
+        super(MITRestaurantConfig, self).__init__(**kwargs)
+
+
+class MITRestaurant(datasets.GeneratorBasedBuilder):
+    """Dataset."""
+
+    BUILDER_CONFIGS = [
+        MITRestaurantConfig(name=_NAME, version=datasets.Version(_VERSION), description=_DESCRIPTION),
+    ]
+
+    def _split_generators(self, dl_manager):
+        downloaded_file = dl_manager.download_and_extract(_URLS)
+        return [datasets.SplitGenerator(name=i, gen_kwargs={"filepaths": downloaded_file[str(i)]})
+                for i in [datasets.Split.TRAIN, datasets.Split.VALIDATION, datasets.Split.TEST]]
+
+    def _generate_examples(self, filepaths):
+        _key = 0
+        for filepath in filepaths:
+            logger.info(f"generating examples from = {filepath}")
+            with open(filepath, encoding="utf-8") as f:
+                _list = [i for i in f.read().split('\n') if len(i) > 0]
+                for i in _list:
+                    data = json.loads(i)
+                    yield _key, data
+                    _key += 1
+
+    def _info(self):
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "tokens": datasets.Sequence(datasets.Value("string")),
+                    "tags": datasets.Sequence(datasets.Value("int32")),
+                }
+            ),
+            supervised_keys=None,
+            homepage=_HOME_PAGE,
+            citation=_CITATION,
+        )