GSOC/2023 ideas list

From Open Food Facts wiki
Revision as of 11:08, 7 February 2023 by Teolemon (talk | contribs)

Ideas for GSOC 2023 will be posted here. There are just ideas, and are non limitative.

Server-side

A New API: Simplify and unify the Open Food Facts API used by 200+ apps

Description

Open Food Facts provides a free and open API to read, search and write products data and photos. This API powers more than 200 apps developed by 3rd parties, and is also used by many tools like our AI platform Robotoff and our power contribution tool Hunger Games. Our API is unfortunately very difficult to understand and use as it evolved organically in the last 10 years. It's not 1 API in fact, it's several APIs to do different things, and we have multiple versions of those APIs, each with a different state of features and documentation. This project aims to bring "A New API" to our many reusers. An API that is simple, unified, easy to understand and use, well documented (with OpenAPI) and well tested.

Expected outcomes

We started to build a new API v3 to provide a clean, generic and unified way to query all API features of Open Food Facts. This new API v3 is currently available for only a very small subsets of our existing APIs: product read, a very small subset of product write, and taxonomy suggestions.

This project is about revisiting one by one all existing APIs to:

  1. Decide which feature should be added, changed (or maybe even removed)
  2. Define the API for each feature (e.g. method, path, parameters, query and response headers and bodies etc.) and document it using OpenAPI. (This step is critical to ensure that the API will be both useful and used, and will need to be done in coordination with existing users of the API.)
  3. Implement the API for the feature and add integration tests for it

APIs that needs to be converted to API v3:

  • Product image upload, selection and crop
  • Full support for product write (should be done incrementally)
  • Search
  • Taxonomy read
  • User creation and profile edition
  • Authentification

Project information

    Bring Taxonomy editor to a fully usable tool

    Description

    Taxonomies are at the heart of Open Food Facts 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.

    Taxonomy editor was started during last Google Summer of code. Thanks to the work of Aadarsh, we got a first demonstration of the product, and it’s been in continuous development since then. But a boost would be needed to make it a really usable project.

    Expected outcomes

    Minimum feature set to be added would be: good inline documentation to on board users, an ergonomic UI, searching for potential issues in the taxonomy, tracking modification to enable undoing changes and comparison to original taxonomy, helping find entries to translate. The idea is to enable a wide public of contributors to participate in adding translation or simple items (like ingredients) while ensuring quality and helping moderators validate changes. Another important technical feature will be to augment significantly test coverage (at least on backend part).

    From there, according to the pace of the projects many more features could be added which would be of great benefit: embarked assistance integrating tools (eg. searching / linking to wikidata, or wiktionary), integration of the products database (eg. seeing which entries need to be added or translated first), navigation in the taxonomy.

    An important aspect: as this tool is meant to live a long time quality and maintainability of the project is important.

    Project information

      Improve our producer platform to the next level

      Description

      One lesser known but very important aspect of Open Food Facts is that, not only do we encourage citizens to contribute to the database (crowdfunding) but we also propose producers to do so. The incentive for them is to ensure they provide up to date and accurate information, that their products are well represented (eg. with studio photography). They also get hints on data quality to make their product better, which is an important goal to Open Food Facts.

      Thanks to the support of the national French public health agency Santé Publique France, the platform is already alive and working. Though it is a bit rough for our users that are not tech savvy, also there are a lot of features which could help adoption and lessen the support needed to operate it.

      Technically the producer platform uses the same code base as the main website.

      Expected outcomes

      The project will bring many new features to the producer platform. Here are some of the current priorities: add more inline help, make UX more convenient, support advanced updates patterns on fields, add a workflow to product edition, connect to our internal CRM (allow automating many tasks), collect more statistics on usage, support more fields and format for data import, more robust import/publishing workflows and add more tests.

      Extended goals include adding rules to help producers make products with better Eco-score, advanced features to make editing products easier (like picture upload).

      Project information

        Data Quality & Moderation Hub

        Description

        Open Food Facts infrastructure is currently focused on reflecting the current state of the database, which is its primary goal. However, it would be beneficial to introduce a queue/backlog system to coordinate the efforts of users in data cleaning and moderation.

        The system currently provides some level of coordination through the facets, indicating missing nutritional data and providing a list of products that need completion. However, this system lacks flexibility.

        Expected outcomes

        Currently, robots send messages to Slack channels that the admins need to clean. A queue of remaining problems to moderate would simplify the workload for the team and make it easier to track progress. It would also allow users to request moderation or ask questions.

        In a perfect world, users would be able to create their own tasks, such as "extract nutritional table," and associate barcodes with each step.

          • select nutritional table image
          • crop nutritional table image
          • fill nutriments
      The MVP would include a back-end with an API for moderation, providing a table with information such as barcode, image_id, type_of_problem, author (including Robotoff), and moderation status (has_been_moderated). The front-end would allow users to delete pictures and mark elements as moderated. The next steps would involve supporting questions from users and allowing moderators to answer them. This would include:
        • Extending the database to save questions
        • Send emails with the answer from moderation interface
        • Add buttons in main website to send questions

        Project information

          • repository: https://github.com/openfoodfacts/hunger-games/
          • Slack channels: #hunger-games #robotoff #data-quality
          • Potential mentors: Raphael, Charles, Pierre, Alex
          • Project duration: 350 hours
          • Skills required: PostgreSQL, Python, Frontend (React/ReactNative or Flutter)
          • Difficulty rating: Medium

          Impact metrics for Open Food Facts

          Description coming soon

          Mobile-side

          Coming soon

Retrieved from "https://test-wiki.openfoodfacts.org/index.php?title=GSOC/2023_ideas_list&oldid=18866"