albertvillanova HF staff commited on
Commit
cee8d7f
1 Parent(s): 1a9e47c

Fix documentation card of recipe_nlg dataset (#4834)

Browse files

Commit from https://github.com/huggingface/datasets/commit/6c609a322da994de149b2c938f19439bca99408e

Files changed (1) hide show
  1. README.md +64 -7
README.md CHANGED
@@ -66,7 +66,10 @@ pretty_name: RecipeNLG
66
 
67
  ### Dataset Summary
68
 
69
- [More Information Needed]
 
 
 
70
 
71
  ### Supported Tasks and Leaderboards
72
 
@@ -74,21 +77,52 @@ pretty_name: RecipeNLG
74
 
75
  ### Languages
76
 
77
- [More Information Needed]
78
 
79
  ## Dataset Structure
80
 
81
  ### Data Instances
82
 
83
- [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
84
 
85
  ### Data Fields
86
 
87
- [More Information Needed]
 
 
 
 
 
 
 
 
88
 
89
  ### Data Splits
90
 
91
- [More Information Needed]
92
 
93
  ## Dataset Creation
94
 
@@ -146,11 +180,34 @@ pretty_name: RecipeNLG
146
 
147
  ### Licensing Information
148
 
149
- [More Information Needed]
 
 
 
 
 
 
150
 
151
  ### Citation Information
152
 
153
- [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
154
 
155
  ### Contributions
156
 
 
66
 
67
  ### Dataset Summary
68
 
69
+ RecipeNLG: A Cooking Recipes Dataset for Semi-Structured Text Generation.
70
+
71
+ While the RecipeNLG dataset is based on the Recipe1M+ dataset, it greatly expands the number of recipes available.
72
+ The new dataset provides over 1 million new, preprocessed and deduplicated recipes on top of the Recipe1M+ dataset.
73
 
74
  ### Supported Tasks and Leaderboards
75
 
 
77
 
78
  ### Languages
79
 
80
+ The dataset is in English.
81
 
82
  ## Dataset Structure
83
 
84
  ### Data Instances
85
 
86
+ ```
87
+ {'id': 0,
88
+ 'title': 'No-Bake Nut Cookies',
89
+ 'ingredients': ['1 c. firmly packed brown sugar',
90
+ '1/2 c. evaporated milk',
91
+ '1/2 tsp. vanilla',
92
+ '1/2 c. broken nuts (pecans)',
93
+ '2 Tbsp. butter or margarine',
94
+ '3 1/2 c. bite size shredded rice biscuits'],
95
+ 'directions': ['In a heavy 2-quart saucepan, mix brown sugar, nuts, evaporated milk and butter or margarine.',
96
+ 'Stir over medium heat until mixture bubbles all over top.',
97
+ 'Boil and stir 5 minutes more. Take off heat.',
98
+ 'Stir in vanilla and cereal; mix well.',
99
+ 'Using 2 teaspoons, drop and shape into 30 clusters on wax paper.',
100
+ 'Let stand until firm, about 30 minutes.'],
101
+ 'link': 'www.cookbooks.com/Recipe-Details.aspx?id=44874',
102
+ 'source': 0,
103
+ 'ner': ['brown sugar',
104
+ 'milk',
105
+ 'vanilla',
106
+ 'nuts',
107
+ 'butter',
108
+ 'bite size shredded rice biscuits']}
109
+ ```
110
 
111
  ### Data Fields
112
 
113
+ - `id` (`int`): ID.
114
+ - `title` (`str`): Title of the recipe.
115
+ - `ingredients` (`list` of `str`): Ingredients.
116
+ - `directions` (`list` of `str`): Instruction steps.
117
+ - `link` (`str`): URL link.
118
+ - `source` (`ClassLabel`): Origin of each recipe record, with possible value {"Gathered", "Recipes1M"}:
119
+ - "Gathered" (0): Additional recipes gathered from multiple cooking web pages, using automated scripts in a web scraping process.
120
+ - "Recipes1M" (1): Recipes from "Recipe1M+" dataset.
121
+ - `ner` (`list` of `str`): NER food entities.
122
 
123
  ### Data Splits
124
 
125
+ The dataset contains a single `train` split.
126
 
127
  ## Dataset Creation
128
 
 
180
 
181
  ### Licensing Information
182
 
183
+ I (the "Researcher") have requested permission to use the RecipeNLG dataset (the "Dataset") at Poznań University of Technology (PUT). In exchange for such permission, Researcher hereby agrees to the following terms and conditions:
184
+
185
+ 1. Researcher shall use the Dataset only for non-commercial research and educational purposes.
186
+ 2. PUT makes no representations or warranties regarding the Dataset, including but not limited to warranties of non-infringement or fitness for a particular purpose.
187
+ 3. Researcher accepts full responsibility for his or her use of the Dataset and shall defend and indemnify PUT, including its employees, Trustees, officers and agents, against any and all claims arising from Researcher's use of the Dataset including but not limited to Researcher's use of any copies of copyrighted images or text that he or she may create from the Dataset.
188
+ 4. Researcher may provide research associates and colleagues with access to the Dataset provided that they first agree to be bound by these terms and conditions.
189
+ 5. If Researcher is employed by a for-profit, commercial entity, Researcher's employer shall also be bound by these terms and conditions, and Researcher hereby represents that he or she is fully authorized to enter into this agreement on behalf of such employer.
190
 
191
  ### Citation Information
192
 
193
+ ```bibtex
194
+ @inproceedings{bien-etal-2020-recipenlg,
195
+ title = "{R}ecipe{NLG}: A Cooking Recipes Dataset for Semi-Structured Text Generation",
196
+ author = "Bie{\'n}, Micha{\l} and
197
+ Gilski, Micha{\l} and
198
+ Maciejewska, Martyna and
199
+ Taisner, Wojciech and
200
+ Wisniewski, Dawid and
201
+ Lawrynowicz, Agnieszka",
202
+ booktitle = "Proceedings of the 13th International Conference on Natural Language Generation",
203
+ month = dec,
204
+ year = "2020",
205
+ address = "Dublin, Ireland",
206
+ publisher = "Association for Computational Linguistics",
207
+ url = "https://www.aclweb.org/anthology/2020.inlg-1.4",
208
+ pages = "22--28",
209
+ }
210
+ ```
211
 
212
  ### Contributions
213