Docs /Templates/ sinapsis-anomalib

DraemExport

sinapsis-anomalibAnomalibanomalibanomaly_detectiondynamicmodels

Python template · sinapsis_anomalib.templates.anomalib_export

Overview

Export functionality for trained Anomalib models.

Draem — inherited documentation

DRÆM.

A discriminatively trained reconstruction embedding for surface anomaly detection.

The model consists of two main components: 1. A reconstruction network that learns to reconstruct normal images 2. A discriminative network that learns to identify anomalous regions

Args: dtd_dir (Path | str | None): Directory path for the DTD dataset for anomaly generation. Defaults to ``./datasets/dtd``. enable_sspcab (bool, optional): Enable SSPCAB training. Defaults to ``False``. sspcab_lambda (float, optional): Weight factor for SSPCAB loss. Defaults to ``0.1``. anomaly_source_path (str | None, optional): Path to directory containing anomaly source images. If ``None``, random noise is used. Defaults to ``None``. beta (float | tuple[float, float], optional): Blend factor for anomaly generation. If tuple, represents range for random sampling. Defaults to ``(0.1, 1.0)``. pre_processor (PreProcessor | bool, optional): Pre-processor instance or flag to use default. Defaults to ``True``. post_processor (PostProcessor | bool, optional): Post-processor instance or flag to use default. Defaults to ``True``. evaluator (Evaluator | bool, optional): Evaluator instance or flag to use default. Defaults to ``True``. visualizer (Visualizer | bool, optional): Visualizer instance or flag to use default. 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
draem_initRequired
__init__Attributes
Required
Default: null
beta
float
Optional
Default: [0.1,1]
dtd_dir
typing.Union[pathlib._local.Path, str, NoneType]
Optional
Default: "./datasets/dtd"
evaluator
typing.Union[anomalib.metrics.evaluator.Evaluator, bool]
Optional
Default: true
visualizer
typing.Union[anomalib.visualization.base.Visualizer, bool]
Optional
Default: true
enable_sspcab
bool
Optional
Default: false
pre_processor
typing.Union[anomalib.pre_processing.pre_processor.PreProcessor, bool]
Optional
Default: true
sspcab_lambda
float
Optional
Default: 0.1
post_processor
typing.Union[anomalib.post_processing.post_processor.PostProcessor, bool]
Optional
Default: true
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
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. draem_init dtd_dir typing.Union[pathlib._local.Path, str, NoneType]: default: ./datasets/dtd enable_sspcab <class 'bool'>: default: False sspcab_lambda <class 'float'>: default: 0.1… Read full field description

Key to retrieve training results. draem_init dtd_dir typing.Union[pathlib._local.Path, str, NoneType]: default: ./datasets/dtd enable_sspcab <class 'bool'>: default: False sspcab_lambda <class 'float'>: default: 0.1 beta <class 'float'>: default: (0.1, 1.0) 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: "DraemExport"
    class_name: "DraemExport"
    attributes:
      logger: null
      metric: null
      ov_args:
        verbose: false
        compress_to_fp16: null
      callbacks: null
      ckpt_path: null
      threshold: null
      draem_init:
        beta: [0.1, 1]
        dtd_dir: "./datasets/dtd"
        evaluator: true
        visualizer: true
        enable_sspcab: false
        pre_processor: true
        sspcab_lambda: 0.1
        post_processor: true
      input_size: null
      export_root: null
      export_type: {}
      image_metrics: null
      normalization: null
      pixel_metrics: null
      logger_configs: null
      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 DraemExport.

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