Guides

Using your own ONNX model

fastdup ships with a highly efficient and powerful embedding model, but we fully support user using their own models for running the analysis.

Suggest Edits

Running fastdup with a preconfigured model

fastdup supports multiple preconfigured models. To run them simply point model_path to the preconfigured model name. For example:

import fastdup

fd_clip = fastdup.create(work_dir='clip_work_dir', input_dir=input_dir)  
fd_clip.run(model_path='dinov2s')

The supported model paths are:

  • dinov2s : Meta's dinov2 model small
  • dinov2b: Meta's dinov2 model big
  • clip: OpenAi's ViT-B/32 clip model
  • clip336OpenAI's ViT-L-14@336px clip model
  • resent50 resnet50-v1-12.onnx model from GitHub onnx
  • efficientnet efficientnet-lite4-11 model from GitHub onnx
  • None : fastdup model

Each model create different feature vectors. For example Clip model is very semantic and can find that two different images are identical if they contain the same object. The following two images have zero cosine distance when using clip feature vectors (i.e they are fully identical), as they both contain bitcoin. However they are very different thus fastdup gives them a similarity of 0.63 out of 1.0.

Running fastdup analysis with a general ONNX model

Using a model with fastdup done using the model_path and the dimension (d) argument in the .run() method. In this example we use CLIP-ViT-B-32, that has an output dimension of 512. We list below a few sources for ONNX models, as well as tutorials for converting PyTorch and Tensorflow models as they are different in appearance.

import fastdup

!wget https://clip-as-service.s3.us-east-2.amazonaws.com/models/onnx/ViT-B-32/visual.onnx -O clip.onnx

fd_clip = fastdup.create(work_dir='clip_work_dir', input_dir=input_dir)
fd_clip.run(model_path='clip.onnx', d=512)

In this example we downloaded the ONNX model for CLIP, a common deep learning model published by OpenAI in 2021, widely used for its transfer learning abilities and its abilities to generalize across different domains.

About ONNX Format:

The ONNX (Open Neural Network Exchange) model format is an open-source format for representing machine learning models. It provides a standardized way to represent deep learning models, making them portable across different deep learning frameworks. ONNX models are used in the ONNX Runtime, an open-source engine designed to execute machine learning models in the ONNX format with high performance and efficiency.

Most deep learning frameworks support model exports to ONNX format, which serialize a model to the shared format used by inference frameworks, and by the fastdup feature extraction component.

Sources for ONNX models

Exporting your own models to ONNX

Follow the tutorials for each individual library:

Caveats of using ONNX models

  • Speed: The model bundled in fastdup is heavily optimized for CPU inference performance. Many public models are meant to be used with GPUs, making CPU inference very slow. This could dramatically increase the runtime of a fastdup analysis.
  • Accuracy and clustering performance: A fantastic classification model does not necessarily make for a useful clustering and similarity model.
  • Stability: ONNX models come in many shapes and forms, and are exported in various methods. We have tested fastdup with many common ONNX models, but cannot guarantee the stability and robust operation for every ONNX model.

Updated about 1 year ago

What’s Next