Difference between revisions of "GSOC 2022 - Taxonomy editor"

From Open Food Facts wiki
Jump to navigation Jump to search
m (Stephane moved page Taxonomy editor to GSOC 2022 - Taxonomy editor)
(mark deprecated)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
Taxonomy editor
+
<blockquote>'''<big>ARCHIVE</big>:''' this page is archived. Useful information is on the github repository: https://github.com/openfoodfacts/taxonomy-editor/</blockquote>
  
 
=== Summary ===
 
=== Summary ===
  
−
{{{description}}}
+
The Open Food Facts database contains a lot of information on food products, such as ingredients, labels, additives etc. To link this information to useful properties such as Nutri-Score, Agribalyse and many more, taxonomies are used within the database.
 +
 
 +
A taxonomy in Open Food Facts is a raw text file containing a Directed Acyclic Graph (DAG) where each leaf node has one or more parent nodes. It is mainly used for classification and translation of various food products within the database. Hence, taxonomies are at the heart of data structures in the Open Food Facts database and must be maintained properly.
 +
 
 +
The taxonomy files present in Open Food Facts are long to read (ingredients.txt taxonomy alone has around 80000 lines!) and cumbersome to edit by contributors.
 +
 
 +
This project provides an User-Friendly interface developed for editing taxonomies with ease. This tool is helpful for contributors to visualize a node's translations, properties, parents and children in a single page. The editor allows users to perform CRUD operations on the taxonomy and on the nodes present. A fast search mechanism for finding nodes within the taxonomy has also been implemented successfully.
 +
 
 +
The introduction of this Taxonomy Editor would help existing contributors edit taxonomies seamlessly and will encourage more contributions from the wonderful community of Open Food Facts.
  
 
=== Description ===
 
=== Description ===
  
−
'''Status''': Selected for GSOC 2022, Planning
+
'''Status''': Selected for GSOC 2022, Completed
  
 
'''People''':
 
'''People''':
Line 17: Line 25:
 
Taxonomies are at the heart of openfoodfacts in many aspects. It helps identify components (ingredients, labels, brands,…) and link them to useful properties, at the base of nutri-score, eco-score, allergens identification and some other properties.
 
Taxonomies are at the heart of openfoodfacts in many aspects. It helps identify components (ingredients, labels, brands,…) and link them to useful properties, at the base of nutri-score, eco-score, allergens identification and some other properties.
  
−
Each taxonomy is a DAG (directed acyclic graph) where leaves have one or more parents. Currently the taxonomy is in a raw text file in our repository: <nowiki>https://github.com/openfoodfacts/openfoodfacts-server/tree/main/taxonomies</nowiki>.
+
Each taxonomy is a DAG (directed acyclic graph) where leaves have one or more parents. Currently the taxonomy is in a raw text file in our repository: https://github.com/openfoodfacts/openfoodfacts-server/tree/main/taxonomies.
  
 
While effective for the application, this format is quite cumbersome to edit for contributors.
 
While effective for the application, this format is quite cumbersome to edit for contributors.
Line 37: Line 45:
  
 
As a bonus, it would be really interesting to know the impact of a modification on the application. For that we could imagine simple API’s (one for each taxonomy) on the openfoodfact application to visualize which products would be affected by a change. This feedback could be a really interesting tool to ensure no error is made (unexpected side effects)
 
As a bonus, it would be really interesting to know the impact of a modification on the application. For that we could imagine simple API’s (one for each taxonomy) on the openfoodfact application to visualize which products would be affected by a change. This feedback could be a really interesting tool to ensure no error is made (unexpected side effects)
−
 
−
Technologies: On the technical side, you can choose freely, in accordance with your mentor, which technology to use, still the capacity for the contributors community to maintain it in the long run is an important criteria.
 
−
 
−
Skills required/preferred: The candidate should be creative, but also have a good logical thinking capacity and also be able to track possible problems ahead.
 
−
 
−
* Slack channels: #taxonomies
 
−
* Potential mentors: Stéphane Gigandet / Alexandre Garel
 
−
* Project duration: 350h
 
−
* Difficulty rating: Medium
 
−
 
 
==== Timeline ====
 
==== Timeline ====
  
−
* Timeline proposed by Aardash: https://drive.google.com/file/d/1KeNLc-2V1U_zcA-3QkvBm35LxYSItQZc/view?usp=sharing
+
* Timeline proposed by Aadarsh: https://drive.google.com/file/d/1KeNLc-2V1U_zcA-3QkvBm35LxYSItQZc/view?usp=sharing
−
* To be discussed
 
  
 
=== Resources / Contributing ===
 
=== Resources / Contributing ===
  
