Workflows

ApertureDB Workflows make it easy to perform certain common tasks, like ingesting datasets and adding embeddings or bounding boxes. The most convenient way to execute a workflow against an ApertureDB Cloud instance is via the ApertureDB Cloud interface. See the documentation for more information.

About this repository

This repository contains the code used to implement various ApertureDB workflows and build them into Docker images. This will allow you to do various things that you can't do via the UI:

• Execute workflows against non-Cloud ApertureDB instances.
• Access various advanced options.
• Find out details of what the code is doing in the database.
• Copy and adapt the underlying code.

List of workflows

• Dataset Ingestion: Load various public datasets.
• Embeddings Extraction: Automatically generate embeddings for images.
• Face Detection: Find faces within images and generate bounding boxes. Optionally generate embeddings for the extracted faces.
• Object Detection: Detect objects within images and add labelled bounding boxes.
• Jupyter Lab: Run a Jupyter Notebook server that has access to your ApertureDB instance.

Docker

This is the general pattern for running a workflow. Every workflow requires the host, user name, and password for your ApertureDB instance. Workflows typically have additional parameters.

docker run \
           -e RUN_NAME=my_testing_run \
           -e DB_HOST=<HOSTNAME> \
           -e DB_USER=<USERNAME> \
           -e DB_PASS="<PASSWORD>" \
           aperturedata/workflows-<APP-DIR>

Common parameters

Certain parameters are supported by all workflow images:

• RUN_NAME: A name for this run. May be used in internal logging or reporting.
• DB_HOST: Hostname of the ApertureDB instance
• DB_PORT: Port number for the ApertureDB instance. Defaults to 55555.
• DB_USER: ApertureDB user name. Defaults to admin.
• DB_PASS: ApertureDB password.
• USE_SSL: Use SSL to protect the connection. Defaults to true. We recommend that you do not change this.
• USE_REST: Use the REST API instead of the TCP connection. Defaults to false. We recommend that you do not change this.

Building Docker images

Every workflow directory has a build.sh script allowing you to produced a customized version of the image.