update

README.md

@@ -0,0 +1,89 @@
+---
+language:
+- en
+license:
+- other
+multilinguality:
+- monolingual
+size_categories:
+- 1k<10K
+task_categories:
+- token-classification
+task_ids:
+- named-entity-recognition
+pretty_name: WNUT 2017
+---
+
+# Dataset Card for "tner/wnut2017"
+
+## Dataset Description
+
+- **Repository:** [T-NER](https://github.com/asahi417/tner)
+- **Paper:** [https://aclanthology.org/W17-4418/](https://aclanthology.org/W17-4418/)
+- **Dataset:** WNUT 2017
+- **Domain:** Twitter, Reddit, YouTube, and StackExchange
+- **Number of Entity:** 6
+
+
+### Dataset Summary
+WNUT 2017 NER dataset formatted in a part of [TNER](https://github.com/asahi417/tner) project.
+- Entity Types: `creative-work`, `corporation`, `group`, `location`, `person`, `product`
+
+## Dataset Structure
+
+### Data Instances
+An example of `train` looks as follows.
+
+```
+{
+    'tokens': ['@paulwalk', 'It', "'s", 'the', 'view', 'from', 'where', 'I', "'m", 'living', 'for', 'two', 'weeks', '.', 'Empire', 'State', 'Building', '=', 'ESB', '.', 'Pretty', 'bad', 'storm', 'here', 'last', 'evening', '.'],
+    'tags': [12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 12, 3, 9, 9, 12, 3, 12, 12, 12, 12, 12, 12, 12, 12]
+}
+```
+
+### Label ID
+The label2id dictionary can be found at [here](https://huggingface.co/datasets/tner/wnut2017/raw/main/dataset/label.json).
+```python
+{
+    "B-corporation": 0,
+    "B-creative-work": 1,
+    "B-group": 2,
+    "B-location": 3,
+    "B-person": 4,
+    "B-product": 5,
+    "I-corporation": 6,
+    "I-creative-work": 7,
+    "I-group": 8,
+    "I-location": 9,
+    "I-person": 10,
+    "I-product": 11,
+    "O": 12
+}
+```
+
+### Data Splits
+
+|  name   |train|validation|test|
+|---------|----:|---------:|---:|
+|wnut2017 | 2395|      1009|1287|
+
+### Citation Information
+
+```
+@inproceedings{derczynski-etal-2017-results,
+    title = "Results of the {WNUT}2017 Shared Task on Novel and Emerging Entity Recognition",
+    author = "Derczynski, Leon  and
+      Nichols, Eric  and
+      van Erp, Marieke  and
+      Limsopatham, Nut",
+    booktitle = "Proceedings of the 3rd Workshop on Noisy User-generated Text",
+    month = sep,
+    year = "2017",
+    address = "Copenhagen, Denmark",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/W17-4418",
+    doi = "10.18653/v1/W17-4418",
+    pages = "140--147",
+    abstract = "This shared task focuses on identifying unusual, previously-unseen entities in the context of emerging discussions. Named entities form the basis of many modern approaches to other tasks (like event clustering and summarization), but recall on them is a real problem in noisy text - even among annotators. This drop tends to be due to novel entities and surface forms. Take for example the tweet {``}so.. kktny in 30 mins?!{''} {--} even human experts find the entity {`}kktny{'} hard to detect and resolve. The goal of this task is to provide a definition of emerging and of rare entities, and based on that, also datasets for detecting these entities. The task as described in this paper evaluated the ability of participating entries to detect and classify novel and emerging named entities in noisy text.",
+}
+```

tweebank_ner.py

@@ -0,0 +1,86 @@
+""" 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 = """[Tweebank NER](https://arxiv.org/abs/2201.07281)"""
+_NAME = "tweebank_ner"
+_VERSION = "1.0.0"
+_CITATION = """
+@article{DBLP:journals/corr/abs-2201-07281,
+  author    = {Hang Jiang and
+               Yining Hua and
+               Doug Beeferman and
+               Deb Roy},
+  title     = {Annotating the Tweebank Corpus on Named Entity Recognition and Building
+               {NLP} Models for Social Media Analysis},
+  journal   = {CoRR},
+  volume    = {abs/2201.07281},
+  year      = {2022},
+  url       = {https://arxiv.org/abs/2201.07281},
+  eprinttype = {arXiv},
+  eprint    = {2201.07281},
+  timestamp = {Fri, 21 Jan 2022 13:57:15 +0100},
+  biburl    = {https://dblp.org/rec/journals/corr/abs-2201-07281.bib},
+  bibsource = {dblp computer science bibliography, https://dblp.org}
+}
+"""
+
+_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 TweebankNERConfig(datasets.BuilderConfig):
+    """BuilderConfig"""
+
+    def __init__(self, **kwargs):
+        """BuilderConfig.
+
+        Args:
+          **kwargs: keyword arguments forwarded to super.
+        """
+        super(TweebankNERConfig, self).__init__(**kwargs)
+
+
+class TweebankNER(datasets.GeneratorBasedBuilder):
+    """Dataset."""
+
+    BUILDER_CONFIGS = [
+        TweebankNERConfig(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,
+        )