Docs /Templates/ sinapsis-anomalib

MHPatchcoreTrain

sinapsis-anomalibAnomalibanomalibanomaly_detectiondynamicmodels

Python template · sinapsis_anomalib.templates.anomalib_train

Overview

Training implementation for Anomalib models.

MHPatchcore — inherited documentation

MH-PatchCore Lightning module for anomaly detection.

MH-PatchCore fits its statistical state in three ordered passes over the training data: PCA, covariance whitening, and memory-bank construction.

Args: backbone (str): Name of the timm backbone. Defaults to ``"wide_resnet50_2.tv2_in1k"``. layers (Sequence[str]): Ordered backbone layers used for feature extraction. Defaults to ``("layer2", "layer3")``. pre_trained (bool): Whether to load pretrained backbone weights. Defaults to ``True``. pca_variance_ratio (float): Fraction of explained variance retained by incremental PCA. Defaults to ``0.99``. covariance_shrinkage (float): Fixed covariance shrinkage coefficient. Defaults to ``0.07``. memory_bank_size (int): Maximum number of vectors in the finalized memory bank. Defaults to ``1000``. local_coreset_size (int): Maximum number of vectors retained in each merge-reduce block. Defaults to ``256``. num_neighbors (int): Number of memory-bank neighbors used for image score reweighting. Defaults to ``9``. pre_processor (PreProcessor | bool): Preprocessor instance or flag to use the default. Defaults to ``True``. post_processor (PostProcessor | bool): Postprocessor instance or flag to use the default. Defaults to ``True``. evaluator (Evaluator | bool): Evaluator instance or flag to use the default. Defaults to ``True``. visualizer (Visualizer | bool): Visualizer instance or flag to use the default. Defaults to ``True``.

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-anomalib==1.0.0
uv pip install sinapsis-anomalib==1.0.0
uv add sinapsis-anomalib==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

logger
lightning.pytorch.loggers.logger.Logger | collections.abc.Iterable[lightning.pytorch.loggers.logger.Logger] | bool | None
Optional
Default: null
metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
callbacks
list[lightning.pytorch.callbacks.callback.Callback] | None
Optional
Default: null
ckpt_path

Path to checkpoint for resuming training. If None, starts training from scratch.

str | pathlib._local.Path | None
Optional
Default: null
threshold
anomalib.metrics.threshold.base.Threshold | tuple[anomalib.metrics.threshold.base.Threshold, anomalib.metrics.threshold.base.Threshold] | omegaconf.dictconfig.DictConfig | omegaconf.listconfig.ListConfig | list[dict[str, str | float]] | str | None
Optional
Default: null
train_root
str | pathlib._local.Path | None
Optional
Default: null
trainer_args
(TrainerConfig): General trainer arguments. For more details see: https://lightning.ai/docs/pytorch/stable/common/trainer.html#trainer-flags mhpatchcore_init backbone <class 'str'>: default: wide_resnet50_2.tv2_in1k… Read full field description

(TrainerConfig): General trainer arguments. For more details see: https://lightning.ai/docs/pytorch/stable/common/trainer.html#trainer-flags mhpatchcore_init backbone <class 'str'>: default: wide_resnet50_2.tv2_in1k layers collections.abc.Sequence[str]: default: ('layer2', 'layer3') pre_trained <class 'bool'>: default: True pca_variance_ratio <class 'float'>: default: 0.99 covariance_shrinkage <class 'float'>: default: 0.07 memory_bank_size <class 'int'>: default: 1000 local_coreset_size <class 'int'>: default: 256 num_neighbors <class 'int'>: default: 9 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

TrainerConfig
Optional
Default: null
devices

The devices to use for training (e.g., 1, [0, 1], "auto"). Defaults to "auto".

int | list[int] | str | None
Optional
Default: "auto"
max_epochs

The maximum number of epochs to train for. Defaults to 5.

int | None
Optional
Default: 5
min_epochs

The minimum number of epochs to train for. Defaults to 1.

int
Optional
Default: 1
accelerator

The hardware accelerator to use. Defaults to "auto".

