RecipeNLG_Group8 / README.md
LIUH0115's picture
Add ingredient normalizer and update documentation
0eae630 verified
|
Raw History Blame Contribute Delete
20.7 kB
metadata
pretty_name: RecipeNLG 清洗、食材标准化与厨具时间增强数据
language:
  - en
license: unknown
size_categories:
  - 1M<n<10M
task_categories:
  - text-retrieval
  - text-generation
tags:
  - recipes
  - cooking
  - rule-based-extraction
  - contextual-time
configs:
  - config_name: default
    data_files:
      - split: train
        path: recipes_names_only_*.jsonl

RecipeNLG:清洗、食材标准化与厨具时间增强数据

本数据以RecipeNLG食谱为来源,经过文本清洗、无效食材实体记录筛选、食材名称标准化,以及厨具与场景时间提取,形成结构化食谱数据。每条记录包含原文食材、烹饪步骤、标准化食材名称,以及带原文证据的时间信息。食谱文本和提取标签为英文,本说明为中文。

版本:recipenlg-stage2-equipment-time-v1.1;记录数:2,230,565;23个JSONL分片;UTF-8编码,每行一条完整食谱;数据文件合计约2.902 GiB。

23个文件是存储分片,按文件名顺序读取即可;没有进行训练/验证/测试集划分。上方Hugging Face配置的 train 只是整份数据的加载名称,不表示已建立实验训练集,也不要把这些分片分别当作训练集和测试集。

数据来源与处理过程

原始数据为RecipeNLG,共2,231,142条。原始项目:RecipeNLG;数据卡:mbien/recipe_nlg。实际CSV来自 Mahimas/recipenlg镜像。处理顺序为文本清洗与筛选、食材名称标准化、厨具与场景时间提取。

文本清洗与记录筛选

原始CSV含2,231,142条食谱。清洗后保留2,230,565条,删除577条:其中573条的原始食材实体字段 NER 为 [],另外4条仅含 ... 或 ..... 等无效标记。因此,实际筛选结果是排除缺少有效食材实体的记录,不能概括成删除空标题或空食材行。

标题去除首尾空白;食材和步骤列表中的每个条目去除首尾空白,并删除空白条目。全量对比确认:128,858条标题、1,062条食材列表、37,484条步骤列表发生变化,这些变化均可由上述空白清理解释。保留的记录中,共删除34个空白食材项和123,609个空白步骤项。id、link、source保留原值。

原CSV中的 ingredients、directions、NER 是序列化列表;最终JSONL中的食材和步骤以真正的JSON数组保存。原始 NER 不在最终字段中单独保留。

食材名称标准化

normalized_ingredients 保存食材实体名称标准化后的结果。输出可见大小写、单复数及名称映射,例如 eggs → egg、tomatoes → tomato、green onions → scallion、garlic → garlic bulb,并可观察到部分重复实体合并。标准化元信息标识使用FoodOn名称;最终数据只保留名称,不暴露FoodOn节点ID。

清洗行为经过原始CSV与输出的全量核对。本包提供 ingredient_normalizer/normalizer.py 和固定名称映射表 ingredient_normalizer/data/normalization_map.json,可复用食材名称标准化规则。原始数据清洗完整程序、FoodOn映射表生成与歧义处理程序仍未包含,不能据此从原始CSV完整重建全部处理过程。

标准化列表共18,403,471个名称,原始食材列表共19,470,254个条目。669,776条食谱两者长度不同,因此不能按下标配对名称和用量。标准化仍可能丢失状态、粒度或出现错误映射;应同时保留 ingredients 和 directions 作为原文依据。

食材标准化工具与验证

固定映射表版本为 foodon-name-map-v1,包含48,203个词条:4,953条FoodOn唯一匹配、418条歧义处理后匹配、42,405条未匹配保留本地名称、427条低质量保留本地名称。这些数量是词条数,不是食谱数量;不能把全部词条视为成功匹配FoodOn。

工具依次进行Unicode NFKC统一、转小写、清理空白与首尾标点、连字符转空格,以及17项保守单复数规则;删除空名称并在映射前去重,保留首次出现顺序,再查询固定映射表。未知名称返回轻度清理后的输入,不联网查询。映射后不再次去重,因此不同输入映射为同一名称时,输出仍可能重复。

包内7项自测和文件校验通过。使用此前固定抽取的19,735条记录中的原始 NER 重新标准化,输出列表全部与已有 normalized_ingredients 一致。这是样本复现检查,未覆盖全量食谱,也不是语义准确率评估;本次加入工具没有重新生成或改写食谱字段。

