sinapsis-anomalib 0.1.7__py3-none-any.whl → 0.1.8__py3-none-any.whl

sinapsis_anomalib/helpers/configs.py

@@ -0,0 +1,81 @@
+from collections.abc import Sequence
+from pathlib import Path
+from typing import Literal
+
+from anomalib.data.utils import TestSplitMode, ValSplitMode
+from pydantic import BaseModel, ConfigDict
+
+
+class FolderConfig(BaseModel):
+    """Configuration for the Anomalib Folder datamodule.
+
+    This model defines parameters for loading image data from a directory structure.
+    It is flexible and allows any other valid `Folder` arguments
+    (like `train_augmentations`) to be passed through.
+
+    Attributes:
+        name (str): A descriptive name for the dataset.
+        root (str | Path | None): The root directory where the dataset is located.
+        normal_dir (str | Path | Sequence[str | Path]): Path to the directory containing normal images.
+        abnormal_dir (str | Path | Sequence[str | Path] | None): Path to the directory for abnormal images.
+        train_batch_size (int): The number of samples per batch for training. Defaults to 32.
+        eval_batch_size (int): The number of samples per batch for evaluation. Defaults to 32.
+        num_workers (int): The number of subprocesses to use for data loading. Defaults to 8.
+        seed (int | None): A random seed for reproducibility in data splitting.
+    """
+
+    name: str
+    root: str | Path | None = None
+    normal_dir: str | Path | Sequence[str | Path]
+    abnormal_dir: str | Path | Sequence[str | Path] | None = None
+    normal_test_dir: str | Path | Sequence[str | Path] | None = None
+    mask_dir: str | Path | Sequence[str | Path] | None = None
+    normal_split_ratio: float = 0.2
+    extensions: tuple[str] | None = None
+    train_batch_size: int = 32
+    eval_batch_size: int = 32
+    num_workers: int = 8
+    test_split_mode: TestSplitMode | str = TestSplitMode.FROM_DIR
+    test_split_ratio: float = 0.2
+    val_split_mode: ValSplitMode | str = ValSplitMode.FROM_TEST
+    val_split_ratio: float = 0.5
+    seed: int | None = None
+    model_config = ConfigDict(extra="allow", arbitrary_types_allowed=True)
+
+
+class TrainerConfig(BaseModel):
+    """Defines and validates parameters for the Trainer.
+
+    This model is flexible and allows any other valid Trainer arguments to be passed.
+
+    Attributes:
+        devices (int | list[int] | str | None): The devices to use for training (e.g., 1, [0, 1], "auto").
+            Defaults to "auto".
+        accelerator (Literal["gpu", "cpu", "auto"]): The hardware accelerator to use.
+            Defaults to "auto".
+        min_epochs (int): The minimum number of epochs to train for. Defaults to 1.
+        max_epochs (int): The maximum number of epochs to train for. Defaults to 1000.
+    """
+
+    devices: int | list[int] | str | None = "auto"
+    accelerator: Literal["cpu", "gpu", "tpu", "hpu", "auto"] = "cpu"
+    min_epochs: int = 1
+    max_epochs: int | None = None
+    model_config = ConfigDict(extra="allow")
+
+
+class OpenVINOArgs(BaseModel):
+    """Defines and validates parameters for OpenVINO model export.
+
+    This model is flexible and allows any other valid arguments for `openvino.save_model`.
+    For a full list of options, see the OpenVINO documentation.
+
+    Attributes:
+        compress_to_fp16 (bool | None): If True, compresses the model weights to FP16 precision.
+            Defaults to None.
+        compress_to_fp16 (bool | None): Print detailed information about conversion.
+    """
+
+    compress_to_fp16: bool | None = None
+    verbose: bool = False
+    model_config = ConfigDict(extra="allow")

sinapsis_anomalib/templates/anomalib_base.py

