sinapsis-anomalib 0.1.5

Templates for anomaly detection with computer vision using anomalib library.

Sinapsis Anomalib

Module to provide anomaly detection training, inference and export with Anomalib.

🐍 Installation • 🚀 Features • 📚 Usage Example • 📙 Documentation • 🔍 License

🐍 Installation

Install using your package manager of choice. We encourage the use of uv

Example with uv:

  uv pip install sinapsis-anomalib --extra-index-url https://pypi.sinapsis.tech

or with raw pip:

  pip install sinapsis-anomalib --extra-index-url https://pypi.sinapsis.tech

[!IMPORTANT] Templates in each package may require extra dependencies. For development, we recommend installing the package with all the optional dependencies:

with uv:

  uv pip install sinapsis-anomalib[all] --extra-index-url https://pypi.sinapsis.tech

or with raw pip:

  pip install sinapsis-anomalib[all] --extra-index-url https://pypi.sinapsis.tech

🚀 Features

Templates Supported

The Sinapsis Anomalib provides a powerful and flexible implementation for anomaly detection with Anomalib library.

• AnomalibTorchInference
  Run anomaly detection inference using PyTorch models.
• AnomalibOpenVINOInference
  Perform optimized inference using OpenVINO-accelerated models.
• AnomalibTrain
  Train custom anomaly detection models with Anomalib.
• AnomalibExport
  Export trained models for deployment in different formats.

[!TIP] Use CLI command sinapsis info --all-template-names to show a list with all the available Template names installed with Sinapsis Anomalib.

[!TIP] Use CLI command sinapsis info --example-template-config TEMPLATE_NAME to produce an example Agent config for the Template specified in TEMPLATE_NAME.

For example, for CfaTrain use sinapsis info --example-template-config CfaTrain to produce the following example config:

agent:
  name: my_test_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}
- template_name: CfaTrain
  class_name: CfaTrain
  template_input: InputTemplate
  attributes:
    folder_attributes_config_path: null
    generic_key: 'my_generic_key'
    callbacks: null
    normalization: null
    threshold: null
    image_metrics: null
    pixel_metrics: null
    logger: null
    default_root_dir: null
    callback_configs: null
    logger_configs: null
    max_epochs: null
    ckpt_path: null
    cfa_init:
      backbone: wide_resnet50_2
      gamma_c: 1
      gamma_d: 1
      num_nearest_neighbors: 3
      num_hard_negative_features: 3
      radius: 1.0e-05

🚫 Excluded Models

Some models that required additional configuration have been excluded and support for this will be included in future releases.

• EfficientAd
• VlmAd
• Cfa
• Dfkde
• Fastflow
• Supersimplenet
• AiVad

For all other supported models, refer to the Anomalib documentation linked above.

📚 Usage Example

Below is an example configuration for **Sinapsis Anomalib** using a CFLOW model. This setup trains an anomaly detection model with configurable hyperparameters, including learning rate and epochs, and exports it in OpenVINO format for optimized inference. The pipeline includes training, model export, and predefined paths for outputs.

Example config

agent:
  name: anomalib_train_export

templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}

- template_name: CflowTrain
  class_name: CflowTrain
  attributes:
    folder_attributes_config_path: "configs/datamodule_config.yml"
    default_root_dir: "results/model"
    max_epochs: 1
    cflow_init:
      lr: 0.0001

- template_name: CflowExport
  class_name: CflowExport
  attributes:
    generic_key_chkpt: "CflowTrain"
    export_type: "openvino"
    export_root: "results/model/exported"

This configuration defines an agent and a sequence of templates to train and export a model based on a certain data configuration.

[!IMPORTANT] Attributes specified under the *_init keys (e.g., cflow_init) correspond directly to the Anomalib models parameters. Ensure that values are assigned correctly according to the official Anomalib documentation, as they affect the behavior and performance of the model.

To run the config, use the CLI:

sinapsis run name_of_config.yml

📙 Documentation

Documentation for this and other sinapsis packages is available on the sinapsis website

Tutorials for different projects within sinapsis are available at sinapsis tutorials page

🔍 License

This project is licensed under the AGPLv3 license, which encourages open collaboration and sharing. For more details, please refer to the LICENSE file.

For commercial use, please refer to our official Sinapsis website for information on obtaining a commercial license.