README.md

VIO - Visual Inspection Orchestrator

🎥 Visual Inspection Orchestrator is a modular framework made to ease the deployment of VI usecases 🎥

Usecase example: Quality check of a product manufactured on an assembly line.

🏗️ Modular framework

The VIO modules are split between:

vio-edge modules: The VIO edge modules are deployed close to the object to inspect

• The edge orchestrator
• The edge interface
• The edge model serving
• The edge deployment playbook

vio-hub modules: The VIO hub modules are deployed in the cloud to collect data and orchestrate the edge fleet

• The hub monitoring
• The hub deployment playbook

VIO full documentation can be found here

🧱 Requirements

• docker installed
• make installed

🚀 Getting started

Install the framework

git clone [email protected]:octo-technology/VIO.git

Running the stack

To launch the stack you can use the Makefile on the root of the repository which define the different target based on the docker-compose.yml as described below, or run the modules locally.

Start vio

To start all edge services (orchestrator, model-serving, interface, db) with local hub monitoring (grafana):

make vio-edge-up

Stop vio

To stop and delete all running services :

make vio-edge-down

To check all services are up and running you can run the command docker ps, you should see something like below:

Accessing the services

Once all services are up and running you can access:

• the swagger of the edge orchestrator API (OrchestratoAPI): http://localhost:8000/docs
• the swagger of the edge model serving: http://localhost:8501/docs
• the hub monitoring: http://localhost:4000/login
• the edge interface: http://localhost:8080

From the edge interface you can load a configuration and run the trigger button that will trigger the Core API and launch the following actions:

🛰️ Technology features

• 🏠 Hosting :
  • ☁️ Hub : Cloud possibilities with Azure and GCP
  • 🛸 Host : Using raspberries
  • 🐳 Host : Docker or locally with anaconda
• 👮 Fleet management :
  • 📦 Fleet integration/deployment with Ansible
  • 🕵️ Fleet supervision/observability with Grafana & Open-Telemetry
• ⚡️Backend API with FastAPI
• 📜 Frontend with Vue.js
• 🏭 Continuous Integration & Continuous Development :
  • ♟️ Github actions
  • 📝️ Clean code with Black & Flake8
  • ✅ Tested with Pytest
• 📈 Grafana insight & dashboard

🏭 Releases

Build Type	Status	Artifacts
Docker images		Github registry

📝 License

VIO is licensed under Apache 2.0 License

🙋 Contributing

Learn more about how to get involved on CONTRIBUTING.md guide