工具输入必须是已经提取的英文食材关键词字符串数组,不能直接传入整段用户输入或带数量单位的原料句子;不负责关键词提取、中文翻译或用户界面。相同关键词和固定映射版本可保持两端规则一致,但不保证全部同义表达得到相同标签。例如 green onion 返回 scallion food product,green onions 返回 scallion;unsalted butter 和 butter 均返回 butter,可能丢失状态信息。后续匹配可对输出使用集合避免重复计数,并保留原文供核查。

厨具与场景时间提取

使用Python标准库的词典、正则和局部动作匹配处理 directions,新增 equipment 与 time,不调用模型生成字段。厨具为明确出现的设备及主要锅具;时间保存动作、原文表达和步骤证据,无法可靠对应动作时保留 null,不计算总耗时。

这一信息提取阶段保留清洗与标准化后全部2,230,565条食谱、7个原字段、ID和顺序,仅追加2个字段。全量逐条核对确认原字段变化为0,输入摘要不变,派生结构、时间证据及统计重算一致。这里的“原字段变化为0”专指厨具与时间提取前后,不表示原始CSV没有经过清洗。

详细方法和结果见 方法与结果交付说明.md,提取统计和核对结果见 stats.json 与 verification.json。

id保留原始编号,因清洗筛选可能有空缺,不能把最大ID加1当作记录总数。

数据文件

本数据包包含38个文件,正式数据由23个JSONL分片组成。

文件 数量 内容
recipes_names_only_000.jsonl 至 recipes_names_only_022.jsonl 23 全部食谱记录
README.md 1 数据介绍、字段定义与使用方法
stats.json、verification.json 2 厨具与时间提取统计及全量核对结果
extraction.py、rules.json 2 厨具与时间提取代码和词典配置
方法与结果交付说明.md 1 完整处理过程、方法与实际结果
upload_manifest.json 1 文件名称、大小及SHA-256清单
ingredient_normalizer/ 8 食材名称标准化代码、固定映射表、说明、示例、自测及校验文件

文件按分片名顺序读取;Hugging Face数据配置只选择 recipes_names_only_*.jsonl。upload_manifest.json记录另外37个文件的名称、大小和摘要,不记录自身摘要。

字段定义

字段 JSON类型 含义
id 整数 原始食谱ID,保留不变
title 字符串 食谱标题
ingredients 字符串数组 带用量等描述的食材列表
directions 字符串数组 按顺序排列的烹饪步骤
normalized_ingredients 字符串数组 清洗与名称标准化后的食材实体列表
link 字符串 来源网页地址,部分不带协议前缀
source 字符串 来源类别,Gathered或Recipes1M
equipment 字符串数组 归一化后的厨具标签,首次出现顺序去重;无结果为[]
time 对象数组 场景时间条目;无结果为[]

不要按数组下标把 normalized_ingredients 和 ingredients 一一对应。 标准化食材实体数可能与原始食材条目数不同,这两个数组不保证长度或位置对应。

每个时间条目严格包含三个字段:

{
  "action": "bake",
  "duration": "about 20 minutes",
  "text": "Bake for about 20 minutes."
}
  • action:英文动作标签;无法可靠匹配时是JSON null,不是字符串"null"。
  • duration:原文时间表达,不换算单位,不累加;可能含区间、约数、追加时间、每面时间或操作时点。
  • text:包含该时间的完整原始步骤字符串,供复核上下文。同一步骤中的多个时间可能共用一个 text。

提取规则与使用边界

厨具

只提取步骤中明确出现的设备及主要锅具、烘焙容器;统一大小写、常见复数和别名,长名称优先。例:microwave oven只记录 microwave,Dutch oven记录 pot,grill pan记录 pan。

不提取冰箱、冷冻柜、刀、勺、碗等通用工具,不通过bake/fry/mix等动作推断设备。明确不用设备的常见表达排除;不要预热/打开烤箱属于操作限制,仍可记录明确提到的烤箱。microwave-safe bowl这类适用性描述不据此提取设备。

可选、替代设备都可能进入列表,例如blender or food processor同时保存两个标签。列表不代表每台设备都必需。 否定范围和名词上下文是启发式规则,不能保证全部复杂句子判断正确。

标签 中文解释 提及该设备的食谱数
microwave 微波炉 33,848
slow_cooker 慢炖锅 40,029
pressure_cooker 压力锅 3,791
air_fryer 空气炸锅 175
food_processor 料理机 92,303
mixer 电动搅拌器/打蛋器 101,927
baking_dish 烘焙容器 197,308
baking_sheet 烤盘/烤板 220,598
cake_pan 蛋糕模具 72,355
loaf_pan 长条烤模 42,610
muffin_pan 玛芬模具 40,048
skillet 煎锅 302,051
saucepan 小炖锅/带柄锅 273,058
pot 锅(含 Dutch oven) 179,791
oven 烤箱 556,306
stove 炉灶 35,581
grill 烧烤炉 45,002
blender 搅拌机 99,736
wok 炒锅 18,707
pan 泛称锅具/盘式烤具 570,623

