michaelkariv/ingredient-parser

A tool to parse recipe ingredients into structured data

Ingredient Parser

The Ingredient Parser package is a Python package for parsing structured information out of recipe ingredient sentences.

Documentation

Documentation on using the package and training the model can be found at https://ingredient-parser.readthedocs.io/en/latest/.

Quick Start

Install the package using pip

python -m pip install ingredient-parser-nlp

Import the parse_ingredient function and pass it an ingredient sentence.

>>> from ingredient_parser import parse_ingredient

>>> parse_ingredient("3 pounds pork shoulder, cut into 2-inch chunks")
ParsedIngredient(
    name=IngredientText(text='pork shoulder', 
                        confidence=0.989491),
    amount=[IngredientAmount(quantity='3',
                             unit='pounds',
                             confidence=0.998649,
                             APPROXIMATE=False,
                             SINGULAR=False)],
    comment=IngredientText(text='cut into 2 inch chunks',
                           confidence=0.997456),
    other=None,
    sentence='3 pounds pork shoulder, cut into 2-inch chunks')

Model accuracy

The model used for labelling tokens in sentences, provided in the ingredient-parser/ directory, has the following accuracy on a test data set of 25% of the total data used:

Sentence-level results:
	Total: 12044
	Correct: 10834
	Incorrect: 1210
	-> 89.95% correct

Word-level results:
	Total: 76299
	Correct: 73430
	Incorrect: 2869
	-> 96.24% correct

Development

The development dependencies are in the requirements-dev.txt file. Details on the training process can be found in the Model Guide documentation.

There is a simple webapp for testing the parser with ingredient sentences and showing the parsed output. To run the webapp, run the command

>>> flask --app webapp run

This requires the development dependencies to be installed.

The documentation dependencies are in the requirement-doc.txt file.