UflowExport
Python template · sinapsis_anomalib.templates.anomalib_export
Overview
Export functionality for trained 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 setInstallation
Install the published package using pip or uv.
pip install sinapsis-anomalib==1.0.0uv pip install sinapsis-anomalib==1.0.0uv add sinapsis-anomalib==1.0.0Configuration
Effective fields from the inspector schema, including nested Pydantic model fields.
Optional
Default: null
Metric used for compression calibration.
Optional
Default: null
OpenVINO-specific export arguments.
Optional
Default: null
Optional
Default: false
If True, compresses the model weights to FP16 precision. Defaults to None. Print detailed information about conversion.
Optional
Default: null
Optional
Default: null
Optional
Default: null
Explicit path to model checkpoint.
Optional
Default: null
Optional
Default: null
Expected input dimensions (height, width).
Optional
Default: null
Required
Default: null
Optional
Default: "mcait"
Optional
Default: true
Optional
Default: 4
Optional
Default: true
Optional
Default: 2
Optional
Default: false
Optional
Default: true
Optional
Default: true
Optional
Default: 1
Root directory for exported files.
Optional
Default: null
Target export format. Defaults to TORCH.
Optional
Default: "torch"
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Quantization/compression method.
Optional
Default: null
Optional
Default: null
A descriptive name for the dataset.
Required
Default: null
The root directory where the dataset is located.
Optional
Default: null
A random seed for reproducibility in data splitting.
Optional
Default: null
Optional
Default: null
Optional
Default: null
Path to the directory containing normal images.
Required
Default: null
The number of subprocesses to use for data loading. Defaults to 8.
Optional
Default: 8
Path to the directory for abnormal images.
Optional
Default: null
Optional
Default: "from_test"
The number of samples per batch for evaluation. Defaults to 32.
Optional
Default: 32
Optional
Default: null
Optional
Default: "from_dir"
Optional
Default: 0.5
Optional
Default: 0.2
The number of samples per batch for training. Defaults to 32.
Optional
Default: 32
Optional
Default: 0.2
Key to retrieve training results. 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:… Read full field description
Key to retrieve training results. 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
Optional
Default: null
Configuration example
Generated from documented defaults. Replace any placeholders and complete required nested settings before running.
templates:
- template_name: "UflowExport"
class_name: "UflowExport"
attributes:
logger: null
metric: null
ov_args:
verbose: false
compress_to_fp16: null
callbacks: null
ckpt_path: null
threshold: null
input_size: 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
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 UflowExport.
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
sinapsis_anomalib.templates.anomalib_export.AnomalibExportEnvironment variables
Environment definitions belong to their canonical Python modules.