Docs /Templates/ sinapsis-anomalib

PatchflowExport

sinapsis-anomalibAnomalibanomalibanomaly_detectiondynamicmodels

Python template · sinapsis_anomalib.templates.anomalib_export

Overview

Export functionality for trained Anomalib models.

Patchflow — inherited documentation

Lightning Module for the PatchFlow algorithm.

Args: backbone: Backbone network. A timm model name or a DINOv2 model name. Defaults to ``"tf_efficientnet_b5"``. pre_trained: Whether to use pre-trained backbone weights. Defaults to ``True``. flow_steps: Number of coupling blocks in the normalizing flow. Defaults to ``1``. flow_feature_dim: Channel dimension after the feature adaptor. Defaults to ``128``. num_scales: Number of input resolutions for multi-scale extraction. Defaults to ``3``. patch_size: Kernel size of the AvgPool for local aggregation. Defaults to ``3``. flow_hidden_dim: Hidden channels in the flow subnet. Defaults to ``128``. crop_size: Optional center crop size ``(H, W)``. When set, the input is center-cropped before feature extraction and the anomaly map is padded with value ``-1`` back to the original input size. Defaults to ``None``. lr: Learning rate for the Adam optimizer. Defaults to ``0.001``. weight_decay: Weight decay (L2 penalty) for the Adam optimizer. Defaults to ``0.0001``. pre_processor: Pre-processor instance or boolean. Defaults to ``True``. post_processor: Post-processor instance or boolean. Defaults to ``True``. evaluator: Evaluator instance or boolean. Defaults to ``True``. visualizer: Visualizer instance or boolean. Defaults to ``True``.

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-anomalib==1.0.0
uv pip install sinapsis-anomalib==1.0.0
uv add sinapsis-anomalib==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

logger
lightning.pytorch.loggers.logger.Logger | collections.abc.Iterable[lightning.pytorch.loggers.logger.Logger] | bool | None
Optional
Default: null
metric

Metric used for compression calibration.

torchmetrics.metric.Metric | str | None
Optional
Default: null
ov_args

OpenVINO-specific export arguments.

sinapsis_anomalib.helpers.configs.OpenVINOArgs | None
Optional
Default: null
verbose
bool
Optional
Default: false
compress_to_fp16

If True, compresses the model weights to FP16 precision. Defaults to None. Print detailed information about conversion.

bool | None
Optional
Default: null
metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
callbacks
list[lightning.pytorch.callbacks.callback.Callback] | None
Optional
Default: null
ckpt_path

Explicit path to model checkpoint.

str | None
Optional
Default: null
threshold
anomalib.metrics.threshold.base.Threshold | tuple[anomalib.metrics.threshold.base.Threshold, anomalib.metrics.threshold.base.Threshold] | omegaconf.dictconfig.DictConfig | omegaconf.listconfig.ListConfig | list[dict[str, str | float]] | str | None
Optional
Default: null
input_size

Expected input dimensions (height, width).

tuple[int, int] | None
Optional
Default: null
export_root

Root directory for exported files.

str | pathlib._local.Path | None
Optional
Default: null
export_type

Target export format. Defaults to TORCH.

ExportType
Optional
Default: "torch"
image_metrics
list[str] | str | dict[str, dict[str, typing.Any]] | None
Optional
Default: null
normalization
anomalib.utils.normalization.NormalizationMethod | omegaconf.dictconfig.DictConfig | lightning.pytorch.callbacks.callback.Callback | str | None
Optional
Default: null
pixel_metrics
list[str] | str | dict[str, dict[str, typing.Any]] | None
Optional
Default: null
logger_configs
dict[str, dict[str, typing.Any]] | None
Optional
Default: null
patchflow_initRequired
__init__Attributes
Required
Default: null
lr
float
Optional
Default: 0.001
backbone
str
Optional
Default: "tf_efficientnet_b5"
crop_size
NoneType
Optional
Default: null
evaluator
typing.Union[anomalib.metrics.evaluator.Evaluator, bool]
Optional
Default: true
flow_steps
int
Optional
Default: 1
num_scales
int
Optional
Default: 3
patch_size
int
Optional
Default: 3
visualizer
typing.Union[anomalib.visualization.base.Visualizer, bool]
Optional
Default: true
pre_trained
bool
Optional
Default: true
weight_decay
float
Optional
Default: 0.0001
pre_processor
typing.Union[anomalib.pre_processing.pre_processor.PreProcessor, bool]
Optional
Default: true
post_processor
typing.Union[anomalib.post_processing.post_processor.PostProcessor, bool]
Optional
Default: true
flow_hidden_dim
int
Optional
Default: 128
flow_feature_dim
int
Optional
Default: 128
callback_configs
dict[str, dict[str, typing.Any]] | None
Optional
Default: null
compression_type

Quantization/compression method.

anomalib.deploy.export.CompressionType | None
Optional
Default: null
folder_attributes
sinapsis_anomalib.helpers.configs.FolderConfig | None
Optional
Default: null
nameRequired

A descriptive name for the dataset.

str
Required
Default: null
root

The root directory where the dataset is located.

str | pathlib._local.Path | None
Optional
Default: null
seed

A random seed for reproducibility in data splitting.

