FreTrain
Python template · sinapsis_anomalib.templates.anomalib_train
Overview
Training implementation for Anomalib models.
Fre — inherited documentation
FRE: Feature-reconstruction error using Tied AutoEncoder.
The FRE model extracts features from a pre-trained CNN backbone and learns to reconstruct them using a tied autoencoder. Anomalies are detected by measuring the reconstruction error between original and reconstructed features.
Args: backbone (str): Backbone CNN network architecture. Defaults to ``"resnet50"``. layer (str): Layer name to extract features from the backbone CNN. Defaults to ``"layer3"``. pre_trained (bool, optional): Whether to use pre-trained backbone weights. Defaults to ``True``. pooling_kernel_size (int, optional): Kernel size for pooling features extracted from the CNN. Defaults to ``2``. input_dim (int, optional): Dimension of features at output of specified layer. Defaults to ``65536``. latent_dim (int, optional): Reduced feature dimension after applying dimensionality reduction via shallow linear autoencoder. Defaults to ``220``. pre_processor (PreProcessor | bool, optional): Pre-processor to transform inputs before passing to model. Defaults to ``True``. post_processor (PostProcessor | bool, optional): Post-processor to generate predictions from model outputs. Defaults to ``True``. evaluator (Evaluator | bool, optional): Evaluator to compute metrics. Defaults to ``True``. visualizer (Visualizer | bool, optional): Visualizer to display results. Defaults to ``True``.
Example: >>> from anomalib.models import Fre >>> model = Fre( ... backbone="resnet50", ... layer="layer3", ... pre_trained=True, ... pooling_kernel_size=2, ... input_dim=65536, ... latent_dim=220, ... )
See Also: :class:`anomalib.models.image.fre.torch_model.FREModel`: PyTorch implementation of the FRE model architecture.
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
Required
Default: null
Optional
Default: "layer3"
Optional
Default: "resnet50"
Optional
Default: true
Optional
Default: 65536
Optional
Default: 220
Optional
Default: true
Optional
Default: true
Optional
Default: true
Optional
Default: true
Optional
Default: 2
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 fre_init backbone <class 'str'>: default: resnet50 layer <class 'str'>:… Read full field description
(TrainerConfig): General trainer arguments. For more details see: https://lightning.ai/docs/pytorch/stable/common/trainer.html#trainer-flags fre_init backbone <class 'str'>: default: resnet50 layer <class 'str'>: default: layer3 pre_trained <class 'bool'>: default: True pooling_kernel_size <class 'int'>: default: 2 input_dim <class 'int'>: default: 65536 latent_dim <class 'int'>: default: 220 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: "FreTrain"
class_name: "FreTrain"
attributes:
logger: null
fre_init:
layer: "layer3"
backbone: "resnet50"
evaluator: true
input_dim: 65536
latent_dim: 220
visualizer: true
pre_trained: true
pre_processor: true
post_processor: true
pooling_kernel_size: 2
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
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 FreTrain.
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.