Update files from the datasets library (from 1.2.0)

Release notes: https://github.com/huggingface/datasets/releases/tag/1.2.0

.gitattributes

@@ -0,0 +1,27 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bin.* filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zstandard filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,277 @@
+---
+annotations_creators:
+- machine-generated
+language_creators:
+- crowdsourced
+languages:
+- en
+licenses:
+- unknown
+multilinguality:
+- monolingual
+size_categories:
+- 1K<n<10K
+source_datasets:
+- original
+task_categories:
+- sequence-modeling
+task_ids:
+- dialogue-modeling
+---
+
+# Dataset Card Creation Guide
+
+## Table of Contents
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-instances)
+  - [Data Splits](#data-instances)
+- [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)
+
+## Dataset Description
+
+- **Homepage:** [Decoupling Strategy and Generation in Negotiation Dialogues](https://worksheets.codalab.org/worksheets/0x453913e76b65495d8b9730d41c7e0a0c/)
+- **Repository:** [Github: Stanford NLP Cocoa](https://github.com/stanfordnlp/cocoa/tree/master)
+- **Paper:** [Decoupling Strategy and Generation in Negotiation Dialogues](https://arxiv.org/abs/1808.09637)
+- **Leaderboard:** []()
+- **Point of Contact:** [He He]([email protected])
+
+### Dataset Summary
+
+We study negotiation dialogues where two agents, a buyer and a seller, negotiate over the price of an time for sale. We collected a dataset of more than 6K negotiation dialogues over multiple categories of products scraped from Craigslist. Our goal is to develop an agent that negotiates with humans through such conversations. The challenge is to handle both the negotiation strategy and the rich language for bargaining. To this end, we develop a modular framework which separates strategy learning from language generation. Specifically, we learn strategies in a coarse dialogue act space and instantiate that into utterances conditioned on dialogue history. 
+
+### Supported Tasks and Leaderboards
+
+
+
+### Languages
+
+This dataset is English
+
+## Dataset Structure
+
+### Data Instances
+
+```
+{
+  'agent_info': {
+    'Bottomline': 
+      [
+        'None', 
+        'None'
+      ],
+    'Role': 
+      [
+        'buyer', 
+        'seller'
+      ],
+    'Target': 
+      [
+        7.0, 
+        10.0
+      ]
+  },
+  'agent_turn': 
+    [
+      0, 
+      1, 
+      ...
+    ],
+  'dialogue_acts': {
+    'intent': 
+      [
+        'init-price',
+        'unknown',
+        ...
+      ],
+    'price': 
+      [
+        5.0, 
+        -1.0, 
+        ...
+        ]
+    },
+  'items': {
+    'Category': 
+      [
+        'phone', 
+        'phone'
+      ],
+    'Description': 
+      [
+        'Charge two devices simultaneously on the go..., 
+        ...
+      ],
+    'Images': 
+      [
+        'phone/6149527852_0.jpg', 
+        'phone/6149527852_0.jpg'
+      ],
+    'Price': 
+      [
+        10.0, 
+        10.0
+      ],
+    'Title': 
+      [
+        'Verizon Car Charger with Dual Output Micro USB and ...', 
+        ...
+      ]
+    },
+  'utterance': 
+    [
+      'Hi, not sure if the charger would work for my car...'
+      'It will work...',
+      ...
+    ]
+}
+
+```
+
+### Data Fields
+
+
+- `agent_info`: Information about each of the agents taking part in the dialogue
+  - `Bottomline`: TBD
+  - `Role`: Whether the agent is buyer or seller
+  - `Target`: Target price that the buyer/seller wants to hit in the negotiation
+- `agent_turn`: Agent taking the current turn in the dialogue (`int` index corresponding to `Role` above)
+- `dialogue_acts`: Rules-based information about the strategy of each agent for each turn
+  - `intent`: The intent of the agent at the particular turn (offer, accept, etc.)
+  - `price`: The current item price associated with the intent and turn in the bargaining process. Default value for missing: (`-1`)
+- `items`: Information about the item the agents are bargaining for. **Note that there is an elembet for each of the fields below for each agent**
+  - `Category`: Category of the item
+  - `Description`: Description(s) of the item
+  - `Images`: (comma delimited) strings of image names of the item
+  - `Price`: Price(s) of the item. Default value for missing: (`-1`)
+  - `Title`: Title(s) of the item
+- `utterance`: Utterance for each turn in the dialogue, corresponding to the agent in `agent_turns`. The utterance may be an empty string (`''`) for some turns if multiple dialogue acts take place after an utterance (e.g. there are often multiple dialogue acts associated with the closing of the bargaining process after all utterances have completed to describe the conclusion of the bargaining).
+
+### Data Splits
+
+This dataset contains three splits, `train`, `validation` and `test`. Note that `test` is not provided with `dialogue_acts` information as described above. To ensure schema consistency across dataset splits, the `dialogue_acts` field in the `test` split is populated with the default values: `{"price": -1.0, "intent": ""}`
+
+The counts of examples in each split are as follows:
+
+|                            | Train  | Valid | Test |
+| Input Examples             | 5247   | 597   | 838  |
+| Average Dialogue Length    | 9.14   | 9.17  | 9.24 |
+
+Note that 
+
+## Dataset Creation
+
+From the [source paper](https://arxiv.org/pdf/1808.09637.pdf) for this dataset: 
+
+> To generate the negotiation scenarios, we
+> scraped postings on sfbay.craigslist.org
+> from the 6 most popular categories (housing, furniture, cars, bikes, phones, and electronics). Each
+> posting produces three scenarios with the buyer’s
+> target prices at 0.5x, 0.7x and 0.9x of the listing
+> price. Statistics of the scenarios are shown in Table 2.
+> We collected 6682 human-human dialogues on
+> AMT using the interface shown in Appendix A
+> Figure 2. The dataset statistics in Table 3 show
+> that CRAIGSLISTBARGAIN has longer dialogues
+> and more diverse utterances compared to prior
+> datasets. Furthermore, workers were encouraged
+> to embellish the item and negotiate side offers
+> such as free delivery or pick-up. This highly relatable scenario leads to richer dialogues such as
+> the one shown in Table 1. We also observed various persuasion techniques listed in Table 4 such as
+> embellishment,
+
+### Curation Rationale
+
+See **Dataset Creation**
+
+### Source Data
+
+See **Dataset Creation**
+
+#### Initial Data Collection and Normalization
+
+See **Dataset Creation**
+
+#### Who are the source language producers?
+
+See **Dataset Creation**
+
+### Annotations
+
+If the dataset contains annotations which are not part of the initial data collection, describe them in the following paragraphs.
+
+#### Annotation process
+
+Annotations for the `dialogue_acts` in `train` and `test` were generated via a rules-based system which can be found in [this script](https://github.com/stanfordnlp/cocoa/blob/master/craigslistbargain/parse_dialogue.py)
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Considerations for Using the Data
+
+[More Information Needed]
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+[More Information Needed]
+
+### Dataset Curators
+
+He He and Derek Chen and Anusha Balakrishnan and Percy Liang
+Computer Science Department, Stanford University
+`{hehe,derekchen14,anusha,pliang}@cs.stanford.edu`
+
+The work through which this data was produced was supported by
+DARPA Communicating with Computers (CwC)
+program under ARO prime contract no. W911NF15-1-0462
+
+### Licensing Information
+
+[More Information Needed]
+
+### Citation Information
+
+```
+@misc{he2018decoupling,
+    title={Decoupling Strategy and Generation in Negotiation Dialogues},
+    author={He He and Derek Chen and Anusha Balakrishnan and Percy Liang},
+    year={2018},
+    eprint={1808.09637},
+    archivePrefix={arXiv},
+    primaryClass={cs.CL}
+}
+```
+

craigslist_bargains.py

@@ -0,0 +1,212 @@
+# coding=utf-8
+# 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.
+"""TODO: Add a description here."""
+
+from __future__ import absolute_import, division, print_function
+
+import json
+
+import datasets
+
+
+_CITATION = """\
+@misc{he2018decoupling,
+    title={Decoupling Strategy and Generation in Negotiation Dialogues},
+    author={He He and Derek Chen and Anusha Balakrishnan and Percy Liang},
+    year={2018},
+    eprint={1808.09637},
+    archivePrefix={arXiv},
+    primaryClass={cs.CL}
+}
+"""
+
+_DESCRIPTION = """\
+We study negotiation dialogues where two agents, a buyer and a seller,
+negotiate over the price of an time for sale. We collected a dataset of more
+than 6K negotiation dialogues over multiple categories of products scraped from Craigslist.
+Our goal is to develop an agent that negotiates with humans through such conversations.
+The challenge is to handle both the negotiation strategy and the rich language for bargaining.
+"""
+
+_HOMEPAGE = "https://stanfordnlp.github.io/cocoa/"
+
+_LICENSE = ""
+
+_URLs = {
+    "train": "https://worksheets.codalab.org/rest/bundles/0xd34bbbc5fb3b4fccbd19e10756ca8dd7/contents/blob/parsed.json",
+    "validation": "https://worksheets.codalab.org/rest/bundles/0x15c4160b43d44ee3a8386cca98da138c/contents/blob/parsed.json",
+    "test": "https://worksheets.codalab.org/rest/bundles/0x54d325bbcfb2463583995725ed8ca42b/contents/blob/",
+}
+
+
+class CraigslistBargains(datasets.GeneratorBasedBuilder):
+    """
+    Dialogue for buyer and a seller negotiating
+    the price of an item for sale on Craigslist.
+    """
+
+    VERSION = datasets.Version("1.1.0")
+
+    def _info(self):
+        features = datasets.Features(
+            {
+                "agent_info": datasets.features.Sequence(
+                    {
+                        "Bottomline": datasets.Value("string"),
+                        "Role": datasets.Value("string"),
+                        "Target": datasets.Value("float"),
+                    }
+                ),
+                "agent_turn": datasets.features.Sequence(datasets.Value("int32")),
+                "dialogue_acts": datasets.features.Sequence(
+                    {"intent": datasets.Value("string"), "price": datasets.Value("float")}
+                ),
+                "utterance": datasets.features.Sequence(datasets.Value("string")),
+                "items": datasets.features.Sequence(
+                    {
+                        "Category": datasets.Value("string"),
+                        "Images": datasets.Value("string"),
+                        "Price": datasets.Value("float"),
+                        "Description": datasets.Value("string"),
+                        "Title": datasets.Value("string"),
+                    }
+                ),
+            }
+        )
+
+        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
+            # If there's a common (input, target) tuple from the features,
+            # specify them here. They'll be used if as_supervised=True in
+            # builder.as_dataset.
+            supervised_keys=None,
+            # Homepage of the dataset for documentation
+            homepage=_HOMEPAGE,
+            # License for the dataset if available
+            license=_LICENSE,
+            # Citation for the dataset
+            citation=_CITATION,
+        )
+
+    def _split_generators(self, dl_manager):
+        """Returns SplitGenerators."""
+
+        my_urls = _URLs
+        data_dir = dl_manager.download_and_extract(my_urls)
+
+        return [
+            datasets.SplitGenerator(
+                name=datasets.Split.TRAIN,
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={
+                    "filepath": data_dir["train"],
+                    "split": "train",
+                },
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.TEST,
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={"filepath": data_dir["test"], "split": "test"},
+            ),
+            datasets.SplitGenerator(
+                name=datasets.Split.VALIDATION,
+                # These kwargs will be passed to _generate_examples
+                gen_kwargs={
+                    "filepath": data_dir["validation"],
+                    "split": "validation",
+                },
+            ),
+        ]
+
+    def _generate_examples(self, filepath, split):
+        """ Yields examples. """
+
+        # Set default values for items when the information is missing
+        # `items` is the description of the item advertised on craigslist
+        # to which the conversation is referring
+        default_items = {"Category": "", "Images": "", "Price": -1.0, "Description": "", "Title": ""}
+
+        # Set default values for the rules-based `metadata` generated by
+        # the Stanford NLP Cocoa project for the Craigslist Bargains dataset
+        # For more information on producing the `metadata` values for the train
+        # and dev sets, see https://worksheets.codalab.org/bundles/0xd34bbbc5fb3b4fccbd19e10756ca8dd7
+        default_metadata = {"price": -1.0, "intent": ""}
+
+        with open(filepath, encoding="utf-8") as f:
+            concat_sep = ","
+            jsons = json.loads(f.read())
+            for id_, j in enumerate(jsons):
+
+                # Get scenario information.
+                # This is nformation about position of each agent
+                scenario = j.get("scenario")
+                kbs = scenario["kbs"]
+                agent_info = [kb["personal"] for kb in kbs]
+                agent_info = [{k: str(v) for k, v in ai.items()} for ai in agent_info]
+
+                # Get item information.
+                # This is information about item listing for each agent
+                items = [i["item"] for i in kbs]
+
+                # Flatten `list` elements in items
+                # (e.g. if there are multiple image names, descriptions...)
+                # to align more easily with arrow schema
+                for item in items:
+                    for k in item:
+                        if type(item[k]) == list:
+                            item[k] = concat_sep.join(item[k])
+
+                # Check for missing elements in `items`
+                # and fill with default values
+                for item in items:
+                    for k in default_items:
+                        if k not in item:
+                            item[k] = default_items[k]
+                        elif not item[k]:
+                            item[k] = default_items[k]
+
+                # Get interaction information.
+                # This is information about messages exchanged
+                # and rules-based dialogue acts assigned to each
+                # dialogue segment
+                events = j.get("events")
+                agents = [e.get("agent") for e in events]
+                agents = [a if type(a) == int else -1 for a in agents]
+                data = [e.get("data") for e in events]
+                utterances = [u if type(u) == str else "" for u in data]
+
+                metadata = [e.get("metadata") for e in events]
+                metadata = [m if m else default_metadata for m in metadata]
+
+                # Check for missing keys in metadata, or missing
+                # metadata altogether for test data split.
+                # If anything missing, fill with defaults above.
+                for m in metadata:
+                    for k in default_metadata:
+                        if k not in m:
+                            m[k] = default_metadata[k]
+                        elif not m[k]:
+                            m[k] = default_metadata[k]
+
+                yield id_, {
+                    "agent_info": agent_info,
+                    "agent_turn": agents,
+                    "dialogue_acts": metadata,
+                    "utterance": utterances,
+                    "items": items,
+                }

dataset_infos.json

@@ -0,0 +1 @@
+{"default": {"description": "We study negotiation dialogues where two agents, a buyer and a seller,\nnegotiate over the price of an time for sale. We collected a dataset of more\nthan 6K negotiation dialogues over multiple categories of products scraped from Craigslist.\nOur goal is to develop an agent that negotiates with humans through such conversations.\nThe challenge is to handle both the negotiation strategy and the rich language for bargaining.\n", "citation": "@misc{he2018decoupling,\n    title={Decoupling Strategy and Generation in Negotiation Dialogues},\n    author={He He and Derek Chen and Anusha Balakrishnan and Percy Liang},\n    year={2018},\n    eprint={1808.09637},\n    archivePrefix={arXiv},\n    primaryClass={cs.CL}\n}\n", "homepage": "https://stanfordnlp.github.io/cocoa/", "license": "", "features": {"agent_info": {"feature": {"Bottomline": {"dtype": "string", "id": null, "_type": "Value"}, "Role": {"dtype": "string", "id": null, "_type": "Value"}, "Target": {"dtype": "float32", "id": null, "_type": "Value"}}, "length": -1, "id": null, "_type": "Sequence"}, "agent_turn": {"feature": {"dtype": "int32", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "dialogue_acts": {"feature": {"intent": {"dtype": "string", "id": null, "_type": "Value"}, "price": {"dtype": "float32", "id": null, "_type": "Value"}}, "length": -1, "id": null, "_type": "Sequence"}, "utterance": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "items": {"feature": {"Category": {"dtype": "string", "id": null, "_type": "Value"}, "Images": {"dtype": "string", "id": null, "_type": "Value"}, "Price": {"dtype": "float32", "id": null, "_type": "Value"}, "Description": {"dtype": "string", "id": null, "_type": "Value"}, "Title": {"dtype": "string", "id": null, "_type": "Value"}}, "length": -1, "id": null, "_type": "Sequence"}}, "post_processed": null, "supervised_keys": null, "builder_name": "craigslist_bargains", "config_name": "default", "version": {"version_str": "1.1.0", "description": null, "major": 1, "minor": 1, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 8538836, "num_examples": 5247, "dataset_name": "craigslist_bargains"}, "test": {"name": "test", "num_bytes": 1353933, "num_examples": 838, "dataset_name": "craigslist_bargains"}, "validation": {"name": "validation", "num_bytes": 966032, "num_examples": 597, "dataset_name": "craigslist_bargains"}}, "download_checksums": {"https://worksheets.codalab.org/rest/bundles/0xd34bbbc5fb3b4fccbd19e10756ca8dd7/contents/blob/parsed.json": {"num_bytes": 20148723, "checksum": "34033ff87565b9fc9eb0efe867e9d3e32456dbe1528cd1683f94a84b09f66ace"}, "https://worksheets.codalab.org/rest/bundles/0x15c4160b43d44ee3a8386cca98da138c/contents/blob/parsed.json": {"num_bytes": 2287054, "checksum": "03b35dc18bd90d87dac46893ac4db8ab3eed51786d192975be68d3bab38e306e"}, "https://worksheets.codalab.org/rest/bundles/0x54d325bbcfb2463583995725ed8ca42b/contents/blob/": {"num_bytes": 2937841, "checksum": "c802f15f80ea3066d429375393319d7234daacbd6a26a6ad5afd0ad78a2f7736"}}, "download_size": 25373618, "post_processing_size": null, "dataset_size": 10858801, "size_in_bytes": 36232419}}

dummy/1.1.0/dummy_data.zip

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