CflowTrain
Python template · sinapsis_anomalib.templates.anomalib_train
Overview
Training implementation for Anomalib models.
Cflow — inherited documentation
PyTorch Lightning implementation of the CFLOW model.
The model uses a pre-trained CNN backbone to extract features, followed by conditional normalizing flow decoders to model the distribution of normal data.
Args: backbone (str, optional): Name of the backbone CNN network. Defaults to ``"wide_resnet50_2"``. layers (Sequence[str], optional): List of layer names to extract features from. Defaults to ``("layer2", "layer3", "layer4")``. pre_trained (bool, optional): If True, use pre-trained weights for the backbone. Defaults to ``True``. fiber_batch_size (int, optional): Batch size for processing individual fibers. Defaults to ``64``. decoder (str, optional): Type of normalizing flow decoder to use. Defaults to ``"freia-cflow"``. condition_vector (int, optional): Dimension of the condition vector. Defaults to ``128``. coupling_blocks (int, optional): Number of coupling blocks in the flow. Defaults to ``8``. clamp_alpha (float, optional): Clamping value for the alpha parameter in flows. Defaults to ``1.9``. permute_soft (bool, optional): If True, use soft permutation in flows. Defaults to ``False``. lr (float, optional): Learning rate for the optimizer. Defaults to ``0.0001``. pre_processor (PreProcessor | bool, optional): Pre-processing module. Defaults to ``True``. post_processor (PostProcessor | bool, optional): Post-processing module. Defaults to ``True``. evaluator (Evaluator | bool, optional): Evaluation module. Defaults to ``True``. visualizer (Visualizer | bool, optional): Visualization module. 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
Required
Default: null
Optional
Default: 0.0001
Optional
Default: ["layer2","layer3","layer4"]
Optional
Default: "freia-cflow"
Optional
Default: "wide_resnet50_2"
Optional
Default: true
Optional
Default: true
Optional
Default: 1.9
Optional
Default: true
Optional
Default: false
Optional
Default: true
Optional
Default: true
Optional
Default: 8
Optional
Default: 128
Optional
Default: 64
Optional
Default: null
(TrainerConfig): General trainer arguments. For more details see: https://lightning.ai/docs/pytorch/stable/common/trainer.html#trainer-flags cflow_init backbone <class 'str'>: default: wide_resnet50_2 layers… Read full field description
(TrainerConfig): General trainer arguments. For more details see: https://lightning.ai/docs/pytorch/stable/common/trainer.html#trainer-flags cflow_init backbone <class 'str'>: default: wide_resnet50_2 layers collections.abc.Sequence[str]: default: ('layer2', 'layer3', 'layer4') pre_trained <class 'bool'>: default: True fiber_batch_size <class 'int'>: default: 64 decoder <class 'str'>: default: freia-cflow condition_vector <class 'int'>: default: 128 coupling_blocks <class 'int'>: default: 8 clamp_alpha <class 'float'>: default: 1.9 permute_soft <class 'bool'>: default: False lr <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
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: "CflowTrain"
class_name: "CflowTrain"
attributes:
logger: null
callbacks: null
ckpt_path: null
threshold: null
cflow_init:
lr: 0.0001
layers: ["layer2", "layer3", "layer4"]
decoder: "freia-cflow"
backbone: "wide_resnet50_2"
evaluator: true
visualizer: true
clamp_alpha: 1.9
pre_trained: true
permute_soft: false
pre_processor: true
post_processor: true
coupling_blocks: 8
condition_vector: 128
fiber_batch_size: 64
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
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 CflowTrain.
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.