Skip to main content Link Menu Expand (external link) Document Search Copy Copied

BQAT CLI

Table of contents

New version of run.sh is published, please download the latest and replace the old one.

Setup

This tool is designed to be run as a Docker container via command line interface (terminal). For ease of use, a convenience script is provided.

Download the script

Linux

Bash

Windows

Powershell

Usage

  • Download the script above into your working directory.
  • Create a folder named data under your working directory and put your input files in this folder.

After the aforementioned steps, you should have a folder like this:

Screenshot

# Grant execution permission to the script (for Linux shell script)
sudo chmod +x run.sh
  • Open your CLI and navigate to this directory.
  • Enter the command below to run BQAT.

For Bash (Linux, macOS, Windows):

# Process all face images in data/ folder
./run.sh --input data/ --mode face

# Process iris images in data/iris/ folder
./run.sh --input data/iris/ --mode iris

Note: If there is any space along the filepath, wrap it with double quotes and escape the space.
Please refer to the example below: e.g. input folder is data/iris folder/

./run.sh --input "data/iris\ folder/" --mode iris

Note: The path format of the mounted volumes in the run.sh may need modification for the specific shell (e.g. under Windows. Or you can use the powershell script as follows).

For PowerShell (Winodws, Linux):

# Process all face images in data/ folder
.\run.ps1 --input data/ --mode face

# Process iris images in data/iris/ folder
.\run.ps1 --input data/iris/ --mode iris

Get BQAT-CLI Update if available:

# Linux
./run.sh --update

# Windows
.\run.ps1 --update

Output

The outputs will be saved at: data/output/.

Further details about the command and other option flags

Note: The tool is designed to be executed with a /data folder in your working directory. The /data folder (where all the images are stored) will be mounted to the container. “Read and write” permission is required for this folder. It should work as long as the folder was created before spinning up the server. Otherwise, the ownership of the folder will need to be changed.