LIUH0115's picture
Add ingredient normalizer and update documentation
0eae630 verified
|
Raw History Blame Contribute Delete
3.38 kB

RecipeNLG FoodOn 名称统一工具

这个包用于让离线 RecipeNLG 数据和用户端输入执行同一套名称统一逻辑。运行结果只返回食材名称,不返回 FoodOn ID。

输入约定

输入应当是已经提取好的食材关键词数组,例如:

["eggs", "green onion", "cream cheese"]

不要直接传入带数量和单位的完整原料行,例如 2 cups chopped onions。数量、单位和关键词抽取应由上游模块完成。

处理逻辑

  1. Unicode NFKC 统一。
  2. 转为小写,清理首尾空白和标点。
  3. 各类连字符变为空格,连续空格合并。
  4. 执行与离线数据相同的少量完整词条复数表,例如 eggs -> egg、potatoes -> potato。不对复合短语做额外词形还原。
  5. 使用冻结的 48,203 条名称映射查找标准名称。
  6. 唯一匹配和已经消歧的词返回 FoodOn 首选名称;未匹配、低质量匹配以及映射表外的新词返回清洗后的原名称。
  7. 默认只返回字符串数组,不向用户端暴露 FoodOn ID。

命令行使用

python normalizer.py "Eggs" "green-onion" "Vanilla"

或者读取 JSON 数组:

python normalizer.py --input-json example_input.json

在 Python 后端中调用

from normalizer import IngredientNormalizer

normalizer = IngredientNormalizer()
result = normalizer.normalize_terms(
    ["Eggs", "green-onion", "Vanilla", "cream cheese"]
)

建议在服务启动时只创建一次 IngredientNormalizer,后续请求复用该对象。

未知词策略

冻结映射表中不存在的新词不会在线查询或猜测 FoodOn 概念,而是返回清洗后的原名称。在输入相同食材关键词、使用相同固定映射版本时,两端可保持处理规则一致;这不保证任意自由文本或全部同义表达得到相同标签,也避免运行时下载不同FoodOn版本造成结果变化。

复现与校验

运行:

python self_test.py
python verify_package.py

self_test.py 检查代表性输入输出;verify_package.py 检查包内关键文件哈希和映射表结构。整个运行过程仅依赖 Python 标准库。

与食谱数据的配套使用

本工具位于数据仓库的 ingredient_normalizer/ 子目录;本页命令在该子目录执行,仓库根目录的调用示例见 数据集README。它提供固定名称映射的运行功能,不包含原始数据清洗或映射表生成程序。

normalize_terms 必须接收字符串数组;直接传入单个字符串会按字符迭代,应用端应检查输入类型。空名称在映射前删除并去重,映射后不会再次去重。例如 unsalted butter 与 butter 都可能输出 butter;检索计分时可使用集合避免重复计数。同义表达也可能返回不同标签,例如 green onion 与 green onions 分别返回 scallion food product 和 scallion。

映射表48,203个词条中,5,371条属于FoodOn唯一匹配或歧义处理后匹配,其余为本地名称保留策略。固定19,735条食谱样本的标准化列表复现全部一致;该检查不代表全量验证或语义准确率。后续更换映射版本时,应同步更新食谱标准化字段和用户端版本。