A Python package to parse structured information from recipe ingredient sentences
Project description
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/.
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.999193),
size=None,
amount=[IngredientAmount(quantity='3',
unit=<Unit('pound')>,
text='3 pounds',
confidence=0.999906,,
APPROXIMATE=False,
SINGULAR=False)],
preparation=IngredientText(text='cut into 2 inch chunks', confidence=0.999193),
comment=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:
Accuracy: 94.24%
Word-level results:
Accuracy 97.73%
Precision (micro) 97.72%
Recall (micro) 97.73%
F1 score (micro) 97.72%
Development
The development dependencies are in the requirements-dev.txt
file. Details on the training process can be found in the Model Guide documentation.
Before committing anything, install pre-commit and run
pre-commit install
to install the pre-commit hooks.
There is a simple web app for testing the parser with ingredient sentences and showing the parsed output. To run the web app, run the command
$ flask --app webapp run
This requires the development dependencies to be installed.
The dependencies for building the documentation are in the requirements-doc.txt
file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ingredient_parser_nlp-0.1b10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1bda83e17f8fcf0798fb39c1c4af9f2b59629bae4ca1b41bb4438335748560f1 |
|
MD5 | 21c4f1b7979aefc854bedccc4ec85c40 |
|
BLAKE2b-256 | 5d693b172af53d467ba1ca66a1747f6d58bca76f08d84dd1016ebff2e4eba673 |
Hashes for ingredient_parser_nlp-0.1.0b10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9179d72534fc0523a8d5c9bf6a78fb3f04f7687d745e4abe292bc4ac7f088d91 |
|
MD5 | f23c0986b97866d3899aa24be7df2c8b |
|
BLAKE2b-256 | f7a8086cdfe8f3015c4087974adf88a890efa31fce5bc1b0aa4d1be1b4b78d4e |