update refs

README.md

@@ -0,0 +1,197 @@
+---
+annotations_creators:
+- expert-generated
+language_creators:
+- found
+languages:
+- en
+licenses:
+- cc-by-4.0
+multilinguality:
+- monolingual
+pretty_name: Twitter Part-of-speech
+size_categories:
+- 10K<n<100K
+source_datasets:
+- original
+task_categories:
+- token-classification
+task_ids:
+- part-of-speech-tagging
+---
+
+# Dataset Card for "twitter-pos"
+
+## 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)
+  - [Annotations](#annotations)
+  - [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://gate.ac.uk/wiki/twitter-postagger.html](https://gate.ac.uk/wiki/twitter-postagger.html)
+- **Repository:** [https://github.com/GateNLP/gateplugin-Twitter](https://github.com/GateNLP/gateplugin-Twitter)
+- **Paper:** [https://aclanthology.org/D11-1141.pdf](https://aclanthology.org/D11-1141.pdf), [https://www.aaai.org/ocs/index.php/ws/aaaiw11/paper/download/3912/4191](https://www.aaai.org/ocs/index.php/ws/aaaiw11/paper/download/3912/4191)
+- **Point of Contact:** [Leon Derczynski](https://github.com/leondz)
+- **Size of downloaded dataset files:** 51.96 MiB
+- **Size of the generated dataset:** 251.22 KiB
+- **Total amount of disk used:** 52.05 MB
+
+### Dataset Summary
+
+Part-of-speech information is basic NLP task. However, Twitter text
+is difficult to part-of-speech tag: it is noisy, with linguistic errors and idiosyncratic style.
+This dataset contains two datasets for English PoS tagging for tweets:
+
+* Ritter, with train/dev/test
+* Foster, with dev/test
+
+Splits defined in the Derczynski paper, but the data is from Ritter and Foster.
+
+### Supported Tasks and Leaderboards
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Languages
+
+English, non-region-specific. `bcp47:en`
+
+## Dataset Structure
+
+### Data Instances
+
+An example of 'train' looks as follows.
+
+```
+
+```
+
+
+### Data Fields
+
+The data fields are the same among all splits.
+
+#### twitter-pos
+- `id`: a `string` feature.
+- `tokens`: a `list` of `string` features.
+- `pos_tags`: a `list` of classification labels (`int`). Full tagset with indices:
+
+```python
+
+```
+
+
+### Data Splits
+
+|  name   |tokens|sentences|
+|---------|----:|---------:|
+|ritter train|10652|551|
+|ritter dev  |2242|118|
+|ritter test |2291|118|
+|foster dev  |2998|270|
+|foster test |2841|250|
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+#### Who are the source language producers?
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+#### Who are the annotators?
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Personal and Sensitive Information
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Discussion of Biases
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Other Known Limitations
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+
+### Licensing Information
+
+
+### Citation Information
+
+```
+@inproceedings{ritter2011named,
+  title={Named entity recognition in tweets: an experimental study},
+  author={Ritter, Alan and Clark, Sam and Etzioni, Oren and others},
+  booktitle={Proceedings of the 2011 conference on empirical methods in natural language processing},
+  pages={1524--1534},
+  year={2011}
+}
+
+@inproceedings{foster2011hardtoparse,
+  title={\# hardtoparse: POS Tagging and Parsing the Twitterverse},
+  author={Foster, Jennifer and Cetinoglu, Ozlem and Wagner, Joachim and Le Roux, Joseph and Hogan, Stephen and Nivre, Joakim and Hogan, Deirdre and Van Genabith, Josef},
+  booktitle={Workshops at the Twenty-Fifth AAAI Conference on Artificial Intelligence},
+  year={2011}
+}
+
+@inproceedings{derczynski2013twitter,
+  title={Twitter part-of-speech tagging for all: Overcoming sparse and noisy data},
+  author={Derczynski, Leon and Ritter, Alan and Clark, Sam and Bontcheva, Kalina},
+  booktitle={Proceedings of the international conference recent advances in natural language processing ranlp 2013},
+  pages={198--206},
+  year={2013}
+}
+
+```
+
+
+### Contributions
+
+Author uploaded ([@leondz](https://github.com/leondz))

dataset_infos.json

@@ -0,0 +1 @@
+{"foster": {"description": "Part-of-speech information is basic NLP task. However, Twitter text\nis difficult to part-of-speech tag: it is noisy, with linguistic errors and idiosyncratic style.\nThis dataset contains two datasets for English PoS tagging for tweets:\n\n* Ritter, with train/dev/test\n* Foster, with dev/test\n\nFor more details see:\n\n* https://gate.ac.uk/wiki/twitter-postagger.html\n* https://aclanthology.org/D11-1141.pdf\n* https://www.aaai.org/ocs/index.php/ws/aaaiw11/paper/download/3912/4191\n", "citation": "@inproceedings{derczynski2013twitter,\n  title={Twitter part-of-speech tagging for all: Overcoming sparse and noisy data},\n  author={Derczynski, Leon and Ritter, Alan and Clark, Sam and Bontcheva, Kalina},\n  booktitle={Proceedings of the international conference recent advances in natural language processing ranlp 2013},\n  pages={198--206},\n  year={2013}\n}\n", "homepage": "https://gate.ac.uk/wiki/twitter-postagger.html", "license": "", "features": {"id": {"dtype": "string", "id": null, "_type": "Value"}, "tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "pos_tags": {"feature": {"num_classes": 52, "names": ["\"", "''", "#", "%", "$", "(", ")", ",", ".", ":", "``", "CC", "CD", "DT", "EX", "FW", "IN", "JJ", "JJR", "JJS", "LS", "MD", "NN", "NNP", "NNPS", "NNS", "NN|SYM", "PDT", "POS", "PRP", "PRP$", "RB", "RBR", "RBS", "RP", "SYM", "TO", "UH", "VB", "VBD", "VBG", "VBN", "VBP", "VBZ", "WDT", "WP", "WP$", "WRB", "RT", "HT", "USR", "URL"], "id": null, "_type": "ClassLabel"}, "length": -1, "id": null, "_type": "Sequence"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "twitter_pos", "config_name": "foster", "version": {"version_str": "0.0.0", "description": null, "major": 0, "minor": 0, "patch": 0}, "splits": {"validation": {"name": "validation", "num_bytes": 52293, "num_examples": 269, "dataset_name": "twitter_pos"}, "test": {"name": "test", "num_bytes": 49911, "num_examples": 250, "dataset_name": "twitter_pos"}}, "download_checksums": {"http://downloads.gate.ac.uk/twitie/twitie-tagger.zip": {"num_bytes": 54479912, "checksum": "8f536fe329bf2f0e9f442f21d6df7da524a0b168830675796a7a9b8568cf636d"}}, "download_size": 54479912, "post_processing_size": null, "dataset_size": 102204, "size_in_bytes": 54582116}, "ritter": {"description": "Part-of-speech information is basic NLP task. However, Twitter text\nis difficult to part-of-speech tag: it is noisy, with linguistic errors and idiosyncratic style.\nThis dataset contains two datasets for English PoS tagging for tweets:\n\n* Ritter, with train/dev/test\n* Foster, with dev/test\n\nFor more details see:\n\n* https://gate.ac.uk/wiki/twitter-postagger.html\n* https://aclanthology.org/D11-1141.pdf\n* https://www.aaai.org/ocs/index.php/ws/aaaiw11/paper/download/3912/4191\n", "citation": "@inproceedings{derczynski2013twitter,\n  title={Twitter part-of-speech tagging for all: Overcoming sparse and noisy data},\n  author={Derczynski, Leon and Ritter, Alan and Clark, Sam and Bontcheva, Kalina},\n  booktitle={Proceedings of the international conference recent advances in natural language processing ranlp 2013},\n  pages={198--206},\n  year={2013}\n}\n", "homepage": "https://gate.ac.uk/wiki/twitter-postagger.html", "license": "", "features": {"id": {"dtype": "string", "id": null, "_type": "Value"}, "tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "pos_tags": {"feature": {"num_classes": 52, "names": ["\"", "''", "#", "%", "$", "(", ")", ",", ".", ":", "``", "CC", "CD", "DT", "EX", "FW", "IN", "JJ", "JJR", "JJS", "LS", "MD", "NN", "NNP", "NNPS", "NNS", "NN|SYM", "PDT", "POS", "PRP", "PRP$", "RB", "RBR", "RBS", "RP", "SYM", "TO", "UH", "VB", "VBD", "VBG", "VBN", "VBP", "VBZ", "WDT", "WP", "WP$", "WRB", "RT", "HT", "USR", "URL"], "id": null, "_type": "ClassLabel"}, "length": -1, "id": null, "_type": "Sequence"}}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "twitter_pos", "config_name": "ritter", "version": {"version_str": "0.0.0", "description": null, "major": 0, "minor": 0, "patch": 0}, "splits": {"validation": {"name": "validation", "num_bytes": 38047, "num_examples": 118, "dataset_name": "twitter_pos"}, "test": {"name": "test", "num_bytes": 38899, "num_examples": 118, "dataset_name": "twitter_pos"}, "train": {"name": "train", "num_bytes": 180303, "num_examples": 551, "dataset_name": "twitter_pos"}}, "download_checksums": {"http://downloads.gate.ac.uk/twitie/twitie-tagger.zip": {"num_bytes": 54479912, "checksum": "8f536fe329bf2f0e9f442f21d6df7da524a0b168830675796a7a9b8568cf636d"}}, "download_size": 54479912, "post_processing_size": null, "dataset_size": 257249, "size_in_bytes": 54737161}}

twitter_pos.py

@@ -0,0 +1,223 @@
+# 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
+"""Introduction to the CoNLL-2003 Shared Task: Language-Independent Named Entity Recognition"""
+
+import os
+
+import datasets
+
+
+logger = datasets.logging.get_logger(__name__)
+
+
+_CITATION = """\
+@inproceedings{ritter2011named,
+  title={Named entity recognition in tweets: an experimental study},
+  author={Ritter, Alan and Clark, Sam and Etzioni, Oren and others},
+  booktitle={Proceedings of the 2011 conference on empirical methods in natural language processing},
+  pages={1524--1534},
+  year={2011}
+}
+
+@inproceedings{foster2011hardtoparse,
+  title={\# hardtoparse: POS Tagging and Parsing the Twitterverse},
+  author={Foster, Jennifer and Cetinoglu, Ozlem and Wagner, Joachim and Le Roux, Joseph and Hogan, Stephen and Nivre, Joakim and Hogan, Deirdre and Van Genabith, Josef},
+  booktitle={Workshops at the Twenty-Fifth AAAI Conference on Artificial Intelligence},
+  year={2011}
+}
+
+@inproceedings{derczynski2013twitter,
+  title={Twitter part-of-speech tagging for all: Overcoming sparse and noisy data},
+  author={Derczynski, Leon and Ritter, Alan and Clark, Sam and Bontcheva, Kalina},
+  booktitle={Proceedings of the international conference recent advances in natural language processing ranlp 2013},
+  pages={198--206},
+  year={2013}
+}
+"""
+
+_DESCRIPTION = """\
+Part-of-speech information is basic NLP task. However, Twitter text
+is difficult to part-of-speech tag: it is noisy, with linguistic errors and idiosyncratic style.
+This dataset contains two datasets for English PoS tagging for tweets:
+
+* Ritter, with train/dev/test
+* Foster, with dev/test
+
+Splits defined in the Derczynski paper, but the data is from Ritter and Foster.
+
+For more details see:
+
+* https://gate.ac.uk/wiki/twitter-postagger.html
+* https://aclanthology.org/D11-1141.pdf
+* https://www.aaai.org/ocs/index.php/ws/aaaiw11/paper/download/3912/4191
+"""
+
+_URL = "http://downloads.gate.ac.uk/twitie/twitie-tagger.zip"
+_RITTER_TRAIN = "twitie-tagger/corpora/ritter_train.stanford"
+_RITTER_DEV = "twitie-tagger/corpora/ritter_dev.stanford"
+_RITTER_TEST = "twitie-tagger/corpora/ritter_eval.stanford"
+_FOSTER_TRAIN = None
+_FOSTER_DEV = "twitie-tagger/corpora/foster_dev.stanford"
+_FOSTER_TEST = "twitie-tagger/corpora/foster_eval.stanford"
+
+
+class TwitterPosConfig(datasets.BuilderConfig):
+    """BuilderConfig for TwitterPos"""
+
+    def __init__(self, **kwargs):
+        """BuilderConfig for TwitterPos.
+
+        Args:
+          **kwargs: keyword arguments forwarded to super.
+        """
+        super(TwitterPosConfig, self).__init__(**kwargs)
+        #assert variant in ('foster', 'ritter'), (f'Unrecognised variation: {variant}')
+
+
+class TwitterPos(datasets.GeneratorBasedBuilder):
+    """TwitterPos dataset."""
+
+    BUILDER_CONFIGS = [
+        TwitterPosConfig(name="foster", description="Foster English Twitter PoS bootstrap dataset"),
+        TwitterPosConfig(name="ritter", description="Ritter English Twitter PoS bootstrap dataset"),
+    ]
+
+    def _info(self):
+        variant = self.config.name
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION,
+            features=datasets.Features(
+                {
+                    "id": datasets.Value("string"),
+                    "tokens": datasets.Sequence(datasets.Value("string")),
+                    "pos_tags": datasets.Sequence(
+                        datasets.features.ClassLabel(
+                            names=[
+                                '"',
+                                "''",
+                                "#",
+                                "%",
+                                "$",
+                                "(",
+                                ")",
+                                ",",
+                                ".",
+                                ":",
+                                "``",
+                                "CC",
+                                "CD",
+                                "DT",
+                                "EX",
+                                "FW",
+                                "IN",
+                                "JJ",
+                                "JJR",
+                                "JJS",
+                                "LS",
+                                "MD",
+                                "NN",
+                                "NNP",
+                                "NNPS",
+                                "NNS",
+                                "NN|SYM",
+                                "PDT",
+                                "POS",
+                                "PRP",
+                                "PRP$",
+                                "RB",
+                                "RBR",
+                                "RBS",
+                                "RP",
+                                "SYM",
+                                "TO",
+                                "UH",
+                                "VB",
+                                "VBD",
+                                "VBG",
+                                "VBN",
+                                "VBP",
+                                "VBZ",
+                                "WDT",
+                                "WP",
+                                "WP$",
+                                "WRB",
+                                "RT",
+                                "HT",
+                                "USR",
+                                "URL",
+                            ]
+                        )
+                    ),
+                }
+            ),
+            supervised_keys=None,
+            homepage="https://gate.ac.uk/wiki/twitter-postagger.html",
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        downloaded_file = dl_manager.download_and_extract(_URL)
+
+        if self.config.name == 'ritter':
+            data_files = {
+                "train": os.path.join(downloaded_file, _RITTER_TRAIN),
+                "dev": os.path.join(downloaded_file, _RITTER_DEV),
+                "test": os.path.join(downloaded_file, _RITTER_TEST),
+            }
+        elif self.config.name == 'foster':
+            data_files = {
+                "dev": os.path.join(downloaded_file, _FOSTER_DEV),
+                "test": os.path.join(downloaded_file, _FOSTER_TEST),
+            }
+
+        splits = [
+            datasets.SplitGenerator(name=datasets.Split.VALIDATION, gen_kwargs={"filepath": data_files["dev"]}),
+            datasets.SplitGenerator(name=datasets.Split.TEST, gen_kwargs={"filepath": data_files["test"]}),
+        ]
+
+        if "train" in data_files:
+            splits.append(datasets.SplitGenerator(name=datasets.Split.TRAIN, gen_kwargs={"filepath": data_files["train"]}))
+
+        return splits
+
+    def _generate_examples(self, filepath):
+        logger.info("⏳ Generating examples from = %s", filepath)
+        with open(filepath, encoding="utf-8") as f:
+            guid = 0
+            for line in f:
+                tokens = []
+                pos_tags = []
+                if line.startswith("-DOCSTART-") or line.strip() == "" or line == "\n":
+                    continue
+                else:
+                    line = line.replace('_VPB ', '_VBP ') # tag type fixes
+                    line = line.replace('_TD ', '_DT ') # tag type fixes
+                    line = line.replace('_ADVP ', '_RB ') # tag type fixes
+                    line = line.replace('_NONE ', '_: ') # tag type fixes
+                    line = line.replace(' please_VPP ', ' please_VBP ') # tag type fixes
+                    line = line.replace(' ".._O ', ' ".._" ') # tag type fixes
+                    # twitter-pos gives one seq per line, as token_tag
+                    annotated_words = line.strip().split(' ')
+                    tokens = ['_'.join(token.split('_')[:-1]) for token in annotated_words]
+                    pos_tags = [token.split('_')[-1] for token in annotated_words]
+                    yield guid, {
+                        "id": str(guid),
+                        "tokens": tokens,
+                        "pos_tags": pos_tags,
+                    }
+                    guid += 1