Skip to content
Switch branches/tags

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

VFRAME: Visual Forensics, Redaction, and Metadata Extraction

VFRAME is a computer vision toolkit designed for analyzing large media archives of images and videos. It includes a ModelZoo and a customizable plugin architecture to develop custom CLI tools.

VFRAME is still under development and code is subject to major changes.

The recommended way to use this VFRAME is with a custom OpenCV build. This utilizes NVIDIA GPUs for DNN inference and omits unused modules. The Conda environment yaml only includes a general CPU version of OpenCV, however CPU inference is too slow for production. Several Docker options are also included. Follow instructions below to setup VFRAME with OpenCV CUDA DNN enabled.

If you're having issues installing, read the troubleshooting guide before filing an issue.

Setup Conda Environment

# Clone this repo
git clone

# Create Conda environment
conda env create -f environment-linux.yml  # Linux CPU (Another step required for GPU)
#conda env create -f environment-osx.yml  # MacOS CPU

# Copy and edit .env variables
cp .env-sample .env

Setup OpenCV DNN inference for GPU acceleration (requires NVIDIA GPU)

Test Installation

# cd to CLI root
cd vframe_cli

# Show list of commands
./ -h


# Show list of modelzoo commands
./ modelzoo

# Test a model (auto-downloads model)
./ modelzoo test -m coco

# Speed test model for 20 iterations
./ modelzoo benchmark -m coco --iters 20 --cpu  # use CPU
./ modelzoo benchmark -m coco --iters 20 --gpu  # use GPU if available

Read more about the ModelZoo

Detect Objects

# detect objects using COCO model (replace "image.jpg" with your image)
./ pipe open -i image.jpg detect -m coco draw display

# detect objects using OpenImages model
./ pipe open -i image.jpg detect -m openimages draw display

Read more about object detection and the ModelZoo

Blur Faces

# Detect and blur faces in directory of images
./ pipe open -i input/ detect -m yoloface redact save_image -o output/

Read more about redaction

Under Development

  • train object detector
  • synthetic data generator
  • face blur with tracking
  • search engine interface
  • cvat management


VFRAME gratefully acknowledges support from the following organizations and grants:

VFRAME received support from the NLNet Foundation and Next Generation Internet (NGI0) supported research and development of face blurring and biometric redaction tools during 2019 - 2021. Funding was provided through the NGI0 Privacy Enhancing Technologies Fund, a fund established by NLnet with financial support from the European Commission’s Next Generation Internet program.

VFRAME development during 2019-2021 is being supported with a three-year grant by Meedan / Check Global. With this grant, we have developed tools to integrate computer vision in to Check's infrastructure, allowing computer vision to be deployed in the effort to verify breaking news, and carried out research and development of the synthetic data generation and training environment.

VFRAME development in 2018 and 2019 was supported with a grant from the German Federal Ministry of Education and Research (Bundesministerium für Bildung und Forschung) and the Prototype Fund. This funding allowed VFRAME to research computer vision applications in human rights, prototype annotation and processing applications, implement a large-scale visual search engine, and prototype the synthetic 3D data generation environment.

Read more about supporting VFRAME on the website