Skip to content

README.md

Latest commit

 

History

History
83 lines (63 loc) · 4.17 KB

README.md

File metadata and controls

83 lines (63 loc) · 4.17 KB
Raw

OpusMT-En-Zh: OpusMT English to Chinese neural machine translation model based on MarianMT transformer architecture

OpusMT English to Chinese translation model is a state-of-the-art neural machine translation system designed for translating English text into Chinese. This model is based on the Marian transformer architecture and has been optimized for edge inference by splitting into encoder and decoder components with modified attention mechanisms. It exhibits robust performance for real-world translation tasks, making it highly reliable for practical applications. The model supports input sequences up to 256 tokens and can generate Chinese translations with high accuracy.

This is based on the implementation of OpusMT-En-Zh 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 OpusMT-En-Zh:

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 OpusMT-En-Zh

# Print performance and accuracy metrics
qai-hub-models perf OpusMT-En-Zh
qai-hub-models numerics OpusMT-En-Zh

# Download a ready-to-deploy asset
qai-hub-models fetch OpusMT-En-Zh --runtime voice_ai --precision float

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

Deploying OpusMT-En-Zh on-device

This model is compatible with the Qualcomm Voice AI SDK. Download the SDK from the Qualcomm Package Manager to deploy this model on-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[opus-mt-en-zh]"

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.opus_mt_en_zh.demo

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 opus_mt_en_zh --target-runtime voice_ai --precision float --device "Samsung Galaxy S25 (Family)"

Additional options are documented with the --help option.

License

  • The license for the original implementation of OpusMT-En-Zh can be found here.

References

Community