时间

识别数字、英文数字、分数、区间、组合时长、约数、上下限、追加时间、overnight等。优先对应同一步骤句子或分句中前方的动作;联合动作可保存为 boil and stir,多个时间分别保存,不跨步骤猜测动作。

保留烹饪、静置、冷藏、腌制、发酵等制作过程时间;排除明确保存期限和消费频率。原文已有Prep/Cook/Inactive Prep Time时保留其标签;before serving、ahead、per pound、each side等限定语尽量保留,不推算总耗时。

[]表示未提取到,不表示该食谱不需要厨具或不耗时。action=null表示时间有证据但场景配对不足。 即使时间与厨具都为空,原食谱文本仍可用于检索、生成等下游工作,本版没有删除这些记录。

规模与空值统计

情况 食谱数 全部食谱占比
厨具和时间都非空 1,389,776 62.31%
只有厨具,时间为空 208,036 9.33%
只有时间,厨具为空 320,955 14.39%
厨具和时间都为空 311,798 13.98%
合计 2,230,565 100%

单列统计(与上表交叉情况不要重复相加):

  • 厨具非空:1,597,812条(71.63%);厨具为空:632,753条(28.37%)。
  • 时间非空:1,710,731条(76.69%);时间为空:519,834条(23.31%)。
  • 时间对象共3,586,862个;其中420,303个 action=null(占时间对象11.72%),分布在325,110条食谱中。

比例是规则产出率,不是准确率;四舍五入后分类比例之和可能有0.01个百分点偏差。

真实记录示例

以下为分片000的ID为0的完整记录:

{
  "id": 0,
  "title": "No-Bake Nut Cookies",
  "ingredients": [
    "1 c. firmly packed brown sugar",
    "1/2 c. evaporated milk",
    "1/2 tsp. vanilla",
    "1/2 c. broken nuts (pecans)",
    "2 Tbsp. butter or margarine",
    "3 1/2 c. bite size shredded rice biscuits"
  ],
  "directions": [
    "In a heavy 2-quart saucepan, mix brown sugar, nuts, evaporated milk and butter or margarine.",
    "Stir over medium heat until mixture bubbles all over top.",
    "Boil and stir 5 minutes more. Take off heat.",
    "Stir in vanilla and cereal; mix well.",
    "Using 2 teaspoons, drop and shape into 30 clusters on wax paper.",
    "Let stand until firm, about 30 minutes."
  ],
  "normalized_ingredients": [
    "brown sugar",
    "milk",
    "vanilla bean food product",
    "nut (whole or pieces)",
    "butter",
    "bite size shredded rice biscuits"
  ],
  "link": "www.cookbooks.com/Recipe-Details.aspx?id=44874",
  "source": "Gathered",
  "equipment": [
    "saucepan"
  ],
  "time": [
    {
      "action": "boil and stir",
      "duration": "5 minutes more",
      "text": "Boil and stir 5 minutes more. Take off heat."
    },
    {
      "action": "let stand",
      "duration": "about 30 minutes",
      "text": "Let stand until firm, about 30 minutes."
    }
  ]
}

下载与读取

以下示例使用数据仓库 LIUH0115/RecipeNLG_Group8;无需下载中间处理数据或原始CSV即可使用本版数据。

按需流式读取

pip install datasets
from datasets import load_dataset

recipes = load_dataset(
    "LIUH0115/RecipeNLG_Group8",
    split="train",   # 整份数据的加载名称,没有实验划分
    streaming=True,
)
first = next(iter(recipes))
print(first["id"], first["equipment"], first["time"])

流式读取避免一次性把全部数据放进内存。用法依据 datasets官方加载文档。本README已配置只读取23个正式分片。

下载数据包到本地

pip install huggingface_hub
from huggingface_hub import snapshot_download

snapshot_download(
    repo_id="LIUH0115/RecipeNLG_Group8",
    repo_type="dataset",
    local_dir="RecipeNLG_huggingface",
    allow_patterns=[
        "recipes_names_only_*.jsonl", "README.md", "stats.json",
        "verification.json", "extraction.py", "rules.json",
        "方法与结果交付说明.md", "upload_manifest.json",
        "ingredient_normalizer/*",
    ],
)

下载接口依据 huggingface_hub官方文档。私有仓库需先使用拥有权限的账号登录。

本地数据可仅用Python标准库读取,不依赖datasets:

import json
from pathlib import Path

for shard in sorted(Path("RecipeNLG_huggingface").glob("recipes_names_only_*.jsonl")):
    with shard.open(encoding="utf-8") as file:
        for line in file:
            recipe = json.loads(line)
            # 在这里处理一条食谱;不要把所有记录一次性转成列表
            equipment = recipe["equipment"]
            time_entries = recipe["time"]

