PatchflowTrain
Python template · sinapsis_anomalib.templates.anomalib_train
Overview
Training implementation for 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 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
Optional
Default: null
Optional
Default: null
Path to checkpoint for resuming training. If None, starts training from scratch.
Optional
Default: null
Optional
Default: null
Optional
Default: null
(TrainerConfig): General trainer arguments. For more details see: https://lightning.ai/docs/pytorch/stable/common/trainer.html#trainer-flags patchflow_init backbone <class 'str'>: default: tf_efficientnet_b5… Read full field description
(TrainerConfig): General trainer arguments. For more details see: https://lightning.ai/docs/pytorch/stable/common/trainer.html#trainer-flags 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
Optional
Default: null
The devices to use for training (e.g., 1, [0, 1], "auto"). Defaults to "auto".
Optional
Default: "auto"
The maximum number of epochs to train for. Defaults to 5.
Optional
Default: 5
The minimum number of epochs to train for. Defaults to 1.
Optional
Default: 1
The hardware accelerator to use. Defaults to "auto".
Optional
Default: "cpu"
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Required
Default: null
Optional
Default: 0.001
Optional
Default: "tf_efficientnet_b5"
Optional
Default: null
Optional
Default: true
Optional
Default: 1
Optional
Default: 3
Optional
Default: 3
Optional
Default: true
Optional
Default: true
Optional
Default: 0.0001
Optional
Default: true
Optional
Default: true
Optional
Default: 128
Optional
Default: 128
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
Configuration example
Generated from documented defaults. Replace any placeholders and complete required nested settings before running.
templates:
- template_name: "PatchflowTrain"
class_name: "PatchflowTrain"
attributes:
logger: null
callbacks: null
ckpt_path: null
threshold: null
train_root: null
trainer_args:
devices: "auto"
max_epochs: 5
min_epochs: 1
accelerator: "cpu"
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
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 PatchflowTrain.
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
sinapsis_anomalib.templates.anomalib_train.AnomalibTrainEnvironment variables
Environment definitions belong to their canonical Python modules.