int | None
Optional
Default: null
mask_dir
str | pathlib._local.Path | collections.abc.Sequence[str | pathlib._local.Path] | None
Optional
Default: null
extensions
list[str] | None
Optional
Default: null
normal_dirRequired

Path to the directory containing normal images.

str | pathlib._local.Path | collections.abc.Sequence[str | pathlib._local.Path]
Required
Default: null
num_workers

The number of subprocesses to use for data loading. Defaults to 8.

int
Optional
Default: 8
abnormal_dir

Path to the directory for abnormal images.

str | pathlib._local.Path | collections.abc.Sequence[str | pathlib._local.Path] | None
Optional
Default: null
val_split_mode
anomalib.data.utils.split.ValSplitMode | str
Optional
Default: "from_test"
eval_batch_size

The number of samples per batch for evaluation. Defaults to 32.

int
Optional
Default: 32
normal_test_dir
str | pathlib._local.Path | collections.abc.Sequence[str | pathlib._local.Path] | None
Optional
Default: null
test_split_mode
anomalib.data.utils.split.TestSplitMode | str
Optional
Default: "from_dir"
val_split_ratio
float
Optional
Default: 0.5
test_split_ratio
float
Optional
Default: 0.2
train_batch_size

The number of samples per batch for training. Defaults to 32.

int
Optional
Default: 32
normal_split_ratio
float
Optional
Default: 0.2
generic_key_chkpt
Key to retrieve training results. patchflow_init backbone <class 'str'>: default: tf_efficientnet_b5 pre_trained <class 'bool'>: default: True flow_steps <class 'int'>: default: 1 flow_feature_dim <class 'int'>:… Read full field description

Key to retrieve training results. patchflow_init backbone <class 'str'>: default: tf_efficientnet_b5 pre_trained <class 'bool'>: default: True flow_steps <class 'int'>: default: 1 flow_feature_dim <class 'int'>: default: 128 num_scales <class 'int'>: default: 3 patch_size <class 'int'>: default: 3 flow_hidden_dim <class 'int'>: default: 128 crop_size <class 'NoneType'>: default: None lr <class 'float'>: default: 0.001 weight_decay <class 'float'>: default: 0.0001 pre_processor typing.Union[anomalib.pre_processing.pre_processor.PreProcessor, bool]: default: True post_processor typing.Union[anomalib.post_processing.post_processor.PostProcessor, bool]: default: True evaluator typing.Union[anomalib.metrics.evaluator.Evaluator, bool]: default: True visualizer typing.Union[anomalib.visualization.base.Visualizer, bool]: default: True

str | None
Optional
Default: null

Configuration example

Generated from documented defaults. Replace any placeholders and complete required nested settings before running.

yaml
templates:
  - template_name: "PatchflowExport"
    class_name: "PatchflowExport"
    attributes:
      logger: null
      metric: null
      ov_args:
        verbose: false
        compress_to_fp16: null
      callbacks: null
      ckpt_path: null
      threshold: null
      input_size: null
      export_root: null
      export_type: {}
      image_metrics: null
      normalization: null
      pixel_metrics: null
      logger_configs: null
      patchflow_init:
        lr: 0.001
        backbone: "tf_efficientnet_b5"
        crop_size: null
        evaluator: true
        flow_steps: 1
        num_scales: 3
        patch_size: 3
        visualizer: true
        pre_trained: true
        weight_decay: 0.0001
        pre_processor: true
        post_processor: true
        flow_hidden_dim: 128
        flow_feature_dim: 128
      callback_configs: null
      compression_type: null
      folder_attributes:
        name: "<required>"
        root: null
        seed: null
        mask_dir: null
        extensions: null
        normal_dir: "<required>"
        num_workers: 8
        abnormal_dir: null
        val_split_mode: "from_test"
        eval_batch_size: 32
        normal_test_dir: null
        test_split_mode: "from_dir"
        val_split_ratio: 0.5
        test_split_ratio: 0.2
        train_batch_size: 32
        normal_split_ratio: 0.2
      generic_key_chkpt: null
View original docstring example

The source example references CfaExport, not PatchflowExport.

yaml
agent:
    name: my_test_agent
    templates:
    - template_name: InputTemplate
    class_name: InputTemplate
    attributes: {}
    - template_name: CfaExport
    class_name: CfaExport
    template_input: InputTemplate
    attributes:
        folder_attributes_config_path: null
        generic_key: 'my_generic_key'
        callbacks: null
        normalization: null
        threshold: null
        task: null
        image_metrics: null
        pixel_metrics: null
        logger: null
        callback_configs: null
        logger_configs: null
        export_type: 'openvino'
        export_root: null
        input_size: null
        transform: null
        compression_type: null
        metric: null
        ov_args: null
        ckpt_path: null
        generic_key_chkpt: 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

For a full list of options use the sinapsis cli: sinapsis info --all-template-names
If you want to see all available models, please visit:
https://anomalib.readthedocs.io/en/v1.2.0/markdown/guides/reference/models/image/index.html

Notes:
    - Supports multiple export formats via ExportType
    - Enables model compression through CompressionType.
    - Can load models from checkpoints or previous training results.

Inheritance

Immediate parent: sinapsis_anomalib.templates.anomalib_export.AnomalibExport

Environment variables

Environment definitions belong to their canonical Python modules.

ANOMALIB_ROOT_DIR · defined elsewhereSINAPSIS_BUILD_DOCS · defined elsewhere