README ΒΆ
Website | Community | Blog
Visual Data Preparation (VDP) is an open-source visual data ETL tool to streamline the end-to-end visual data processing pipeline:
-
Extract unstructured visual data from pre-built data sources such as cloud/on-prem storage, or IoT devices
-
Transform it into analysable structured data by Vision AI models
-
Load the transformed data into warehouses, applications, or other destinations
Highlights
-
π The fastest way to build end-to-end visual data pipelines - building a pipeline is like assembling LEGO blocks
-
π±οΈ One-click import & deploy ML/DL models from popular GitHub, Hugging Face or cloud storage managed by version control tools like DVC or ArtiVC
-
π¦ Standardised vision task structured output formats to streamline with data warehouse
-
π Pre-built ETL data connectors for extensive data access
-
πͺ’ Build pipelines for diverse scenarios - SYNC for real-time inference and ASYNC for on-demand workload
-
π§ Scalable API-first microservice design for great developer experience - seamless integration to modern data stack at any scale
-
π€ Build for every Vision AI practitioner - The no-/low-code interface helps take off your AI Researcher/AI Engineer/Data Engineer/Data Scientist hat and put on the all-rounder hat to deliver more with VDP
Why we build VDP
Before we started to build VDP, we had fought with streaming large volume data (billions of images a day!) to automate vision tasks using deep learning-based computer vision.
We've learned that model serving for an effective end-to-end data flow requires not only high throughput and low latency but also cost efficiency, which altogether is non-trivial. Since 2016, building everything from scratch, we had had a battle-proven model serving system in-house running in production for years.
We'd love to generalise the infrastructure to make Vision AI more accessible to everyone. Fortunately what we had built can actually be modularised into working components to be used for a broader spectrum of vision tasks and industry sectors.
The goal of VDP is to seamlessly bring Vision AI into the modern data stack with a standardised framework. Check our blog post Missing piece in modern data stack: visual data preparation on how this tool is proposed to streamline unstructured visual data processing across different stakeholders.
How VDP works
The core concept of VDP is pipeline. A pipeline is an end-to-end workflow that automates a sequence of tasks to process visual data. Each pipeline is defined and formed by a recipe that contains three components:
-
source: where the pipeline starts. It connects the source of image and video data to be processed.
-
model instances: a series of deployed Vision AI models to process the ingested visual data in parallel and generate structured outputs
-
destination: where to send the structured outputs
Based on the mode of a pipeline, it will extract and process the visual data, and send the outputs to the destination every time the trigger event occurs.
Check out the pipeline recipe example below. This recipe defines that the pipeline accepts HTTP requests, processes the request data using YOLOv4 model, and returns the outputs in HTTP responses. With this simple configuration, now we have a pipeline equivalent to a powerful HTTP prediction server π.
{
"recipe": {
"source": "source-connectors/source-http",
"model_instances": [
"models/yolov4/instances/v1.0-cpu"
],
"destination": "destination-connectors/destination-http"
}
}
Note We use connector as a general term to represent data source and destination. Please find the supported connectors here.
Guidance philosophy
VDP is built with open heart and we expect VDP to be exposed to more MLOps integrations. It is implemented with microservice and API-first design principle. Instead of building all components from scratch, we've decided to adopt sophisticated open-source tools:
-
Triton Inference Server for high-performance model serving
-
Temporal for a reliable, durable and scalable workflow engine
-
Airbyte for abundant destination connectors
We hope VDP can also enrich the open-source communities in a way to bring more practical use cases in unstructured visual data processing.
Quick start
Execute the following commands to start pre-built images with all the dependencies:
$ git clone https://github.com/instill-ai/vdp.git && cd vdp
# Launch all services
$ make all
π That's it! Once all the services are up with health status, the UI is ready to go at http://localhost:3000!
Here is a step-by-step guide to build your first pipeline.
Warning The image of model-backend (~2GB) and Triton Inference Server (~11GB) can take a while to pull, but this should be an one-time effort at the first setup.
Shut down VDP
To shut down all running services:
$ make down
Documentation
π Documentation & tutorials are coming soon!
π API Reference
The gRPC protocols in protobufs provide the single source of truth for the VDP APIs. The genuine protobuf documentation can be found in our Buf Scheme Registry (BSR).
For the OpenAPI documentation, access http://localhost:3001 after make all
, or simply run make doc
.
Contribution
We love contribution to VDP in any forms:
-
Please refer to the guide for local development.
-
Please open issues in the repository
-
vdp for general issues;
-
pipeline-backend, connector-backend, model-backend, mgmt-backend, etc., for backend-specific issues.
-
-
Please refer to the VDP project board to track progress.
Note Code in the main branch tracks under-development progress towards the next release and may not work as expected. If you are looking for a stable alpha version, please use latest release.
Community support
For general help using VDP, you can use one of these channels:
-
GitHub (bug reports, feature requests, project discussions and contributions)
-
Discord (live discussion with the community and our team)
If you are interested in hosting service of VDP, we've started signing up users to our private alpha. Get early access and we'll contact you when we're ready.
License
See the LICENSE file for licensing information.
Directories ΒΆ
Path | Synopsis |
---|---|
examples
|
|
go/deploy-model
Package main implements a client for Model service.
|
Package main implements a client for Model service. |
go/test-model
Package main implements a client for Model service.
|
Package main implements a client for Model service. |