Skip to content

octo-technology/VIO

Repository files navigation

VIO - Visual Inspection Orchestrator

CI edge_orchestrator CI edge_interface GitHub issues

🎥 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

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

VIO full documentation can be found here

🧱 Requirements

  • docker installed
  • make installed

🚀 Getting started

Install the framework

git clone git@github.com: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:

stack-up-with-docker

Accessing the services

Once all services are up and running you can access:

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:

vio-architecture-stack

🛰️ Technology features

  • 🏠 Hosting :
    • ☁️ Hub : Cloud possibilities with Azure and GCP
    • 🛸 Host : Using raspberries
    • 🐳 Host : Docker or locally with anaconda
  • 👮 Fleet management :
  • ⚡️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 Status Github registry

📝 License

VIO is licensed under Apache 2.0 License

🙋 Contributing

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