Skip to content

Commit

Permalink
doc: Start of a doc update for Insights and Predictions (#650)
Browse files Browse the repository at this point in the history
  • Loading branch information
teolemon authored Mar 16, 2022
1 parent 8455868 commit 442743c
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,8 @@
[![codecov](https://codecov.io/gh/openfoodfacts/robotoff/branch/master/graph/badge.svg?token=BY2T0KXNO1)](https://codecov.io/gh/openfoodfacts/robotoff)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

**Documentation:** <https://openfoodfacts.github.io/robotoff>

**Source code:** <https://github.com/openfoodfacts/robotoff>

**Open Food Facts:** <https://world.openfoodfacts.org>

**Robotoff** is a service managing potential Open Food Facts updates (also known as _insights_).
**Robotoff** is a service managing potential Open Food Facts updates (also known as _insights_) and predictions (which can then be combined to generate an insight).
These insights include a growing set of facts, including:

- the product category, weight, brand, packager codes and expiration date
Expand All @@ -27,6 +22,14 @@ Robotoff provides an API to:
Once generated, the insights can be applied automatically, or after a manual validation if necessary.
A scheduler regularly marks insights for automatic annotation and sends the update to Open Food Facts.

Robotoff works together with [Product Opener](https://github.com/openfoodfacts/openfoodfacts-server), the Core server of Open Food Facts (in Perl, which can also be installed locally using Docker) and the [Open Food Facts apps](https://github.com/openfoodfacts/smooth-app) (which can work with your local instance after enabling dev mode)

**Documentation:** <https://openfoodfacts.github.io/robotoff>

**Source code:** <https://github.com/openfoodfacts/robotoff>

**Open Food Facts:** <https://world.openfoodfacts.org>

## Overview

- To get a better understanding on how Robotoff works, go to [Architecture](https://openfoodfacts.github.io/robotoff/introduction/architecture/).
Expand Down

0 comments on commit 442743c

Please sign in to comment.