https://github.com/openfoodfacts/robotoff
🤖 Real-time and batch prediction service for Open Food Facts
https://github.com/openfoodfacts/robotoff
openfoodfacts python python3
Last synced: 5 months ago
JSON representation
🤖 Real-time and batch prediction service for Open Food Facts
- Host: GitHub
- URL: https://github.com/openfoodfacts/robotoff
- Owner: openfoodfacts
- License: agpl-3.0
- Created: 2018-12-17T15:25:27.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:46:24.000Z (over 1 year ago)
- Last Synced: 2024-10-29T10:59:37.486Z (over 1 year ago)
- Topics: openfoodfacts, python, python3
- Language: Python
- Homepage: https://openfoodfacts.github.io/robotoff/
- Size: 43.8 MB
- Stars: 79
- Watchers: 13
- Forks: 54
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-europe - Robotoff - square&label=⭐)](https://github.com/openfoodfacts/robotoff/stargazers) [](https://github.com/openfoodfacts/robotoff/commits/main) [](https://github.com/openfoodfacts/robotoff) [](https://github.com/openfoodfacts/robotoff/blob/main/LICENCE) - Machine learning prediction service for Open Food Facts product categorization and quality checks. (Agriculture and Food Safety)
README
# Robotoff
[](https://github.com/openfoodfacts/robotoff/actions/workflows/quality_check.yml)
[](https://codecov.io/gh/openfoodfacts/robotoff)
[](https://github.com/psf/black)
**Robotoff** is a service that generates predictions from product data such as images, text, and metadata. These predictions can individually or collectively be refined into actionable suggestions known as insights. Insights serve as potential updates to the Open Food Facts database, either automatically applied when highly confident or validated manually by human annotators. These insights cover a growing set of product facts, including:
- the product category, weight, brand, packager codes and expiration date
- some of its labels
- abusive pictures (selfies)
- rotated pictures
Robotoff provides an API to:
- Fetch insights
- Annotate an insight (accept or reject)
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.
A detailed description of [how predictions and insights work is available here](https://openfoodfacts.github.io/robotoff/explanations/predictions/).
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:**
**Source code:**
**🍊 Open Food Facts:**
## Overview
- To get a better understanding on how Robotoff works, go to [Architecture](https://openfoodfacts.github.io/robotoff/introduction/architecture/).
- If you want to help, go to [Contributing](https://openfoodfacts.github.io/robotoff/introduction/contributing/).
- Robotoff can be used as...
- an [online API](https://openfoodfacts.github.io/robotoff/references/api/)
- a CLI tool
- a [Python package](https://openfoodfacts.github.io/robotoff/references/package/)
- If you need to deploy or maintain Robotoff, [Maintenance](https://openfoodfacts.github.io/robotoff/how-to-guides/deployment/maintenance) is the way to go.
## 🔧 Development
### API Specification Linting
Robotoff uses [Spectral](https://stoplight.io/open-source/spectral) to lint the OpenAPI specification file located at `docs/references/api.yml`. This ensures the API documentation follows best practices and remains consistent.
#### Running API Linting
All linting commands use Docker, so you don't need to install Spectral locally:
```bash
# Lint the API specification with pretty formatting
make api-lint
# Check the API specification and fail on errors (used in CI)
make api-lint-check
```
#### Configuration
The linting rules are configured in `.spectral.yml` at the root of the repository. The configuration extends the standard OpenAPI ruleset with custom rules specific to the Robotoff API.
#### CI Integration
API linting runs automatically on GitHub Actions when:
- Changes are made to `docs/references/api.yml`
- Changes are made to `.spectral.yml`
The workflow will fail if there are any linting errors, ensuring the API specification maintains high quality.
**NOTE:** This documentation tries to follow as much as possible the documentation system from [Diátaxis](https://diataxis.fr/).
## 👩⚖️ Licence
- Robotoff is licensed under the AGPLv3.
## 📆 Weekly meetings
- We e-meet every first Tuesday of each month, at 11:00 Paris Time (10:00 London Time, 15:30 IST, 02:00 AM PT)
-  Video call link: https://meet.google.com/qvv-grzm-gzb
- Join by phone: https://tel.meet/qvv-grzm-gzb?pin=9965177492770
- Add the Event to your Calendar by [adding the Open Food Facts community calendar to your calendar](https://wiki.openfoodfacts.org/Events)
- [Weekly Agenda](https://drive.google.com/open?id=1RUfmWHjtFVaBcvQ17YfXu6FW6oRFWg-2lncljG0giKI): please add the Agenda items as early as you can. Make sure to check the Agenda items in advance of the meeting, so that we have the most informed discussions possible.
- The meeting will handle Agenda items first, and if time permits, collaborative bug triage.
- We strive to timebox the core of the meeting (decision making) to 30 minutes, with an optional free discussion/live debugging afterwards.
- We take comprehensive notes in the Weekly Agenda of agenda item discussions and of decisions taken.
## Contributors
