Skip to content

README.md

Latest commit

 

History

History
80 lines (62 loc) · 3.29 KB

README.md

File metadata and controls

80 lines (62 loc) · 3.29 KB
Raw

CavaFace: Comprehensive facial analysis by extracting face features

A PyTorch-based framework for training face recognition models that generates facial embeddings for verification and identification tasks

This is based on the implementation of CavaFace found here. This repository contains scripts for optimized on-device export suitable to run on Qualcomm® devices. More details on model performance across various devices, can be found here.

Qualcomm AI Hub Models uses Qualcomm AI Hub Workbench to compile, profile, and evaluate this model. Sign up to run these models on a hosted Qualcomm® device.

Quick Start

Use our lightweight command-line interface to inspect and download CavaFace:

pip install qai_hub_models_cli # (the CLI is also available with the qai-hub-models package)

# Inspect the model and list the available download options
qai-hub-models info CavaFace

# Print performance and accuracy metrics
qai-hub-models perf CavaFace
qai-hub-models numerics CavaFace

# Download a ready-to-deploy asset
qai-hub-models fetch CavaFace --runtime tflite --precision float

See the CLI README for the full list of commands and filters.

Setup

1. Install the package

Install the base package, then use the qai-hub-models CLI to install this recipe's dependencies:

# NOTE: 3.10 <= PYTHON_VERSION < 3.14 is supported.
pip install qai-hub-models
qai-hub-models install cavaface

2. Configure Qualcomm® AI Hub Workbench

Sign-in to Qualcomm® AI Hub Workbench with your Qualcomm® ID. Once signed in navigate to Account -> Settings -> API Token.

With this API token, you can configure your client to run models on the cloud hosted devices.

qai-hub configure --api_token API_TOKEN

Navigate to docs for more information.

Run CLI Demo

Run the following simple CLI demo to verify the model is working end to end:

qai-hub-models demo cavaface

More details on the CLI tool can be found with the --help option. See demo.py for sample usage of the model including pre/post processing scripts. Please refer to our general instructions on using models for more usage instructions.

Export for on-device deployment

To run the model on Qualcomm® devices, you must export the model for use with an edge runtime such as TensorFlow Lite, ONNX Runtime, or Qualcomm AI Engine Direct. Use the following command to export the model:

qai-hub-models export cavaface

Additional options are documented with the --help option.

License

  • The license for the original implementation of CavaFace can be found here.

References

Community