typing.Literal['cpu', 'gpu', 'tpu', 'hpu', 'auto']
Optional
Default: "cpu"
image_metrics
list[str] | str | dict[str, dict[str, typing.Any]] | None
Optional
Default: null
normalization
anomalib.utils.normalization.NormalizationMethod | omegaconf.dictconfig.DictConfig | lightning.pytorch.callbacks.callback.Callback | str | None
Optional
Default: null
pixel_metrics
list[str] | str | dict[str, dict[str, typing.Any]] | None
Optional
Default: null
logger_configs
dict[str, dict[str, typing.Any]] | None
Optional
Default: null
callback_configs
dict[str, dict[str, typing.Any]] | None
Optional
Default: null
mhpatchcore_initRequired
__init__Attributes
Required
Default: null
layers
collections.abc.Sequence[str]
Optional
Default: ["layer2","layer3"]
backbone
str
Optional
Default: "wide_resnet50_2.tv2_in1k"
evaluator
typing.Union[anomalib.metrics.evaluator.Evaluator, bool]
Optional
Default: true
visualizer
typing.Union[anomalib.visualization.base.Visualizer, bool]
Optional
Default: true
pre_trained
bool
Optional
Default: true
num_neighbors
int
Optional
Default: 9
pre_processor
typing.Union[anomalib.pre_processing.pre_processor.PreProcessor, bool]
Optional
Default: true
post_processor
typing.Union[anomalib.post_processing.post_processor.PostProcessor, bool]
Optional
Default: true
memory_bank_size
int
Optional
Default: 1000
local_coreset_size
int
Optional
Default: 256
pca_variance_ratio
float
Optional
Default: 0.99
covariance_shrinkage
float
Optional
Default: 0.07
folder_attributes
sinapsis_anomalib.helpers.configs.FolderConfig | None
Optional
Default: null
nameRequired

A descriptive name for the dataset.

str
Required
Default: null
root

The root directory where the dataset is located.

str | pathlib._local.Path | None
Optional
Default: null
seed

A random seed for reproducibility in data splitting.

int | None
Optional
Default: null
mask_dir
str | pathlib._local.Path | collections.abc.Sequence[str | pathlib._local.Path] | None
Optional
Default: null
extensions
list[str] | None
Optional
Default: null
normal_dirRequired

Path to the directory containing normal images.

str | pathlib._local.Path | collections.abc.Sequence[str | pathlib._local.Path]
Required
Default: null
num_workers

The number of subprocesses to use for data loading. Defaults to 8.

int
Optional
Default: 8
abnormal_dir

Path to the directory for abnormal images.

str | pathlib._local.Path | collections.abc.Sequence[str | pathlib._local.Path] | None
Optional
Default: null
val_split_mode
anomalib.data.utils.split.ValSplitMode | str
Optional
Default: "from_test"
eval_batch_size

The number of samples per batch for evaluation. Defaults to 32.

int
Optional
Default: 32
normal_test_dir
str | pathlib._local.Path | collections.abc.Sequence[str | pathlib._local.Path] | None
Optional
Default: null
test_split_mode
anomalib.data.utils.split.TestSplitMode | str
Optional
Default: "from_dir"
val_split_ratio
float
Optional
Default: 0.5
test_split_ratio
float
Optional
Default: 0.2
train_batch_size

The number of samples per batch for training. Defaults to 32.

int
Optional
Default: 32
normal_split_ratio
float
Optional
Default: 0.2

Configuration example

Generated from documented defaults. Replace any placeholders and complete required nested settings before running.

yaml
templates:
  - template_name: "MHPatchcoreTrain"
    class_name: "MHPatchcoreTrain"
    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
      callback_configs: null
      mhpatchcore_init:
        layers: ["layer2", "layer3"]
        backbone: "wide_resnet50_2.tv2_in1k"
        evaluator: true
        visualizer: true
        pre_trained: true
        num_neighbors: 9
        pre_processor: true
        post_processor: true
        memory_bank_size: 1000
        local_coreset_size: 256
        pca_variance_ratio: 0.99
        covariance_shrinkage: 0.07
      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 MHPatchcoreTrain.

yaml
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

Immediate parent: sinapsis_anomalib.templates.anomalib_train.AnomalibTrain

Environment variables

Environment definitions belong to their canonical Python modules.

ANOMALIB_ROOT_DIR · defined elsewhereSINAPSIS_BUILD_DOCS · defined elsewhere