如果下游确实需要两种信息都存在,可筛选 bool(recipe["equipment"]) and bool(recipe["time"]);如果只想排除两者都为空,则用 bool(recipe["equipment"]) or bool(recipe["time"])。这两种筛选分别保留1,389,776条和1,918,767条,请根据任务选用,而不是默认删除空值样本。

检查下载完整性

在同时包含正式数据和 upload_manifest.json 的目录中执行:

import hashlib
import json
from pathlib import Path

root = Path("RecipeNLG_huggingface")
manifest = json.loads((root / "upload_manifest.json").read_text(encoding="utf-8"))
for item in manifest["files"]:
    path = root / item["name"]
    assert path.stat().st_size == item["bytes"], item["name"]
    digest = hashlib.sha256()
    with path.open("rb") as file:
        for block in iter(lambda: file.read(1024 * 1024), b""):
            digest.update(block)
    assert digest.hexdigest() == item["sha256"], item["name"]
print("全部发布文件的大小和SHA-256一致")

此检查使用Python标准库,对清单中的37个文件逐一校验;需要完整下载数据包。后续若修改README或任何发布文件,需要同步更新清单,避免摘要失效。

规则来源与复现

extraction.py与rules.json可直接用于新的食谱记录,要求记录包含字符串数组 directions,并且还没有 equipment和time:

from extraction import Extractor

recipe = {"id": 123, "directions": ["Bake for 20 minutes in an oven."]}
result = Extractor().enrich(recipe)
print(result)

运行时需保留同目录的 rules.json。规则实现仅依赖Python标准库;已执行的环境为Python 3.13.9。

本数据包包含已处理食谱、厨具与时间提取代码和词典,以及食材名称标准化运行工具和固定映射表,可用于读取数据、提取步骤信息和标准化用户端的食材关键词。原始清洗及映射表生成程序、完整审查附件仍未包含,不能从原始CSV完整重建全部处理过程。

用户输入食材的标准化

在下载目录 RecipeNLG_huggingface 中运行(Python 3.9+,无第三方依赖):

python -B ingredient_normalizer/normalizer.py "Eggs" "green-onion" "Vanilla"
python -B ingredient_normalizer/normalizer.py --input-json ingredient_normalizer/example_input.json
python -B ingredient_normalizer/self_test.py
python -B ingredient_normalizer/verify_package.py

在该目录下的Python程序中调用:

from ingredient_normalizer.normalizer import IngredientNormalizer

normalizer = IngredientNormalizer()  # 服务启动时初始化一次,后续复用
result = normalizer.normalize_terms(["Eggs", "green-onion", "Vanilla"])
print(result)

传给 normalize_terms 的对象必须是字符串数组,不能直接传一个字符串。应用端应先完成食材关键词提取和输入类型检查。完整工具说明见 ingredient_normalizer/README.md。如以后修改映射规则,食谱标准化字段与用户端应同步使用新的映射版本。

质量检查与已知限制

已执行5个提取测试方法(98个表驱动样例)及2个隔离流水线测试;全量逐条核对2,230,565条记录通过。试跑200条采用模型逐条对照检查,另一组不重叠的200条由独立模型审阅,修正后对20条发生变化的结果再次复核。最终组也参与了规则调整,因此不是未触碰的评测集;这些是模型定性审阅,不是人工金标准,没有precision/recall/F1或抽取准确率。

已知限制包括:

  • 有限词典可能遗漏griddle、double boiler、专用模具等;设备可选/替代关系未结构化。
  • 复杂句子、省略动作、附带动作和操作时点可能误配动作,或保留为null。
  • a day and a night可能只提取到 a day;特殊写法、拼写错误和乱码可能遗漏或截断。
  • 准备过程与保存期限的边界采用启发式判断,存在误排或漏排。
  • 局部时间可能表示区间、频率、每面时间、追加时间或操作时点;不能简单求和,不是总耗时。
  • 食材名称标准化不保证所有同义词映射正确,也不保证与原食材列表逐项对齐。

来源条款与引用

本版本未增加新的开源许可;元数据保留 license: unknown,具体使用依据原数据条款。原RecipeNLG数据卡规定用途为非商业研究和教学,并要求提供访问的研究伙伴和同事先同意其条款。参见 原数据卡的Licensing Information。新增的规则字段不改变原始食谱文本的条款。

数据使用者应阅读并遵守原数据条款。保留来源和论文引用:

Bień et al. (2020). RecipeNLG: A Cooking Recipes Dataset for Semi-Structured Text Generation. Proceedings of the 13th International Conference on Natural Language Generation, pp. 22–28.

论文:ACL Anthology。此版本为RecipeNLG的清洗与信息增强版本,处理版本标识不代表原始数据的官方版本号。