@@ -23,6 +23,7 @@ from sinapsis_core.template_base.base_models import (
 from sinapsis_core.template_base.dynamic_template import BaseDynamicWrapperTemplate, WrapperEntryConfig
 
 from sinapsis_anomalib.helpers.config_factory import CallbackFactory, LoggerFactory
+from sinapsis_anomalib.helpers.configs import FolderConfig
 from sinapsis_anomalib.helpers.tags import Tags
 
 EXCLUDED_MODELS = [
@@ -117,7 +118,7 @@ class AnomalibBaseAttributes(TemplateAttributes):
     """Base attributes for Anomalib model templates.
 
     Attributes:
-        folder_attributes (dict[str, Any]): Configuration for Folder datamodule. Required for training, optional
+        folder_attributes (FolderConfig): Configuration for Folder datamodule. Required for training, optional
             for export.
         callbacks (list[Callback] | None): Lightning callbacks
         normalization (NORMALIZATION | None): Input normalization
@@ -130,7 +131,7 @@ class AnomalibBaseAttributes(TemplateAttributes):
         logger_configs (dict[str, dict[str, Any]] | None): Logger configs
     """
 
-    folder_attributes: dict[str, Any] | None = None
+    folder_attributes: FolderConfig | None = None
     callbacks: list[Callback] | None = None
     normalization: NORMALIZATION | None = None
     threshold: THRESHOLD | None = None
@@ -209,7 +210,9 @@ class AnomalibBase(BaseDynamicWrapperTemplate):
         Returns:
             Folder: Configured data module instance
         """
-        return Folder(**self.attributes.folder_attributes)
+        if self.attributes.folder_attributes is None:
+            raise ValueError("'folder_attributes' must be provided to set up the data loader.")
+        return Folder(**self.attributes.folder_attributes.model_dump(exclude_none=True))
 
     @abstractmethod
     def execute(self, container: DataContainer) -> DataContainer:
@@ -225,4 +228,4 @@ class AnomalibBase(BaseDynamicWrapperTemplate):
     def reset_state(self, template_name: str | None = None) -> None:
         if torch.cuda.is_available():
             torch.cuda.empty_cache()
-        super().reset_state(template_name)
+        super().reset_state(template_name)

sinapsis_anomalib/templates/anomalib_export.py

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
 from pathlib import Path
-from typing import Any
 
 from anomalib.deploy import CompressionType, ExportType
 from pydantic.dataclasses import dataclass
@@ -11,6 +10,7 @@ from sinapsis_core.template_base.dynamic_template_factory import make_dynamic_te
 from sinapsis_core.utils.env_var_keys import SINAPSIS_BUILD_DOCS
 from torchmetrics import Metric
 
+from sinapsis_anomalib.helpers.configs import OpenVINOArgs
 from sinapsis_anomalib.helpers.tags import Tags
 from sinapsis_anomalib.templates.anomalib_base import (
     AnomalibBase,
@@ -53,7 +53,7 @@ class AnomalibExportAttributes(AnomalibBaseAttributes):
     input_size: tuple[int, int] | None = None
     compression_type: CompressionType | None = None
     metric: Metric | str | None = None
-    ov_args: dict[str, Any] | None = None
+    ov_args: OpenVINOArgs | None = None
     ckpt_path: str | None = None
     generic_key_chkpt: str | None = None
 
@@ -123,6 +123,11 @@ class AnomalibExport(AnomalibBase):
             CompressionType.INT8_ACQ,
             CompressionType.INT8_PTQ,
         ):
+            if self.attributes.folder_attributes is None:
+                raise ValueError(
+                    f"Compression type '{self.attributes.compression_type.value}' requires "
+                    "'folder_attributes' to be provided."
+                )
             self.data_module = self.setup_data_loader()
 
     def _get_checkpoint_path(self, container: DataContainer) -> str | Path:
@@ -170,7 +175,7 @@ class AnomalibExport(AnomalibBase):
             compression_type=self.attributes.compression_type,
             datamodule=self.data_module,
             metric=self.attributes.metric,
-            ov_args=self.attributes.ov_args,
+            ov_args=self.attributes.ov_args.model_dump(exclude_none=True) if self.attributes.ov_args else None,
             ckpt_path=ckpt_path,
         )
 

sinapsis_anomalib/templates/anomalib_train.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 from pathlib import Path
-from typing import Any, Literal
+from typing import Any
 
 from anomalib.engine.engine import _TrainerArgumentsCache
 from pydantic import Field
@@ -11,6 +11,7 @@ from sinapsis_core.template_base.base_models import TemplateAttributeType
 from sinapsis_core.template_base.dynamic_template_factory import make_dynamic_template
 from sinapsis_core.utils.env_var_keys import SINAPSIS_BUILD_DOCS
 
+from sinapsis_anomalib.helpers.configs import TrainerConfig
 from sinapsis_anomalib.helpers.tags import Tags
 from sinapsis_anomalib.templates.anomalib_base import (
     AnomalibBase,
@@ -59,20 +60,14 @@ class AnomalibTrainAttributes(AnomalibBaseAttributes):
     """Training-specific configuration attributes.
 
     Attributes:
-        max_epochs (int | None): Maximum number of training epochs.
-            If None, uses default from model configuration.
-        accelerator: (Literal["cpu", "gpu", "tpu", "hpu", "auto"]): Define the device to be used during training.
-            Defaults to "cpu".
         ckpt_path (str | Path | None): Path to checkpoint for resuming training.
             If None, starts training from scratch.
-        trainer_args: (dict[str, Any]): General trainer arguments. For more details see:
+        trainer_args: (TrainerConfig): General trainer arguments. For more details see:
             https://lightning.ai/docs/pytorch/stable/common/trainer.html#trainer-flags
     """
 
-    max_epochs: int | None = None
-    accelerator: Literal["cpu", "gpu", "tpu", "hpu", "auto"] = "cpu"
     ckpt_path: str | Path | None = None
-    trainer_args: dict[str, Any] = Field(default_factory=dict)
+    trainer_args: TrainerConfig = Field(default_factory=TrainerConfig)
 
 
 class AnomalibTrain(AnomalibBase):
@@ -101,11 +96,11 @@ class AnomalibTrain(AnomalibBase):
             default_root_dir: null
             callback_configs: null
             logger_configs: null
-            max_epochs: null
             ckpt_path: null
-            accelerator: gpu
             trainer_args:
                 devices: "0"
+                accelerator: gpu
+                max_epochs: null
             cfa_init:
                 backbone: wide_resnet50_2
                 gamma_c: 1
@@ -124,6 +119,8 @@ class AnomalibTrain(AnomalibBase):
 
     def __init__(self, attributes: TemplateAttributeType) -> None:
         super().__init__(attributes)
+        if self.attributes.folder_attributes is None:
+            raise ValueError("'folder_attributes' is required for training.")
         self.data_module = self.setup_data_loader()
 
     def _update_trainer_args(self) -> None:
@@ -133,10 +130,7 @@ class AnomalibTrain(AnomalibBase):
         based on the attributes configuration.
         """
         existing_args = self.engine._cache.args
-        existing_args[AnomalibTrainKeys.MAX_EPOCHS] = self.attributes.max_epochs
-
-        self.attributes.trainer_args[AnomalibTrainKeys.ACCELERATOR] = self.attributes.accelerator
-        existing_args.update(self.attributes.trainer_args)
+        existing_args.update(self.attributes.trainer_args.model_dump(exclude_none=True))
         self.engine._cache = _TrainerArgumentsCache(**existing_args)
 
     def _get_training_metrics(self) -> dict[str, Any]:

{sinapsis_anomalib-0.1.7.dist-info → sinapsis_anomalib-0.1.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sinapsis-anomalib
-Version: 0.1.7
+Version: 0.1.8
 Summary: Templates for anomaly detection with computer vision using anomalib library.
 Author-email: SinapsisAI <dev@sinapsis.tech>
 Project-URL: Homepage, https://sinapsis.tech

{sinapsis_anomalib-0.1.7.dist-info → sinapsis_anomalib-0.1.8.dist-info}/RECORD

@@ -1,16 +1,17 @@
 sinapsis_anomalib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sinapsis_anomalib/helpers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sinapsis_anomalib/helpers/config_factory.py,sha256=M7CPS2qHgUWBUTYkuVGhaa2S6IJZ8C3zGPulVjgXr_U,4493
+sinapsis_anomalib/helpers/configs.py,sha256=2wN7wNIJieH-zofUtkvsaSNuOvFBHoy5LGFG-EyYj1w,3449
 sinapsis_anomalib/helpers/tags.py,sha256=Oj8vSh8AbnOfDY4UadOOteQOhjKwXSB3Rv82hpeP2YE,325
 sinapsis_anomalib/templates/__init__.py,sha256=ltv45AB2oIhPw0jRrL0S6HMYYQp63Cr-DBjD0HjK1i0,904
-sinapsis_anomalib/templates/anomalib_base.py,sha256=zqK6NovNf37-k9ubVHK11YYWlUmZUAsZBBLItJ_Xtoc,8265
+sinapsis_anomalib/templates/anomalib_base.py,sha256=SbmRQc8NCq3LXaDbcA-qpqwyBW4UxYPvSaS9kytN-sc,8501
 sinapsis_anomalib/templates/anomalib_base_inference.py,sha256=YxYpiRK8CwzLjYJpSnNZkUq6OE9zSAbYnqNStPV9RBI,8996
-sinapsis_anomalib/templates/anomalib_export.py,sha256=702uNSGmjtYD3I96xlEZxFEOVG84TbM1sC7Gp-tK1vs,7478
+sinapsis_anomalib/templates/anomalib_export.py,sha256=vHUucJO6E9P7e-3okX8WdRv_otN0P6Fa0GKeWc5fA_0,7840
 sinapsis_anomalib/templates/anomalib_openvino_inference.py,sha256=FPr2iwC3JbasJnlOgdWzO5ugbQj3Kan3xp-oxJGkC1Q,3207
 sinapsis_anomalib/templates/anomalib_torch_inference.py,sha256=Q6aqspIjFpI7WY90jcnqNmqalhYIm_Um2As9Sx1AOeU,2862
-sinapsis_anomalib/templates/anomalib_train.py,sha256=x2PUQCHlYooG3XxYs2HZ4akxLRywqrR60M6L_f6y4HI,7752
-sinapsis_anomalib-0.1.7.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-sinapsis_anomalib-0.1.7.dist-info/METADATA,sha256=d2o-aGAVkjUbfx_QV1JwmrJ3R18rmAa4Hqh8RkSGUS8,7552
-sinapsis_anomalib-0.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-sinapsis_anomalib-0.1.7.dist-info/top_level.txt,sha256=p9ltOdENM_b-Ekvb0AvXmvZRV4Bwtly7c7qeOokACvE,18
-sinapsis_anomalib-0.1.7.dist-info/RECORD,,
+sinapsis_anomalib/templates/anomalib_train.py,sha256=nS0oLtB5lk-RwKTtuH1bWZc4YM3m6LTl_qowc1wBHs4,7424
+sinapsis_anomalib-0.1.8.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+sinapsis_anomalib-0.1.8.dist-info/METADATA,sha256=oSv_Rpgcebcs_r1G6x3AltDbiOAjBQ7xteG23_3TLng,7552
+sinapsis_anomalib-0.1.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sinapsis_anomalib-0.1.8.dist-info/top_level.txt,sha256=p9ltOdENM_b-Ekvb0AvXmvZRV4Bwtly7c7qeOokACvE,18
+sinapsis_anomalib-0.1.8.dist-info/RECORD,,