init

.gitignore

@@ -1,2 +1,3 @@
 super_tweeteval
-data
+data
+dataset/tweets/*.jsonline

process/tweet_corpus.py

@@ -0,0 +1,37 @@
+"""
+2018: 10,732,804
+2019: 9,725,094
+2020: 31,449,608
+2021: 37,282,461
+2022: 74,024,575
+"""
+import json
+import os
+
+files = [
+    "dataset/tweets/2018.jsonline",
+    "dataset/tweets/2019.jsonline",
+    "dataset/tweets/2020.jsonline",
+    "dataset/tweets/2021.jsonline",
+    "dataset/tweets/2022.jsonline"
+]
+n_shard = 10000
+root_dir = "dataset/tweets_sharded"
+
+os.makedirs(root_dir, exist_ok=True)
+counter = 0
+file_id = 0
+f_writer = open(f"{root_dir}/{file_id}.jsonl")
+for i in files:
+    with open(i) as f:
+        for line in f:
+            tmp = json.loads(line)
+            tmp = {"id": tmp["id"], "text": tmp["text"], "date": tmp["created_at"]}
+            f_writer.write(json.dumps(tmp) + '\n')
+            counter += 1
+            if counter > n_shard:
+                file_id += 1
+                counter = 0
+                f_writer.close()
+                f_writer = open(f"{root_dir}/{file_id}.jsonl")
+

process/tweet_ner.py

@@ -0,0 +1,96 @@
+import os
+import json
+from typing import List
+from datasets import load_dataset
+
+label2id = {
+    "B-corporation": 0,
+    "B-creative_work": 1,
+    "B-event": 2,
+    "B-group": 3,
+    "B-location": 4,
+    "B-person": 5,
+    "B-product": 6,
+    "I-corporation": 7,
+    "I-creative_work": 8,
+    "I-event": 9,
+    "I-group": 10,
+    "I-location": 11,
+    "I-person": 12,
+    "I-product": 13,
+    "O": 14
+}
+id2label = {v: k for k, v in label2id.items()}
+
+
+def decode_ner_tags(tag_sequence: List, input_sequence: List):
+    """ decode ner tag sequence """
+
+    def update_collection(_tmp_entity, _tmp_entity_type, _tmp_pos, _out):
+        if len(_tmp_entity) != 0 and _tmp_entity_type is not None:
+            _out.append({'type': _tmp_entity_type, 'entity': _tmp_entity, 'position': _tmp_pos})
+            _tmp_entity = []
+            _tmp_entity_type = None
+        return _tmp_entity, _tmp_entity_type, _tmp_pos, _out
+
+    assert len(tag_sequence) == len(input_sequence), str([len(tag_sequence), len(input_sequence)])
+    out = []
+    tmp_entity = []
+    tmp_pos = []
+    tmp_entity_type = None
+    for n, (_l, _i) in enumerate(zip(tag_sequence, input_sequence)):
+        _l = id2label[_l]
+        if _l.startswith('B-'):
+            _, _, _, out = update_collection(tmp_entity, tmp_entity_type, tmp_pos, out)
+            tmp_entity_type = '-'.join(_l.split('-')[1:])
+            tmp_entity = [_i]
+            tmp_pos = [n]
+        elif _l.startswith('I-'):
+            tmp_tmp_entity_type = '-'.join(_l.split('-')[1:])
+            if len(tmp_entity) == 0:
+                # if 'I' not start with 'B', skip it
+                tmp_entity, tmp_entity_type, tmp_pos, out = update_collection(tmp_entity, tmp_entity_type, tmp_pos, out)
+            elif tmp_tmp_entity_type != tmp_entity_type:
+                # if the type does not match with the B, skip
+                tmp_entity, tmp_entity_type, tmp_pos, out = update_collection(tmp_entity, tmp_entity_type, tmp_pos, out)
+            else:
+                tmp_entity.append(_i)
+                tmp_pos.append(n)
+        elif _l == 'O':
+            tmp_entity, tmp_entity_type, tmp_pos, out = update_collection(tmp_entity, tmp_entity_type, tmp_pos, out)
+        else:
+            raise ValueError('unknown tag: {}'.format(_l))
+    _, _, _, out = update_collection(tmp_entity, tmp_entity_type, tmp_pos, out)
+    return out
+
+data = load_dataset("tner/tweetner7")
+
+
+def process(tmp):
+    tmp = [i.to_dict() for _, i in tmp.iterrows()]
+    for i in tmp:
+        tokens = ["@" + t.replace("{@", "").replace("@}", "").replace(" ", "_") if t.startswith("{@") else t
+                  for t in i.pop('tokens')]
+        entities = []
+        for e in decode_ner_tags(i.pop('tags').tolist(), tokens):
+            entities.append(f'{" ".join(e["entity"])} ({e["type"]})')
+        i['text'] = " ".join(tokens).replace("{{USERNAME}}", "@user").replace("{{URL}}", "{URL}")
+        i['condition'] = f'Entities: {", ".join(entities)}'
+    return tmp
+
+
+train = process(data["train_2020"].to_pandas())
+train += process(data["train_2021"].to_pandas())
+val = process(data["validation_2020"].to_pandas())
+val += process(data["validation_2021"].to_pandas())
+test = process(data["test_2021"].to_pandas())
+os.makedirs("dataset/ner", exist_ok=True)
+with open("dataset/ner/train.jsonl", "w") as f:
+    f.write("\n".join([json.dumps(i) for i in train]))
+with open("dataset/ner/validation.jsonl", "w") as f:
+    f.write("\n".join([json.dumps(i) for i in val]))
+with open("dataset/ner/test.jsonl", "w") as f:
+    f.write("\n".join([json.dumps(i) for i in test]))
+
+
+

process/tweet_qa.py

@@ -0,0 +1,31 @@
+import os
+import json
+from datasets import load_dataset
+
+data = load_dataset("lmqg/qg_tweetqa")
+
+
+def process(tmp):
+    tmp = [i.to_dict() for _, i in tmp.iterrows()]
+    for i in tmp:
+        i.pop('paragraph_question')
+        i.pop('question')
+        i['text'] = i.pop("paragraph")
+        i['condition'] = f'Keyword: {i.pop("answer")}'
+    tmp = [i for i in tmp if 'http' not in i['text']]
+    return tmp
+
+
+train = process(data["train"].to_pandas())
+val = process(data["validation"].to_pandas())
+test = process(data["test"].to_pandas())
+os.makedirs("dataset/qa", exist_ok=True)
+with open("dataset/qa/train.jsonl", "w") as f:
+    f.write("\n".join([json.dumps(i) for i in train]))
+with open("dataset/qa/validation.jsonl", "w") as f:
+    f.write("\n".join([json.dumps(i) for i in val]))
+with open("dataset/qa/test.jsonl", "w") as f:
+    f.write("\n".join([json.dumps(i) for i in test]))
+
+
+

process/tweet_topic.py

@@ -0,0 +1,38 @@
+import os
+import json
+import re
+from datasets import load_dataset
+
+os.makedirs("data/tweet_topic", exist_ok=True)
+data = load_dataset("cardiffnlp/tweet_topic_multi")
+re_user = re.compile(r'{@[^@^}]*@}')
+
+
+def process(tmp):
+    tmp = [i.to_dict() for _, i in tmp.iterrows()]
+    for i in tmp:
+        i.pop("label")
+        text = i['text']
+        users = re_user.findall(text)
+        for u in users:
+            text = text.replace(u, u.replace("{@", "@").replace("@}", "").replace(" ", "_"))
+        text = text.replace("{{USERNAME}}", "@user").replace("{{URL}}", "{URL}")
+        i['text'] = text
+        i['condition'] = f'Topics: {", ".join([x.replace("_", " ") for x in i.pop("label_name")])}'
+    return tmp
+
+train = process(data["train_2020"].to_pandas())
+train += process(data["train_2021"].to_pandas())
+val = process(data["validation_2020"].to_pandas())
+val += process(data["validation_2021"].to_pandas())
+test = process(data["test_2021"].to_pandas())
+os.makedirs("dataset/topic", exist_ok=True)
+with open("dataset/topic/train.jsonl", "w") as f:
+    f.write("\n".join([json.dumps(i) for i in train]))
+with open("dataset/topic/validation.jsonl", "w") as f:
+    f.write("\n".join([json.dumps(i) for i in val]))
+with open("dataset/topic/test.jsonl", "w") as f:
+    f.write("\n".join([json.dumps(i) for i in test]))
+
+
+

process/tweet_topic_ner.py

@@ -0,0 +1,20 @@
+import json
+import pandas as pd
+import os
+
+os.makedirs("dataset/topic_ner", exist_ok=True)
+for s in ["test.jsonl", "train.jsonl", "validation.jsonl"]:
+    with open(f"dataset/topic/{s}") as f:
+        topic = pd.DataFrame([json.loads(i) for i in f.read().split("\n") if len(i) > 0])
+    with open(f"dataset/ner/{s}") as f:
+        ner = pd.DataFrame([json.loads(i) for i in f.read().split("\n") if len(i) > 0])
+    topic.index = topic.pop("id")
+    ner.index = ner.pop("id")
+    df_merge = pd.merge(topic, ner, left_index=True, right_index=True)
+    df_merge['text'] = df_merge.pop("text_x")
+    df_merge['date'] = df_merge.pop("date_x")
+    df_merge.pop("text_y")
+    df_merge.pop("date_y")
+    df_merge['condition'] = df_merge.pop("condition_x") + " \n" + df_merge.pop("condition_y")
+    with open(f"dataset/topic_ner/{s}", "w") as f:
+        f.write("\n".join([json.dumps(i) for i in df_merge.T.to_dict().values()]))

tweet_generation.py

@@ -0,0 +1,184 @@
+"""Tweet Generation Dataset."""
+import json
+import datasets
+
+_VERSION = "0.0.0"
+_TWEET_GENERATION_DESCRIPTION = """"""
+_TWEET_GENERATION_CITATION = """"""
+
+_TWEET_CORPUS_DESCRIPTION = """Unlabeled tweet corpus ranging from 2018 to 2022."""
+_TWEET_CORPUS_CITATION = """\
+@inproceedings{loureiro-etal-2022-timelms,
+    title = "{T}ime{LM}s: Diachronic Language Models from {T}witter",
+    author = "Loureiro, Daniel  and
+      Barbieri, Francesco  and
+      Neves, Leonardo  and
+      Espinosa Anke, Luis  and
+      Camacho-collados, Jose",
+    editor = "Basile, Valerio  and
+      Kozareva, Zornitsa  and
+      Stajner, Sanja",
+    booktitle = "Proceedings of the 60th Annual Meeting of the Association for Computational Linguistics: System Demonstrations",
+    month = may,
+    year = "2022",
+    address = "Dublin, Ireland",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2022.acl-demo.25",
+    doi = "10.18653/v1/2022.acl-demo.25",
+    pages = "251--260",
+    abstract = "Despite its importance, the time variable has been largely neglected in the NLP and language model literature. In this paper, we present TimeLMs, a set of language models specialized on diachronic Twitter data. We show that a continual learning strategy contributes to enhancing Twitter-based language models{'} capacity to deal with future and out-of-distribution tweets, while making them competitive with standardized and more monolithic benchmarks. We also perform a number of qualitative analyses showing how they cope with trends and peaks in activity involving specific named entities or concept drift. TimeLMs is available at github.com/cardiffnlp/timelms.",
+}
+"""
+_TWEET_TOPIC_DESCRIPTION = """
+TweetTopic is a multi-label twitter topic classification task, where each example consists of a tweet 
+and a set of topics. One tweet can be associated with multiple topics, and the training/validation tweets are taken 
+from September 2019 to August 2020, while the test tweets are taken from September 2020 to August 2021.
+Following the original work, we evaluate with macro F1 score."""
+_TWEET_TOPIC_CITATION = """\
+@inproceedings{antypas-etal-2022-twitter,
+    title = "{T}witter Topic Classification",
+    author = "Antypas, Dimosthenis  and
+      Ushio, Asahi  and
+      Camacho-Collados, Jose  and
+      Silva, Vitor  and
+      Neves, Leonardo  and
+      Barbieri, Francesco",
+    booktitle = "Proceedings of the 29th International Conference on Computational Linguistics",
+    month = oct,
+    year = "2022",
+    address = "Gyeongju, Republic of Korea",
+    publisher = "International Committee on Computational Linguistics",
+    url = "https://aclanthology.org/2022.coling-1.299",
+    pages = "3386--3400",
+    abstract = "Social media platforms host discussions about a wide variety of topics that arise everyday. Making sense of all the content and organising it into categories is an arduous task. A common way to deal with this issue is relying on topic modeling, but topics discovered using this technique are difficult to interpret and can differ from corpus to corpus. In this paper, we present a new task based on tweet topic classification and release two associated datasets. Given a wide range of topics covering the most important discussion points in social media, we provide training and testing data from recent time periods that can be used to evaluate tweet classification models. Moreover, we perform a quantitative evaluation and analysis of current general- and domain-specific language models on the task, which provide more insights on the challenges and nature of the task.",
+}
+"""
+_TWEET_NER7_DESCRIPTION = """
+TweetNER is a named-entity recognition dataset on Twitter. The training/validation tweets are taken 
+from September 2019 to August 2020, while the test tweets are taken from September 2020 to August 2021.
+Following the original work, we evaluate with span F1 score.
+"""
+_TWEET_NER7_CITATION = """\
+@inproceedings{ushio-etal-2022-named,
+    title = "Named Entity Recognition in {T}witter: A Dataset and Analysis on Short-Term Temporal Shifts",
+    author = "Ushio, Asahi  and
+      Barbieri, Francesco  and
+      Sousa, Vitor  and
+      Neves, Leonardo  and
+      Camacho-Collados, Jose",
+    booktitle = "Proceedings of the 2nd Conference of the Asia-Pacific Chapter of the Association for Computational Linguistics and the 12th International Joint Conference on Natural Language Processing (Volume 1: Long Papers)",
+    month = nov,
+    year = "2022",
+    address = "Online only",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2022.aacl-main.25",
+    pages = "309--319",
+    abstract = "Recent progress in language model pre-training has led to important improvements in Named Entity Recognition (NER). Nonetheless, this progress has been mainly tested in well-formatted documents such as news, Wikipedia, or scientific articles. In social media the landscape is different, in which it adds another layer of complexity due to its noisy and dynamic nature. In this paper, we focus on NER in Twitter, one of the largest social media platforms, and construct a new NER dataset, TweetNER7, which contains seven entity types annotated over 11,382 tweets from September 2019 to August 2021. The dataset was constructed by carefully distributing the tweets over time and taking representative trends as a basis. Along with the dataset, we provide a set of language model baselines and perform an analysis on the language model performance on the task, especially analyzing the impact of different time periods. In particular, we focus on three important temporal aspects in our analysis: short-term degradation of NER models over time, strategies to fine-tune a language model over different periods, and self-labeling as an alternative to lack of recently-labeled data. TweetNER7 is released publicly (https://huggingface.co/datasets/tner/tweetner7) along with the models fine-tuned on it (NER models have been integrated into TweetNLP and can be found at https://github.com/asahi417/tner/tree/master/examples/tweetner7{\_}paper).",
+}
+"""
+_TWEET_NERD_DESCRIPTION = """TBA"""
+_TWEET_NERD_CITATION = """\
+@article{mishra2022tweetnerd,
+  title={TweetNERD--End to End Entity Linking Benchmark for Tweets},
+  author={Mishra, Shubhanshu and Saini, Aman and Makki, Raheleh and Mehta, Sneha and Haghighi, Aria and Mollahosseini, Ali},
+  journal={arXiv preprint arXiv:2210.08129},
+  year={2022}
+}
+"""
+_TWEET_SENTIMENT_DESCRIPTION = """TBA"""
+_TWEET_SENTIMENT_CITATION = """\
+TBA
+"""
+_ROOT_URL = "https://huggingface.co/datasets/cardiffnlp/tweet_generation/resolve/main/dataset"
+
+
+class TweetGenerationConfig(datasets.BuilderConfig):
+    """BuilderConfig for TweetGeneration."""
+
+    def __init__(self, features, data_url, citation, label_classes=("False", "True"), **kwargs):
+        """BuilderConfig for TweetGeneration.
+
+        Args:
+          features: `list[string]`, list of the features that will appear in the
+            feature dict. Should not include "label".
+          data_url: `string`, url to download the zip file from.
+          citation: `string`, citation for the data set.
+          url: `string`, url for information about the data set.
+          label_classes: `list[string]`, the list of classes for the label if the
+            label is present as a string. Non-string labels will be cast to either
+            "False" or "True".
+          **kwargs: keyword arguments forwarded to super.
+        """
+        super(TweetGenerationConfig, self).__init__(version=datasets.Version(_VERSION), **kwargs)
+        self.features = features
+        self.label_classes = label_classes
+        self.data_url = data_url
+        self.citation = citation
+
+
+class TweetGeneration(datasets.GeneratorBasedBuilder):
+    """The TweetGeneration benchmark."""
+
+    BUILDER_CONFIGS = [
+        TweetGenerationConfig(
+            name="tweet_corpus",
+            description=_TWEET_CORPUS_DESCRIPTION,
+            citation=_TWEET_CORPUS_CITATION,
+            features=["id", "text", "date"],
+            data_url=f"{_ROOT_URL}/tweet",
+        )
+    ]
+
+    def _info(self):
+        features = {feature: datasets.Value("string") for feature in self.config.features}
+        if "topic" in self.config.name:
+            names = [
+                "arts_&_culture", "business_&_entrepreneurs", "celebrity_&_pop_culture", "diaries_&_daily_life",
+                "family", "fashion_&_style", "film_tv_&_video", "fitness_&_health", "food_&_dining", "gaming",
+                "learning_&_educational", "music", "news_&_social_concern", "other_hobbies", "relationships",
+                "science_&_technology", "sports", "travel_&_adventure", "youth_&_student_life"]
+            features["gold_label_list"] = datasets.Sequence(
+                datasets.features.ClassLabel(names=names))
+        elif "sentiment" in self.config.name:
+            features["text"] = datasets.Value("string")
+            features["gold_label_binary"] = datasets.Value("int32")
+            features["date"] = datasets.Value("string")
+        elif "nerd" in self.config.name:
+            features["target"] = datasets.Value("string")
+            features["text"] = datasets.Value("string")
+            features["definition"] = datasets.Value("string")
+            features["text_start"] = datasets.Value("int32")
+            features["text_end"] = datasets.Value("int32")
+            features["gold_label_binary"] = datasets.Value("int32")
+            features["date"] = datasets.Value("string")
+        elif "ner" in self.config.name:
+            names = [
+                "B-corporation", "B-creative_work", "B-event", "B-group", "B-location", "B-person", "B-product",
+                "I-corporation", "I-creative_work", "I-event", "I-group", "I-location", "I-person", "I-product", "O"]
+            features["gold_label_sequence"] = datasets.Sequence(datasets.features.ClassLabel(names=names))
+            features["text_tokenized"] = datasets.Sequence(datasets.Value("string"))
+            features["entities"] = datasets.features.Sequence(
+                {"entity": datasets.Value("string"), "type": datasets.Value("string")}
+            )
+        return datasets.DatasetInfo(
+            description=_TWEET_GENERATION_DESCRIPTION + "\n" + self.config.description,
+            features=datasets.Features(features),
+            citation=self.config.citation + "\n" + _TWEET_GENERATION_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        splits = ["train", "test", "validation"]
+        if "temporal" in self.config.name:
+            splits += ["test_1", "test_2", "test_3", "test_4"]
+        downloaded_file = dl_manager.download_and_extract(
+            {s: f"{self.config.data_url}/{s}.jsonl" for s in splits})
+        return [datasets.SplitGenerator(name=s, gen_kwargs={"filepath": downloaded_file[s]}) for s in splits]
+
+    def _generate_examples(self, filepath):
+        _key = 0
+        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

util.py

@@ -1,13 +0,0 @@
-import re
-
-
-URL_RE = re.compile(r"https?:\/\/[\w\.\/\?\=\d&#%_:/-]+")
-HANDLE_RE = re.compile(r"@\w+")
-with open("verified_users.v091122.txt") as f:
-    USER = set(i for i in f.read().split("\n") if len(i))
-
-def process_url(text: str) -> str:
-    return URL_RE.sub("{URL}", text)
-
-def process_username(text: str) -> str:
-    return HANDLE_RE.sub("[URL]", text)