CsflowTrain
Python template · sinapsis_anomalib.templates.anomalib_train
Overview
Training implementation for Anomalib models.
Csflow — inherited documentation
CS-Flow Lightning Model for anomaly detection.
CS-Flow uses normalizing flows across multiple scales to model the distribution of normal images. During inference, it assigns anomaly scores based on the likelihood of test samples under the learned distribution.
Args: n_coupling_blocks (int, optional): Number of coupling blocks in the model. Defaults to ``4``. cross_conv_hidden_channels (int, optional): Number of hidden channels in the cross convolution layer. Defaults to ``1024``. clamp (int, optional): Clamping value for the affine coupling layers in the Glow model. Defaults to ``3``. num_channels (int, optional): Number of input image channels. Defaults to ``3`` for RGB images. pre_processor (PreProcessor | bool, optional): Preprocessing module or flag to enable default preprocessing. Defaults to ``True``. post_processor (PostProcessor | bool, optional): Post-processing module or flag to enable default post-processing. Defaults to ``True``. evaluator (Evaluator | bool, optional): Evaluation module or flag to enable default evaluation. Defaults to ``True``. visualizer (Visualizer | bool, optional): Visualization module or flag to enable default visualization. Defaults to ``True``.
Raises: ValueError: If ``input_size`` is not provided during initialization.
Example: >>> from anomalib.models.image.csflow import Csflow >>> model = Csflow( ... n_coupling_blocks=4, ... cross_conv_hidden_channels=1024, ... clamp=3, ... num_channels=3 ... )
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
Required
Default: null
Optional
Default: 3
Optional
Default: true
Optional
Default: true
Optional
Default: 3
Optional
Default: true
Optional
Default: true
Optional
Default: 4
Optional
Default: 1024
(TrainerConfig): General trainer arguments. For more details see: https://lightning.ai/docs/pytorch/stable/common/trainer.html#trainer-flags csflow_init cross_conv_hidden_channels <class 'int'>: default: 1024… Read full field description
(TrainerConfig): General trainer arguments. For more details see: https://lightning.ai/docs/pytorch/stable/common/trainer.html#trainer-flags csflow_init cross_conv_hidden_channels <class 'int'>: default: 1024 n_coupling_blocks <class 'int'>: default: 4 clamp <class 'int'>: default: 3 num_channels <class 'int'>: default: 3 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: "CsflowTrain"
class_name: "CsflowTrain"
attributes:
logger: null
callbacks: null
ckpt_path: null
threshold: null
train_root: null
csflow_init:
clamp: 3
evaluator: true
visualizer: true
num_channels: 3
pre_processor: true
post_processor: true
n_coupling_blocks: 4
cross_conv_hidden_channels: 1024
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 CsflowTrain.
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.