Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 2.79 KB

README.md

File metadata and controls

57 lines (43 loc) · 2.79 KB

Facial-Landmark-Detection: Real-time 3D facial landmark detection optimized for mobile and edge

Detects facial landmarks (eg, nose, mouth, etc.). This model's architecture was developed by Qualcomm. The model was trained by Qualcomm on a proprietary dataset of faces, but can be used on any image.

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.

Setup

1. Install the package

Install the package via pip:

# NOTE: 3.10 <= PYTHON_VERSION < 3.14 is supported.
pip install "qai-hub-models[facemap-3dmm]"

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:

python -m qai_hub_models.models.facemap_3dmm.demo { --quantize w8a8 }

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.

By default, the demo will run locally in PyTorch. Pass --eval-mode on-device to the demo script to run the model on a cloud-hosted target device.

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:

python -m qai_hub_models.models.facemap_3dmm.export { --quantize w8a8 }

Additional options are documented with the --help option.

License

  • The license for the original implementation of Facial-Landmark-Detection can be found here.

Community