Docs /Templates/ sinapsis-anomalib

UflowTrain

sinapsis-anomalibAnomalibanomalibanomaly_detectiondynamicmodels

Python template · sinapsis_anomalib.templates.anomalib_train

Overview

Training implementation for Anomalib models.

Uflow — inherited documentation

Lightning implementation of the U-Flow model.

This class implements the U-Flow model for anomaly detection as described in Rudolph et al., 2022. The model consists of:

- A U-shaped normalizing flow architecture for density estimation - Multi-scale feature extraction using pre-trained backbones - Unsupervised threshold estimation based on the learned density - Anomaly detection by comparing likelihoods to the threshold

Args: backbone (str, optional): Name of the backbone feature extractor. Must be one of ``["mcait", "resnet18", "wide_resnet50_2"]``. Defaults to ``"mcait"``. flow_steps (int, optional): Number of normalizing flow steps. Defaults to ``4``. affine_clamp (float, optional): Clamping value for affine coupling layers. Defaults to ``2.0``. affine_subnet_channels_ratio (float, optional): Channel ratio for affine coupling subnet. Defaults to ``1.0``. permute_soft (bool, optional): Whether to use soft permutation. Defaults to ``False``. pre_processor (PreProcessor | bool, optional): Pre-processor for input data. If ``True``, uses default pre-processor. Defaults to ``True``. post_processor (PostProcessor | bool, optional): Post-processor for model outputs. If ``True``, uses default post-processor. Defaults to ``True``. evaluator (Evaluator | bool, optional): Evaluator for model performance. If ``True``, uses default evaluator. Defaults to ``True``. visualizer (Visualizer | bool, optional): Visualizer for model outputs. If ``True``, uses default visualizer. Defaults to ``True``.

Example: >>> from anomalib.models.image import Uflow >>> from anomalib.engine import Engine >>> from anomalib.data import MVTecAD >>> datamodule = MVTecAD() >>> model = Uflow(backbone="resnet18") >>> engine = Engine(model=model, datamodule=datamodule) >>> engine.fit() # doctest: +SKIP >>> predictions = engine.predict() # doctest: +SKIP

Raises: ValueError: If ``input_size`` is not provided during initialization.

See Also: - :class:`UflowModel`: PyTorch implementation of the model architecture - :class:`UFlowLoss`: Loss function for training - :class:`AnomalyMapGenerator`: Anomaly map generation from featuresInitialize U-Flow model.

Args: backbone (str, optional): Name of the backbone feature extractor. Must be one of ``["mcait", "resnet18", "wide_resnet50_2"]``. Defaults to ``"mcait"``. flow_steps (int, optional): Number of normalizing flow steps. Defaults to ``4``. affine_clamp (float, optional): Clamping value for affine coupling layers. Defaults to ``2.0``. affine_subnet_channels_ratio (float, optional): Channel ratio for affine coupling subnet. Defaults to ``1.0``. permute_soft (bool, optional): Whether to use soft permutation. Defaults to ``False``. pre_processor (PreProcessor | bool, optional): Pre-processor for input data. If ``True``, uses default pre-processor. Defaults to ``True``. post_processor (PostProcessor | bool, optional): Post-processor for model outputs. If ``True``, uses default post-processor. Defaults to ``True``. evaluator (Evaluator | bool, optional): Evaluator for model performance. If ``True``, uses default evaluator. Defaults to ``True``. visualizer (Visualizer | bool, optional): Visualizer for model outputs. If ``True``, uses default visualizer. Defaults to ``True``.

Raises: ValueError: If ``input_size`` is not provided during initialization.

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
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

Path to checkpoint for resuming training. If None, starts training from scratch.

str | pathlib._local.Path | 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
train_root
str | pathlib._local.Path | None
Optional
Default: null
uflow_initRequired
__init__Attributes
Required
Default: null
backbone
str
Optional
Default: "mcait"
evaluator
typing.Union[anomalib.metrics.evaluator.Evaluator, bool]
Optional
Default: true
flow_steps
int
Optional
Default: 4
visualizer
typing.Union[anomalib.visualization.base.Visualizer, bool]
Optional
Default: true
affine_clamp
float
Optional
Default: 2
permute_soft
bool
Optional
Default: false
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
affine_subnet_channels_ratio
float
Optional
Default: 1
trainer_args
(TrainerConfig): General trainer arguments. For more details see: https://lightning.ai/docs/pytorch/stable/common/trainer.html#trainer-flags uflow_init backbone <class 'str'>: default: mcait flow_steps <class 'int'>:… Read full field description

(TrainerConfig): General trainer arguments. For more details see: https://lightning.ai/docs/pytorch/stable/common/trainer.html#trainer-flags uflow_init backbone <class 'str'>: default: mcait flow_steps <class 'int'>: default: 4 affine_clamp <class 'float'>: default: 2.0 affine_subnet_channels_ratio <class 'float'>: default: 1.0 permute_soft <class 'bool'>: default: False 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

TrainerConfig
Optional
Default: null
devices

The devices to use for training (e.g., 1, [0, 1], "auto"). Defaults to "auto".

int | list[int] | str | None
Optional
Default: "auto"
max_epochs

The maximum number of epochs to train for. Defaults to 5.

int | None
Optional
Default: 5
min_epochs

The minimum number of epochs to train for. Defaults to 1.

int
Optional
Default: 1
accelerator

The hardware accelerator to use. Defaults to "auto".

typing.Literal['cpu', 'gpu', 'tpu', 'hpu', 'auto']
Optional
Default: "cpu"
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
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

Configuration example

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

yaml
templates:
  - template_name: "UflowTrain"
    class_name: "UflowTrain"
    attributes:
      logger: null
      callbacks: null
      ckpt_path: null
      threshold: null
      train_root: null
      uflow_init:
        backbone: "mcait"
        evaluator: true
        flow_steps: 4
        visualizer: true
        affine_clamp: 2
        permute_soft: false
        pre_processor: true
        post_processor: true
        affine_subnet_channels_ratio: 1
      trainer_args:
        devices: "auto"
        max_epochs: 5
        min_epochs: 1
        accelerator: "cpu"
      image_metrics: null
      normalization: null
      pixel_metrics: null
      logger_configs: null
      callback_configs: 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
View original docstring example

The source example references CfaTrain, not UflowTrain.

yaml
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: 'path/to/config.yaml'
        generic_key: 'my_generic_key'
        callbacks: null
        normalization: null
        threshold: null
        image_metrics: null
        pixel_metrics: null
        logger: null
        callback_configs: null
        logger_configs: null
        ckpt_path: null
        trainer_args:
            devices: "0"
            accelerator: gpu
            max_epochs: 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.

Inheritance

Immediate parent: sinapsis_anomalib.templates.anomalib_train.AnomalibTrain

Environment variables

Environment definitions belong to their canonical Python modules.

ANOMALIB_ROOT_DIR · defined elsewhereSINAPSIS_BUILD_DOCS · defined elsewhere