Skip to content

README.md

Latest commit

 

History

History
136 lines (105 loc) · 6.45 KB

README.md

File metadata and controls

136 lines (105 loc) · 6.45 KB
Raw

Falcon3-7B-Instruct: State-of-the-art large language model useful on a variety of language understanding and generation tasks

Falcon3 family of Open Foundation Models is a set of pretrained and instruct LLMs ranging from 1B to 10B.

This is based on the implementation of Falcon3-7B-Instruct 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 Falcon3-7B-Instruct:

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

# Inspect the model's metadata
qai-hub-models info Falcon3-7B-Instruct

# Print performance and accuracy metrics
qai-hub-models perf Falcon3-7B-Instruct
qai-hub-models numerics Falcon3-7B-Instruct

# Pre-exported assets are not available to download for this model due to
# licensing restrictions. Continue to the next section to export it yourself.

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

Deploying Falcon3-7B-Instruct on-device

Follow the GenieX quickstart to install GenieX and deploy the model on a target device.

You'll need to export the model artifact using the steps below, then follow Run a Local Model with GenieX.

See the LLM-on-Genie tutorial to run with the Genie runtime. Note: Genie support will be deprecated soon.

Export

Setup

1. Install the package

Install the package via pip:

# NOTE: 3.10 <= PYTHON_VERSION < 3.14 is supported.
pip install "qai-hub-models[falcon-v3-7b-instruct]"

For falcon_v3_7b_instruct, some additional functionality can be faster or is available only with a GPU on the host machine.

  • 🟢 Exporting the model for on-device deployment (GPU not required)
  • 🟡 Running the demo (GPU recommended for speed, but not required)
  • 🟡 Running evaluation (GPU recommended for speed, but not required)
  • 🔴 Quantizing the model (GPU required)

If you are quantizing your own variant of falcon_v3_7b_instruct, a dedicated CUDA enabled GPU (40 GB VRAM for 3B models to 80 GB VRAM for 8B models) is recommended. A GPU can also increase the speed of evaluation and demo of your quantized model significantly but it not strictly required.

Install the GPU package via pip:

# NOTE: 3.10 <= PYTHON_VERSION < 3.14 is supported.
pip install "qai-hub-models[falcon-v3-7b-instruct]"
pip install onnxruntime-gpu==1.23.2 https://github.com/quic/aimet/releases/download/2.26.0/aimet_onnx-2.26.0+cu121-cp310-cp310-manylinux_2_34_x86_64.whl -f https://download.pytorch.org/whl/torch_stable.html

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.

Verify with CLI Demo

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

python -m qai_hub_models.models.falcon_v3_7b_instruct.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 the model artifact

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. Export the pre-quantized model (published on AI Hub) for on-device deployment:

qai-hub-models export falcon_v3_7b_instruct --checkpoint DEFAULT_W4A16 --target-runtime geniex_qairt --device "Samsung Galaxy S25 (Family)"

--checkpoint also accepts DEFAULT (the model's default precision).

Optionally, quantize your own variant first and export the resulting checkpoint:

python -m qai_hub_models.models.falcon_v3_7b_instruct.quantize --precision w4a16 --output-dir ./quantized_checkpoint
qai-hub-models export falcon_v3_7b_instruct --checkpoint ./quantized_checkpoint --target-runtime geniex_qairt --device "Samsung Galaxy S25 (Family)"

Additional options are documented with the --help option.

License

  • The license for the original implementation of Falcon3-7B-Instruct can be found here.

References

Community

Usage and Limitations

This model may not be used for or in connection with any of the following applications:

  • Accessing essential private and public services and benefits;
  • Administration of justice and democratic processes;
  • Assessing or recognizing the emotional state of a person;
  • Biometric and biometrics-based systems, including categorization of persons based on sensitive characteristics;
  • Education and vocational training;
  • Employment and workers management;
  • Exploitation of the vulnerabilities of persons resulting in harmful behavior;
  • General purpose social scoring;
  • Law enforcement;
  • Management and operation of critical infrastructure;
  • Migration, asylum and border control management;
  • Predictive policing;
  • Real-time remote biometric identification in public spaces;
  • Recommender systems of social media platforms;
  • Scraping of facial images (from the internet or otherwise); and/or
  • Subliminal manipulation