ConvNext-Base / README.md
qaihm-bot's picture
v0.45.0
efc149f verified
---
library_name: pytorch
license: other
tags:
- bu_auto
- android
pipeline_tag: image-classification
---
![](https://qaihub-public-assets.s3.us-west-2.amazonaws.com/qai-hub-models/models/convnext_base/web-assets/model_demo.png)
# ConvNext-Base: Optimized for Mobile Deployment
## Imagenet classifier and general purpose backbone
ConvNextBase is a machine learning model that can classify images from the Imagenet dataset. It can also be used as a backbone in building more complex models for specific use cases.
This model is an implementation of ConvNext-Base found [here](https://github.com/pytorch/vision/blob/main/torchvision/models/convnext.py).
This repository provides scripts to run ConvNext-Base on Qualcomm® devices.
More details on model performance across various devices, can be found
[here](https://aihub.qualcomm.com/models/convnext_base).
### Model Details
- **Model Type:** Model_use_case.image_classification
- **Model Stats:**
- Model checkpoint: Imagenet
- Input resolution: 224x224
- Number of parameters: 88.6M
- Model size (float): 338 MB
- Model size (w8a16): 88.7 MB
| Model | Precision | Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Primary Compute Unit | Target Model
|---|---|---|---|---|---|---|---|---|
| ConvNext-Base | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | TFLITE | 41.133 ms | 0 - 347 MB | NPU | [ConvNext-Base.tflite](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.tflite) |
| ConvNext-Base | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | QNN_DLC | 42.373 ms | 1 - 352 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.dlc) |
| ConvNext-Base | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | TFLITE | 19.116 ms | 0 - 400 MB | NPU | [ConvNext-Base.tflite](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.tflite) |
| ConvNext-Base | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | QNN_DLC | 20.642 ms | 1 - 411 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.dlc) |
| ConvNext-Base | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | TFLITE | 7.29 ms | 0 - 3 MB | NPU | [ConvNext-Base.tflite](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.tflite) |
| ConvNext-Base | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | QNN_DLC | 8.162 ms | 1 - 3 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.dlc) |
| ConvNext-Base | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | ONNX | 7.358 ms | 0 - 195 MB | NPU | [ConvNext-Base.onnx.zip](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.onnx.zip) |
| ConvNext-Base | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | TFLITE | 11.123 ms | 0 - 346 MB | NPU | [ConvNext-Base.tflite](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.tflite) |
| ConvNext-Base | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | QNN_DLC | 11.985 ms | 1 - 352 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.dlc) |
| ConvNext-Base | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | TFLITE | 5.534 ms | 0 - 414 MB | NPU | [ConvNext-Base.tflite](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.tflite) |
| ConvNext-Base | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | QNN_DLC | 6.075 ms | 1 - 421 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.dlc) |
| ConvNext-Base | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | ONNX | 5.445 ms | 0 - 394 MB | NPU | [ConvNext-Base.onnx.zip](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.onnx.zip) |
| ConvNext-Base | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | TFLITE | 4.128 ms | 0 - 345 MB | NPU | [ConvNext-Base.tflite](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.tflite) |
| ConvNext-Base | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | QNN_DLC | 4.636 ms | 1 - 355 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.dlc) |
| ConvNext-Base | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | ONNX | 4.223 ms | 0 - 327 MB | NPU | [ConvNext-Base.onnx.zip](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.onnx.zip) |
| ConvNext-Base | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen 5 Mobile | TFLITE | 3.188 ms | 0 - 349 MB | NPU | [ConvNext-Base.tflite](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.tflite) |
| ConvNext-Base | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen 5 Mobile | QNN_DLC | 3.548 ms | 1 - 355 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.dlc) |
| ConvNext-Base | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen 5 Mobile | ONNX | 3.361 ms | 1 - 329 MB | NPU | [ConvNext-Base.onnx.zip](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.onnx.zip) |
| ConvNext-Base | float | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN_DLC | 8.551 ms | 1 - 1 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.dlc) |
| ConvNext-Base | float | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 7.436 ms | 176 - 176 MB | NPU | [ConvNext-Base.onnx.zip](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base.onnx.zip) |
| ConvNext-Base | w8a16 | Dragonwing Q-6690 MTP | Qualcomm® QCM6690 | QNN_DLC | 75.588 ms | 0 - 376 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.dlc) |
| ConvNext-Base | w8a16 | Dragonwing Q-6690 MTP | Qualcomm® QCM6690 | ONNX | 740.896 ms | 68 - 86 MB | CPU | [ConvNext-Base.onnx.zip](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.onnx.zip) |
| ConvNext-Base | w8a16 | Dragonwing RB3 Gen 2 Vision Kit | Qualcomm® QCS6490 | QNN_DLC | 23.777 ms | 0 - 2 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.dlc) |
| ConvNext-Base | w8a16 | Dragonwing RB3 Gen 2 Vision Kit | Qualcomm® QCS6490 | ONNX | 1179.535 ms | 42 - 84 MB | CPU | [ConvNext-Base.onnx.zip](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.onnx.zip) |
| ConvNext-Base | w8a16 | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | QNN_DLC | 14.483 ms | 0 - 282 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.dlc) |
| ConvNext-Base | w8a16 | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | QNN_DLC | 8.902 ms | 0 - 326 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.dlc) |
| ConvNext-Base | w8a16 | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | QNN_DLC | 5.883 ms | 0 - 3 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.dlc) |
| ConvNext-Base | w8a16 | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | QNN_DLC | 6.122 ms | 0 - 282 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.dlc) |
| ConvNext-Base | w8a16 | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | QNN_DLC | 4.181 ms | 0 - 332 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.dlc) |
| ConvNext-Base | w8a16 | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | QNN_DLC | 3.263 ms | 0 - 276 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.dlc) |
| ConvNext-Base | w8a16 | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | ONNX | 249.621 ms | 55 - 203 MB | NPU | [ConvNext-Base.onnx.zip](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.onnx.zip) |
| ConvNext-Base | w8a16 | Snapdragon 7 Gen 4 QRD | Snapdragon® 7 Gen 4 Mobile | QNN_DLC | 7.659 ms | 0 - 327 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.dlc) |
| ConvNext-Base | w8a16 | Snapdragon 7 Gen 4 QRD | Snapdragon® 7 Gen 4 Mobile | ONNX | 693.474 ms | 44 - 57 MB | CPU | [ConvNext-Base.onnx.zip](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.onnx.zip) |
| ConvNext-Base | w8a16 | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen 5 Mobile | QNN_DLC | 2.513 ms | 0 - 288 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.dlc) |
| ConvNext-Base | w8a16 | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen 5 Mobile | ONNX | 242.068 ms | 37 - 186 MB | NPU | [ConvNext-Base.onnx.zip](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.onnx.zip) |
| ConvNext-Base | w8a16 | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN_DLC | 6.276 ms | 0 - 0 MB | NPU | [ConvNext-Base.dlc](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.dlc) |
| ConvNext-Base | w8a16 | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 207.832 ms | 137 - 137 MB | NPU | [ConvNext-Base.onnx.zip](https://huggingface.co/qualcomm/ConvNext-Base/blob/main/ConvNext-Base_w8a16.onnx.zip) |
## Installation
Install the package via pip:
```bash
pip install qai-hub-models
```
## Configure Qualcomm® AI Hub Workbench to run this model on a cloud-hosted device
Sign-in to [Qualcomm® AI Hub Workbench](https://workbench.aihub.qualcomm.com/) 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.
```bash
qai-hub configure --api_token API_TOKEN
```
Navigate to [docs](https://workbench.aihub.qualcomm.com/docs/) for more information.
## Demo off target
The package contains a simple end-to-end demo that downloads pre-trained
weights and runs this model on a sample input.
```bash
python -m qai_hub_models.models.convnext_base.demo
```
The above demo runs a reference implementation of pre-processing, model
inference, and post processing.
**NOTE**: If you want running in a Jupyter Notebook or Google Colab like
environment, please add the following to your cell (instead of the above).
```
%run -m qai_hub_models.models.convnext_base.demo
```
### Run model on a cloud-hosted device
In addition to the demo, you can also run the model on a cloud-hosted Qualcomm®
device. This script does the following:
* Performance check on-device on a cloud-hosted device
* Downloads compiled assets that can be deployed on-device for Android.
* Accuracy check between PyTorch and on-device outputs.
```bash
python -m qai_hub_models.models.convnext_base.export
```
## How does this work?
This [export script](https://aihub.qualcomm.com/models/convnext_base/qai_hub_models/models/ConvNext-Base/export.py)
leverages [Qualcomm® AI Hub](https://aihub.qualcomm.com/) to optimize, validate, and deploy this model
on-device. Lets go through each step below in detail:
Step 1: **Compile model for on-device deployment**
To compile a PyTorch model for on-device deployment, we first trace the model
in memory using the `jit.trace` and then call the `submit_compile_job` API.
```python
import torch
import qai_hub as hub
from qai_hub_models.models.convnext_base import Model
# Load the model
torch_model = Model.from_pretrained()
# Device
device = hub.Device("Samsung Galaxy S25")
# Trace model
input_shape = torch_model.get_input_spec()
sample_inputs = torch_model.sample_inputs()
pt_model = torch.jit.trace(torch_model, [torch.tensor(data[0]) for _, data in sample_inputs.items()])
# Compile model on a specific device
compile_job = hub.submit_compile_job(
model=pt_model,
device=device,
input_specs=torch_model.get_input_spec(),
)
# Get target model to run on-device
target_model = compile_job.get_target_model()
```
Step 2: **Performance profiling on cloud-hosted device**
After compiling models from step 1. Models can be profiled model on-device using the
`target_model`. Note that this scripts runs the model on a device automatically
provisioned in the cloud. Once the job is submitted, you can navigate to a
provided job URL to view a variety of on-device performance metrics.
```python
profile_job = hub.submit_profile_job(
model=target_model,
device=device,
)
```
Step 3: **Verify on-device accuracy**
To verify the accuracy of the model on-device, you can run on-device inference
on sample input data on the same cloud hosted device.
```python
input_data = torch_model.sample_inputs()
inference_job = hub.submit_inference_job(
model=target_model,
device=device,
inputs=input_data,
)
on_device_output = inference_job.download_output_data()
```
With the output of the model, you can compute like PSNR, relative errors or
spot check the output with expected output.
**Note**: This on-device profiling and inference requires access to Qualcomm®
AI Hub Workbench. [Sign up for access](https://myaccount.qualcomm.com/signup).
## Run demo on a cloud-hosted device
You can also run the demo on-device.
```bash
python -m qai_hub_models.models.convnext_base.demo --eval-mode on-device
```
**NOTE**: If you want running in a Jupyter Notebook or Google Colab like
environment, please add the following to your cell (instead of the above).
```
%run -m qai_hub_models.models.convnext_base.demo -- --eval-mode on-device
```
## Deploying compiled model to Android
The models can be deployed using multiple runtimes:
- TensorFlow Lite (`.tflite` export): [This
tutorial](https://www.tensorflow.org/lite/android/quickstart) provides a
guide to deploy the .tflite model in an Android application.
- QNN (`.so` export ): This [sample
app](https://docs.qualcomm.com/bundle/publicresource/topics/80-63442-50/sample_app.html)
provides instructions on how to use the `.so` shared library in an Android application.
## View on Qualcomm® AI Hub
Get more details on ConvNext-Base's performance across various devices [here](https://aihub.qualcomm.com/models/convnext_base).
Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/)
## License
* The license for the original implementation of ConvNext-Base can be found
[here](https://github.com/pytorch/vision/blob/main/LICENSE).
## References
* [A ConvNet for the 2020s](https://arxiv.org/abs/2201.03545)
* [Source Model Implementation](https://github.com/pytorch/vision/blob/main/torchvision/models/convnext.py)
## Community
* Join [our AI Hub Slack community](https://aihub.qualcomm.com/community/slack) to collaborate, post questions and learn more about on-device AI.
* For questions or feedback please [reach out to us](mailto:ai-hub-support@qti.qualcomm.com).