Create README.md

README.md

@@ -0,0 +1,64 @@
+# Dataset Card for Tapir-Cleaned
+
+This is a cleaned version and modified for instruction-tuning of the DAISLab dataset of IFTTT rule
+
+## Original Tapir Dataset Summary
+
+Tapir is a dataset of 242,480 recipes extracted from IFTTT platform
+After cleaning all the dataset, removing redundancy and not consistent recipe the cleaned version consist of 67,697 recipes.
+
+This instruction data can be used to conduct instruction-tuning for language models and make the language model follow instruction better.
+
+### Supported Tasks and Leaderboards
+
+The Tapir dataset designed for instruction training pretrained language models
+
+### Languages
+
+The data in Tapir are mainly in English (BCP-47 en).
+
+# Dataset Structure
+
+### Data Instances
+
+```json
+{
+    "instruction":"From the description of a rule: identify the 'trigger', identify the 'action', write a IF 'trigger' THEN 'action' rule.",
+    "input":"If it's raining outside, you'll want some nice warm colors inside!",
+    "output":"IF Weather Underground Current condition changes to THEN LIFX Change color of lights"
+    "text": "Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.\n\n### Instruction:\nFrom the description of a rule: identify the 'trigger', identify the 'action', write a IF 'trigger' THEN 'action' rule.\n\n### Input:\nIf it's raining outside, you'll want some nice warm colors inside!\n\n### Response:\nIF Weather Underground Current condition changes to THEN LIFX Change color of lights",
+}
+```
+
+### Data Fields
+
+The data fields are as follows:
+
+* `instruction`: describes the task the model should perform.
+* `input`: context or input for the task.  Each of the 68K input is unique.
+* `output`: the answer taken from the original Tapir Dataset formatted as an IFTTT recipe
+* `text`: the `instruction`, `input` and `output` formatted with the [prompt template](https://github.com/tatsu-lab/stanford_alpaca#data-release) used by the authors of Alpaca for fine-tuning their models.
+
+### Data Splits
+
+|               | train |
+|---------------|------:|
+| tapir         | 67697 |
+
+### Licensing Information
+
+The dataset is available under the [Creative Commons NonCommercial (CC BY-NC 4.0)](https://creativecommons.org/licenses/by-nc/4.0/legalcode).
+
+
+### Citation Information
+
+```
+@misc{alpaca,
+  author = {Mattia Limone, Gaetano Cimino, Annunziata Elefante},
+  title = {TAPIR: Trigger Action Platform for Information Retrieval},
+  year = {2023},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/MattiaLimone/ifttt_recommendation_system}},
+}
+```