−
{{{contributing}}}
+
* Main GitHub repository: https://github.com/openfoodfacts/taxonomy-editor
 +
* Project to track current tasks: https://github.com/orgs/openfoodfacts/projects/28
  
−
{{{resources}}}
+
* [https://slack.openfoodfacts.org Slack] channels: #taxonomies #taxonomy-editor
 +
* Existing documentation on taxonomies : [[Global taxonomies]] - [[Product Opener/Taxonomy Edition]]
  
 
* Initial proposal: https://drive.google.com/file/d/1KeNLc-2V1U_zcA-3QkvBm35LxYSItQZc/view?usp=sharing
 
* Initial proposal: https://drive.google.com/file/d/1KeNLc-2V1U_zcA-3QkvBm35LxYSItQZc/view?usp=sharing
 +
* Meeting minutes: https://docs.google.com/document/d/1tdYkUmoRU8BxFPdCwtewoUi7PV8PmDlXtExOcPYyu-I/edit?usp=sharing
 +
* Figma mockups: https://www.figma.com/file/7QxD2pOnVntjDPqbHHPGHv/Taxonomy-Editor?node-id=0%3A1
  
 
=== Archives ===
 
=== Archives ===
Line 64: Line 65:
  
 
[[Category:Project]]
 
[[Category:Project]]
−
 
+
[[Category:Deprecated]]
−
<noinclude>
 
−
[[Category:Templates]]
 
−
 
 
−
== TODO ==
 
−
* conditional display (text or alternative is displayed based on a condition)? <code>{{ #if: {{{title}}} | {{{title}}} | ... }}</code>
 
−
* add TemplateData extension to help filling the template with the visual editor (see https://www.mediawiki.org/wiki/Extension:TemplateData )
 
−
</noinclude>
 

Latest revision as of 15:36, 18 April 2023

ARCHIVE: this page is archived. Useful information is on the github repository: https://github.com/openfoodfacts/taxonomy-editor/

Summary

The Open Food Facts database contains a lot of information on food products, such as ingredients, labels, additives etc. To link this information to useful properties such as Nutri-Score, Agribalyse and many more, taxonomies are used within the database.

A taxonomy in Open Food Facts is a raw text file containing a Directed Acyclic Graph (DAG) where each leaf node has one or more parent nodes. It is mainly used for classification and translation of various food products within the database. Hence, taxonomies are at the heart of data structures in the Open Food Facts database and must be maintained properly.

The taxonomy files present in Open Food Facts are long to read (ingredients.txt taxonomy alone has around 80000 lines!) and cumbersome to edit by contributors.

This project provides an User-Friendly interface developed for editing taxonomies with ease. This tool is helpful for contributors to visualize a node's translations, properties, parents and children in a single page. The editor allows users to perform CRUD operations on the taxonomy and on the nodes present. A fast search mechanism for finding nodes within the taxonomy has also been implemented successfully.

The introduction of this Taxonomy Editor would help existing contributors edit taxonomies seamlessly and will encourage more contributions from the wonderful community of Open Food Facts.

Description

Status: Selected for GSOC 2022, Completed

People:

  • Aadarsh Anantha Ramakrishnan (GSOC intern)
  • Charles Népote, Stéphane Gigandet (mentors)

Impact (why)

Taxonomies are at the heart of openfoodfacts in many aspects. It helps identify components (ingredients, labels, brands,…) and link them to useful properties, at the base of nutri-score, eco-score, allergens identification and some other properties.

Each taxonomy is a DAG (directed acyclic graph) where leaves have one or more parents. Currently the taxonomy is in a raw text file in our repository: https://github.com/openfoodfacts/openfoodfacts-server/tree/main/taxonomies.

While effective for the application, this format is quite cumbersome to edit for contributors.

Expected outcomes (what)

We would like to have a tool (online or standalone) to edit taxonomies.

Expected outcomes:

The tool should:

  • help quickly find an element with a search
  • help visualize the hierarchy of components
  • help visualize the component, it’s synonyms in multiple languages
  • indicate inherited properties for an element, and signal when there are more than one
  • enable edition of those names, synonyms and properties
  • run some validation on names, synonyms and properties (no duplicate, specific formats, etc.)

As a bonus, it would be really interesting to know the impact of a modification on the application. For that we could imagine simple API’s (one for each taxonomy) on the openfoodfact application to visualize which products would be affected by a change. This feedback could be a really interesting tool to ensure no error is made (unexpected side effects)

Timeline

Resources / Contributing

Archives

Retrieved from "https://wiki.openfoodfacts.org/index.php?title=GSOC_2022_-_Taxonomy_editor&oldid=19488"