First commit

.gitattributes

@@ -35,3 +35,6 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.mp3 filter=lfs diff=lfs merge=lfs -text
 *.ogg filter=lfs diff=lfs merge=lfs -text
 *.wav filter=lfs diff=lfs merge=lfs -text
+production.csv filter=lfs diff=lfs merge=lfs -text
+training.csv filter=lfs diff=lfs merge=lfs -text
+validation.csv filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,142 @@
+---
+annotations_creators:
+- expert-generated
+language_creators:
+- expert-generated
+languages:
+- en
+licenses:
+- mit
+multilinguality:
+- monolingual
+pretty_name: named-entity-recognition-en-no-drift
+size_categories:
+- 10K<n<100K
+source_datasets:
+- extended|xtreme
+task_categories:
+- token-classification
+task_ids:
+- named-entity-recognition
+---
+
+# Dataset Card for `reviews_with_drift`
+
+## 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
+
+### Dataset Summary
+
+This dataset was crafted to be used in our tutorial [Link to the tutorial when ready]. It consists on a large Movie Review Dataset mixed with some reviews from a Hotel Review Dataset. The training/validation set are purely obtained from the Movie Review Dataset while the production set is mixed. Some other features have been added (`age`, `gender`, `context`) as well as a made up timestamp `prediction_ts` of when the inference took place.
+
+### Supported Tasks and Leaderboards
+
+`text-classification`, `sentiment-classification`: The dataset is mainly used for text classification: given the text, predict the sentiment (positive or negative).
+
+### Languages
+
+Text is mainly written in english.
+
+## Dataset Structure
+
+### Data Instances
+
+[More Information Needed]
+
+### Data Fields
+
+[More Information Needed]
+
+### Data Splits
+
+[More Information Needed]
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+[More Information Needed]
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+[More Information Needed]
+
+#### 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]
+
+### Contributions
+
+Thanks to [@fjcasti1](https://github.com/fjcasti1) for adding this dataset.

production.csv

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:06d7431536d120a42c555e4414ce4d6be0760f372563957a083003d2ecbefc55
+size 1587547

training.csv

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f60a5c81f0e655a8b38c8b9896d108955094221c7d74b9319da61bbb7f76065e
+size 512786

validation.csv

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:39bacac56bc48b4d0ff15d3cb670b958c6abc16c76b5a7be90c4195969be7880
+size 72245

xtreme_en_token_drift.py

@@ -0,0 +1,177 @@
+# Copyright 2020 The HuggingFace Datasets Authors and the current dataset script contributor.
+#
+# 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
+"""IMDb movie revies dataset mixed with Trip Advisor Hotel Reviews to simulate drift accross time."""
+
+
+import csv
+import json
+import os
+
+import datasets
+from datasets.tasks import TextClassification
+
+
+
+# TODO: Add BibTeX citation to our BLOG
+# Find for instance the citation on arxiv or on the dataset repo/website
+_CITATION = ""
+# _CITATION = """\
+# @InProceedings{huggingface:dataset,
+# title = {A great new dataset},
+# author={huggingface, Inc.
+# },
+# year={2020}
+# }
+# """
+
+# TODO: Add description of the dataset here
+# You can copy an official description
+_DESCRIPTION = """\
+This dataset was crafted to be used in our tutorial [Link to the tutorial when
+ready]. It consists on product reviews from an e-commerce store. The reviews
+are labeled on a scale from 1 to 5 (stars). The training & validation sets are
+fully composed by reviews written in english. However, the production set has
+some reviews written in spanish. At Arize, we work to surface this issue and
+help you solve it.
+"""
+
+# TODO: Add a link to an official homepage for the dataset here
+_HOMEPAGE = ""
+
+# TODO: Add the licence for the dataset here if you can find it
+_LICENSE = ""
+
+# TODO: Add link to the official dataset URLs here
+# The HuggingFace Datasets library doesn't host the datasets but only points to the original files.
+# This can be an arbitrary nested dict/list of URLs (see below in `_split_generators` method)
+_URL = "https://huggingface.co/datasets/arize-ai/xtreme_en_token_drift/resolve/main/"
+_URLS = {
+    "training": _URL + "training.csv",
+    "validation": _URL + "validation.csv",
+    "production": _URL + "production.csv",
+}
+
+
+# TODO: Name of the dataset usually match the script name with CamelCase instead of snake_case
+class XtremeNEREnEs(datasets.GeneratorBasedBuilder):
+    """TODO: Short description of my dataset."""
+
+    VERSION = datasets.Version("1.0.0")
+
+    # This is an example of a dataset with multiple configurations.
+    # If you don't want/need to define several sub-sets in your dataset,
+    # just remove the BUILDER_CONFIG_CLASS and the BUILDER_CONFIGS attributes.
+
+    # If you need to make complex sub-parts in the datasets with configurable options
+    # You can create your own builder configuration class to store attribute, inheriting from datasets.BuilderConfig
+    # BUILDER_CONFIG_CLASS = MyBuilderConfig
+
+    # You will be able to load one or the other configurations in the following list with
+    # data = datasets.load_dataset('my_dataset', 'first_domain')
+    # data = datasets.load_dataset('my_dataset', 'second_domain')
+    BUILDER_CONFIGS = [
+        datasets.BuilderConfig(name="default", version=VERSION, description="Default"),
+    ]
+
+    DEFAULT_CONFIG_NAME = "default"  # It's not mandatory to have a default configuration. Just use one if it make sense.
+
+    def _info(self):
+        # This method specifies the datasets.DatasetInfo object which contains informations and typings for the dataset
+        features = datasets.Features(
+            # These are the features of your dataset like images, labels ...
+            {
+                "prediction_ts": datasets.Value("float"),
+                "language":datasets.Value("string"),
+                "split_text": datasets.Sequence(datasets.Value("string")),
+                "ner_tags": datasets.Sequence(
+                    datasets.features.ClassLabel(
+                        names=[
+                            "O",
+                            "B-PER",
+                            "I-PER",
+                            "B-ORG",
+                            "I-ORG",
+                            "B-LOC",
+                            "I-LOC",
+                        ]
+                    )
+                ),
+            }
+        )
+
+        return datasets.DatasetInfo(
+            # This is the description that will appear on the datasets page.
+            description=_DESCRIPTION,
+            # This defines the different columns of the dataset and their types
+            features=features,  # Here we define them above because they are different between the two configurations
+            # Homepage of the dataset for documentation
+            # License for the dataset if available
+            license=_LICENSE,
+            # Citation for the dataset
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        # This method is tasked with downloading/extracting the data and defining the splits depending on the configuration
+        # If several configurations are possible (listed in BUILDER_CONFIGS), the configuration selected by the user is in self.config.name
+
+        # dl_manager is a datasets.download.DownloadManager that can be used to download and extract URLS
+        # It can accept any type or nested list/dict and will give back the same structure with the url replaced with path to local files.
+        # By default the archives will be extracted and a path to a cached folder where they are extracted is returned instead of the archive
+        extracted_paths = dl_manager.download_and_extract(_URLS)
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split("training"),
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={
+                    "filepath": extracted_paths['training'],
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split("validation"),
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={
+                    "filepath": extracted_paths['validation'],
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split("production"),
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={
+                    "filepath": extracted_paths['production'],
+                },
+            ),
+        ]
+
+
+    # method parameters are unpacked from `gen_kwargs` as given in `_split_generators`
+    def _generate_examples(self, filepath):
+        # This method handles input defined in _split_generators to yield (key, example) tuples from the dataset.
+        # The `key` is for legacy reasons (tfds) and is not important in itself, but must be unique for each example.
+        with open(filepath) as csv_file:
+            csv_reader = csv.reader(csv_file, delimiter='\t')
+            for id_, row in enumerate(csv_reader):
+                prediction_ts,language,text,ner_tags = row
+                ner_tags_list = list(ner_tags.strip('[]').split(' '))
+                tokens = text.split(":-:")
+                if id_==0:
+                    continue
+                yield id_, {
+                    "prediction_ts":prediction_ts,
+                    "language":language,
+                    "split_text": tokens,
+                    "ner_tags":ner_tags_list,
+                }