added setup.py

README.md

@@ -0,0 +1,167 @@
+---
+annotations_creators:
+  - machine-generated
+language:
+  - en
+  - de
+language_creators:
+  - crowdsourced
+license:
+  - apache-2.0
+multilinguality:
+  - multilingual
+pretty_name: tweetyface_debug
+size_categories:
+  - 10K<n<100K
+source_datasets: []
+tags: []
+task_categories:
+  - text-generation
+task_ids: []
+---
+
+# DEBUG Dataset Card for "tweetyface"
+
+## Table of Contents
+
+- [Table of Contents](#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:**
+- **Repository:** [GitHub](https://github.com/ml-projects-kiel/OpenCampus-ApplicationofTransformers)
+
+### Dataset Summary
+
+DEBUG
+
+### Supported Tasks and Leaderboards
+
+[More Information Needed]
+
+### Languages
+
+English, German
+
+## Dataset Structure
+
+### Data Instances
+
+#### english
+
+- **Size of downloaded dataset files:** 4.77 MB
+- **Size of the generated dataset:** 5.92 MB
+- **Total amount of disk used:** 4.77 MB
+
+#### german
+
+- **Size of downloaded dataset files:** 2.58 MB
+- **Size of the generated dataset:** 3.10 MB
+- **Total amount of disk used:** 2.59 MB
+
+An example of 'validation' looks as follows.
+
+```
+{
+  "text": "@SpaceX @Space_Station About twice as much useful mass to orbit as rest of Earth combined",
+  "label": elonmusk,
+  "idx": 1001283
+}
+```
+
+### Data Fields
+
+The data fields are the same among all splits and languages.
+
+- `text`: a `string` feature.
+- `label`: a classification label
+- `idx`: an `string` feature.
+- `ref_tweet`: a `bool` feature.
+- `reply_tweet`: a `bool` feature.
+
+### Data Splits
+
+| name    | train | validation |
+| ------- | ----: | ---------: |
+| english | 27857 |       6965 |
+| german  | 10254 |       2564 |
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+[More Information Needed]
+
+### Citation Information
+
+[More Information Needed]

tweetyface_debug.py

@@ -0,0 +1,132 @@
+# coding=utf-8
+# Copyright 2020 The TensorFlow Datasets Authors and the HuggingFace NLP 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
+"""tweetyface dataset."""
+
+
+import json
+
+import datasets
+
+_DESCRIPTION = """\
+DEBUG DATASET
+"""
+
+_HOMEPAGE = "https://github.com/ml-projects-kiel/OpenCampus-ApplicationofTransformers"
+
+URL = "https://raw.githubusercontent.com/ml-projects-kiel/OpenCampus-ApplicationofTransformers/qa/develop/"
+
+_URLs = {
+    "english": {
+        "train": URL + "tweetyface_en/train.json",
+        "validation": URL + "tweetyface_en/validation.json",
+    },
+    "german": {
+        "train": URL + "tweetyface_de/train.json",
+        "validation": URL + "tweetyface_de/validation.json",
+    },
+}
+
+_VERSION = "0.3.0"
+
+_LICENSE = """
+Apache License Version 2.0
+"""
+
+
+class TweetyFaceConfig(datasets.BuilderConfig):
+    """BuilderConfig for TweetyFace."""
+
+    def __init__(self, **kwargs):
+        """BuilderConfig for TweetyFace.
+
+        Args:
+          **kwargs: keyword arguments forwarded to super.
+        """
+        super(TweetyFaceConfig, self).__init__(**kwargs)
+
+
+class TweetyFace(datasets.GeneratorBasedBuilder):
+    """tweetyface"""
+
+    BUILDER_CONFIGS = [
+        TweetyFaceConfig(
+            name=lang,
+            description=f"{lang.capitalize()} Twitter Users",
+            version=datasets.Version(_VERSION),
+        )
+        for lang in _URLs.keys()
+    ]
+
+    def _info(self):
+        if self.config.name == "english":
+            names = [
+                "MKBHD",
+                "elonmusk",
+                "alyankovic",
+                "Cristiano",
+                "katyperry",
+                "neiltyson",
+                "BillGates",
+                "BillNye",
+                "GretaThunberg",
+                "BarackObama",
+                "Trevornoah",
+            ]
+        else:
+            names = [
+                "OlafScholz",
+                "Karl_Lauterbach",
+                "janboehm",
+                "Markus_Soeder",
+            ]
+        return datasets.DatasetInfo(
+            description=_DESCRIPTION + self.config.description,
+            features=datasets.Features(
+                {
+                    "text": datasets.Value("string"),
+                    "label": datasets.features.ClassLabel(names=names),
+                    "idx": datasets.Value("string"),
+                    "ref_tweet": datasets.Value("bool"),
+                    "reply_tweet": datasets.Value("bool"),
+                }
+            ),
+            homepage=_HOMEPAGE,
+            license=_LICENSE,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+        my_urls = _URLs[self.config.name]
+        data_dir = dl_manager.download_and_extract(my_urls)
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                gen_kwargs={"filepath": data_dir["train"]},
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.VALIDATION,
+                gen_kwargs={"filepath": data_dir["validation"]},
+            ),
+        ]
+
+    def _generate_examples(self, filepath):
+        """This function returns the examples in the raw (text) form by iterating on all the files."""
+        with open(filepath, encoding="utf-8") as f:
+            for row in f:
+                data = json.loads(row)
+                idx = data["idx"]
+                yield idx, data