DraemTrain
Python template · sinapsis_anomalib.templates.anomalib_train
Overview
Training implementation for Anomalib models.
Draem — inherited documentation
DRÆM.
A discriminatively trained reconstruction embedding for surface anomaly detection.
The model consists of two main components: 1. A reconstruction network that learns to reconstruct normal images 2. A discriminative network that learns to identify anomalous regions
Args: dtd_dir (Path | str | None): Directory path for the DTD dataset for anomaly generation. Defaults to ``./datasets/dtd``. enable_sspcab (bool, optional): Enable SSPCAB training. Defaults to ``False``. sspcab_lambda (float, optional): Weight factor for SSPCAB loss. Defaults to ``0.1``. anomaly_source_path (str | None, optional): Path to directory containing anomaly source images. If ``None``, random noise is used. Defaults to ``None``. beta (float | tuple[float, float], optional): Blend factor for anomaly generation. If tuple, represents range for random sampling. Defaults to ``(0.1, 1.0)``. pre_processor (PreProcessor | bool, optional): Pre-processor instance or flag to use default. Defaults to ``True``. post_processor (PostProcessor | bool, optional): Post-processor instance or flag to use default. Defaults to ``True``. evaluator (Evaluator | bool, optional): Evaluator instance or flag to use default. Defaults to ``True``. visualizer (Visualizer | bool, optional): Visualizer instance or flag to use default. 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.1,1]
Optional
Default: "./datasets/dtd"
Optional
Default: true
Optional
Default: true
Optional
Default: false
Optional
Default: true
Optional
Default: 0.1
Optional
Default: true
Optional
Default: null
(TrainerConfig): General trainer arguments. For more details see: https://lightning.ai/docs/pytorch/stable/common/trainer.html#trainer-flags draem_init dtd_dir typing.Union[pathlib._local.Path, str, NoneType]: default:… Read full field description
(TrainerConfig): General trainer arguments. For more details see: https://lightning.ai/docs/pytorch/stable/common/trainer.html#trainer-flags draem_init dtd_dir typing.Union[pathlib._local.Path, str, NoneType]: default: ./datasets/dtd enable_sspcab <class 'bool'>: default: False sspcab_lambda <class 'float'>: default: 0.1 beta <class 'float'>: default: (0.1, 1.0) 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: "DraemTrain"
class_name: "DraemTrain"
attributes:
logger: null
callbacks: null
ckpt_path: null
threshold: null
draem_init:
beta: [0.1, 1]
dtd_dir: "./datasets/dtd"
evaluator: true
visualizer: true
enable_sspcab: false
pre_processor: true
sspcab_lambda: 0.1
post_processor: true
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 DraemTrain.
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.