openfoodfacts/openfoodfacts-server

Spellcheck for ingredients, additives and other taxonomies, auto correct spelling mistakes and/or make suggestions

Open

#1,317 opened on Aug 9, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Perl (236 forks)batch import
Can be done by RobotoffSpellcheckhelp wanted

Repository metrics

Stars
 (477 stars)
PR merge metrics
 (Avg merge 15d 21h) (157 merged PRs in 30d)

Description

What

  • I started to implement a brute force approach for spellchecking ingredients, additives and anything we have a taxonomy of.
  • For each word / group of words that we want to taxonomize, if it's not in the taxonomy, we generate a list of correction candidates: the initial string with inserted, deleted or replaced letters.
  • To avoid false positives, I'm just considering candidates with an edit distance of 1 at this point.
  • This spellchecker could be used either for auto-correction (when we are close to 100% sure), spelling suggestions (which would require an easy to use interface for the web edit form and the mobile apps, see bug #937).

Contributor guide

Research direction
Review the existing taxonomy files and understand the data format. Then implement a function that generates all possible strings at edit distance 1 from a given string and checks them against the taxonomy.
Tech stack
None
Domain
backenddata
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Perl
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65