sinapsis-anomalib 0.1.10__tar.gz → 0.1.12__tar.gz

{sinapsis_anomalib-0.1.10/src/sinapsis_anomalib.egg-info → sinapsis_anomalib-0.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sinapsis-anomalib
-Version: 0.1.10
+Version: 0.1.12
 Summary: Templates for anomaly detection with computer vision using anomalib library.
 Author-email: SinapsisAI <dev@sinapsis.tech>
 Project-URL: Homepage, https://sinapsis.tech
@@ -118,7 +118,7 @@ _Export trained models for deployment in different formats._
 > [!TIP]
 > Use CLI command ```sinapsis info --example-template-config TEMPLATE_NAME``` to produce an example Agent config for the Template specified in ***TEMPLATE_NAME***.
 
-For example, for ***CfaTrain*** use ```sinapsis info --example-template-config CfaTrain``` to produce the following example config:
+For example, for ***CflowTrain*** use ```sinapsis info --example-template-config CflowTrain``` to produce the following example config:
 
 ```yaml
 agent:
@@ -127,30 +127,63 @@ templates:
 - template_name: InputTemplate
   class_name: InputTemplate
   attributes: {}
-- template_name: CfaTrain
-  class_name: CfaTrain
+- template_name: CflowTrain
+  class_name: CflowTrain
   template_input: InputTemplate
   attributes:
-    folder_attributes_config_path: null
-    generic_key: 'my_generic_key'
+    folder_attributes:
+      name: 'dataset'
+      root: null
+      normal_dir: 'images/normal'
+      abnormal_dir: null
+      normal_test_dir: null
+      mask_dir: null
+      normal_split_ratio: 0.2
+      extensions: null
+      train_batch_size: 32
+      eval_batch_size: 32
+      num_workers: 8
+      test_split_mode:
+      - from_dir
+      test_split_ratio: 0.2
+      val_split_mode:
+      - from_test
+      val_split_ratio: 0.5
+      seed: null
     callbacks: null
     normalization: null
     threshold: null
     image_metrics: null
     pixel_metrics: null
     logger: null
-    default_root_dir: null
     callback_configs: null
     logger_configs: null
-    max_epochs: null
     ckpt_path: null
-    cfa_init:
+    train_root: null
+    trainer_args:
+      devices: auto
+      accelerator: cpu
+      min_epochs: 1
+      max_epochs: 5
+    cflow_init:
       backbone: wide_resnet50_2
-      gamma_c: 1
-      gamma_d: 1
-      num_nearest_neighbors: 3
-      num_hard_negative_features: 3
-      radius: 1.0e-05
+      layers:
+      - layer2
+      - layer3
+      - layer4
+      pre_trained: true
+      fiber_batch_size: 64
+      decoder: freia-cflow
+      condition_vector: 128
+      coupling_blocks: 8
+      clamp_alpha: 1.9
+      permute_soft: false
+      lr: 0.0001
+      pre_processor: true
+      post_processor: true
+      evaluator: true
+      visualizer: true
+
 ```
 
 <details>
@@ -188,7 +221,7 @@ templates:
   class_name: CflowTrain
   attributes:
     folder_attributes_config_path: "configs/datamodule_config.yml"
-    default_root_dir: "results/model"
+    train_root: "model"
     max_epochs: 1
     cflow_init:
       lr: 0.0001

{sinapsis_anomalib-0.1.10 → sinapsis_anomalib-0.1.12}/README.md

@@ -71,7 +71,7 @@ _Export trained models for deployment in different formats._
 > [!TIP]
 > Use CLI command ```sinapsis info --example-template-config TEMPLATE_NAME``` to produce an example Agent config for the Template specified in ***TEMPLATE_NAME***.
 
-For example, for ***CfaTrain*** use ```sinapsis info --example-template-config CfaTrain``` to produce the following example config:
+For example, for ***CflowTrain*** use ```sinapsis info --example-template-config CflowTrain``` to produce the following example config:
 
 ```yaml
 agent:
@@ -80,30 +80,63 @@ templates:
 - template_name: InputTemplate
   class_name: InputTemplate
   attributes: {}
-- template_name: CfaTrain
-  class_name: CfaTrain
+- template_name: CflowTrain
+  class_name: CflowTrain
   template_input: InputTemplate
   attributes:
-    folder_attributes_config_path: null
-    generic_key: 'my_generic_key'
+    folder_attributes:
+      name: 'dataset'
+      root: null
+      normal_dir: 'images/normal'
+      abnormal_dir: null
+      normal_test_dir: null
+      mask_dir: null
+      normal_split_ratio: 0.2
+      extensions: null
+      train_batch_size: 32
+      eval_batch_size: 32
+      num_workers: 8
+      test_split_mode:
+      - from_dir
+      test_split_ratio: 0.2
+      val_split_mode:
+      - from_test
+      val_split_ratio: 0.5
+      seed: null
     callbacks: null
     normalization: null
     threshold: null
     image_metrics: null
     pixel_metrics: null
     logger: null
-    default_root_dir: null
     callback_configs: null
     logger_configs: null
-    max_epochs: null
     ckpt_path: null
-    cfa_init:
+    train_root: null
+    trainer_args:
+      devices: auto
+      accelerator: cpu
+      min_epochs: 1
+      max_epochs: 5
+    cflow_init:
       backbone: wide_resnet50_2
-      gamma_c: 1
-      gamma_d: 1
-      num_nearest_neighbors: 3
-      num_hard_negative_features: 3
-      radius: 1.0e-05
+      layers:
+      - layer2
+      - layer3
+      - layer4
+      pre_trained: true
+      fiber_batch_size: 64
+      decoder: freia-cflow
+      condition_vector: 128
+      coupling_blocks: 8
+      clamp_alpha: 1.9
+      permute_soft: false
+      lr: 0.0001
+      pre_processor: true
+      post_processor: true
+      evaluator: true
+      visualizer: true
+
 ```
 
 <details>
@@ -141,7 +174,7 @@ templates:
   class_name: CflowTrain
   attributes:
     folder_attributes_config_path: "configs/datamodule_config.yml"
-    default_root_dir: "results/model"
+    train_root: "model"
     max_epochs: 1
     cflow_init:
       lr: 0.0001

{sinapsis_anomalib-0.1.10 → sinapsis_anomalib-0.1.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sinapsis-anomalib"
-version = "0.1.10"
+version = "0.1.12"
 description = "Templates for anomaly detection with computer vision using anomalib library."
 authors = [
     {name = "SinapsisAI", email = "dev@sinapsis.tech"},

{sinapsis_anomalib-0.1.10 → sinapsis_anomalib-0.1.12}/src/sinapsis_anomalib/helpers/configs.py

@@ -55,13 +55,13 @@ class TrainerConfig(BaseModel):
         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.
+        max_epochs (int): The maximum number of epochs to train for. Defaults to 5.
     """
 
     devices: int | list[int] | str | None = "auto"
     accelerator: Literal["cpu", "gpu", "tpu", "hpu", "auto"] = "cpu"
     min_epochs: int = 1
-    max_epochs: int | None = None
+    max_epochs: int | None = 5
     model_config = ConfigDict(extra="allow")
 
 

sinapsis_anomalib-0.1.12/src/sinapsis_anomalib/helpers/env_var_keys.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+from typing import Any
+
+from pydantic import BaseModel
+from sinapsis_core.utils.env_var_keys import EnvVarEntry, doc_str, return_docs_for_vars
+
+
+class _AnomalibEnvVars(BaseModel):
+    """Env vars for Sinapsis Anomalib."""
+
+    ANOMALIB_ROOT_DIR: EnvVarEntry = EnvVarEntry(
+        var_name="ANOMALIB_ROOT_DIR",
+        default_value="artifacts",
+        allowed_values=None,
+        description="The base directory for all Anomalib-related artifacts, such as training and exported models.",
+    )
+
+
+AnomalibEnvVars = _AnomalibEnvVars()
+
+doc_str = return_docs_for_vars(AnomalibEnvVars, docs=doc_str, string_for_doc="""Anomalib env vars available: \n""")
+__doc__ = doc_str
+
+
+def __getattr__(name: str) -> Any:
+    """To use as an import, when updating the value is not important."""
+    if name in AnomalibEnvVars.model_fields:
+        return AnomalibEnvVars.model_fields[name].default.value
+
+    raise AttributeError(f"Agent does not have `{name}` env var")
+
+
+_all__ = (*list(AnomalibEnvVars.model_fields.keys()), "AnomalibEnvVars")

{sinapsis_anomalib-0.1.10 → sinapsis_anomalib-0.1.12}/src/sinapsis_anomalib/templates/anomalib_base.py

@@ -24,6 +24,7 @@ from sinapsis_core.template_base.dynamic_template import BaseDynamicWrapperTempl
 
 from sinapsis_anomalib.helpers.config_factory import CallbackFactory, LoggerFactory
 from sinapsis_anomalib.helpers.configs import FolderConfig
+from sinapsis_anomalib.helpers.env_var_keys import ANOMALIB_ROOT_DIR
 from sinapsis_anomalib.helpers.tags import Tags
 
 EXCLUDED_MODELS = [
@@ -77,7 +78,7 @@ class EngineConfig(BaseModel):
     image_metrics: METRICS_TYPE | None = None
     pixel_metrics: METRICS_TYPE | None = None
     logger: LOGGER_TYPE = None
-    default_root_dir: PATH_TYPE = None
+    default_root_dir: PATH_TYPE = ANOMALIB_ROOT_DIR
     callback_configs: dict[str, dict[str, Any]] | None = None
     logger_configs: dict[str, dict[str, Any]] | None = None
 
@@ -126,7 +127,6 @@ class AnomalibBaseAttributes(TemplateAttributes):
         image_metrics (METRICS_TYPE | None): Image metrics
         pixel_metrics (METRICS_TYPE | None): Pixel metrics
         logger (LOGGER_TYPE): Lightning logger
-        default_root_dir (PATH_TYPE): Output directory
         callback_configs (dict[str, dict[str, Any]] | None): Callback configs
         logger_configs (dict[str, dict[str, Any]] | None): Logger configs
     """
@@ -138,7 +138,6 @@ class AnomalibBaseAttributes(TemplateAttributes):
     image_metrics: METRICS_TYPE | None = None
     pixel_metrics: METRICS_TYPE | None = None
     logger: LOGGER_TYPE = None
-    default_root_dir: PATH_TYPE = None
     callback_configs: dict[str, dict[str, Any]] | None = None
     logger_configs: dict[str, dict[str, Any]] | None = None
 
@@ -226,6 +225,11 @@ class AnomalibBase(BaseDynamicWrapperTemplate):
         """
 
     def reset_state(self, template_name: str | None = None) -> None:
+        """Re-instantiates the template.
+
+        Args:
+            template_name (str | None, optional): The name of the template instance being reset. Defaults to None.
+        """
         if torch.cuda.is_available():
             torch.cuda.empty_cache()
         super().reset_state(template_name)

{sinapsis_anomalib-0.1.10 → sinapsis_anomalib-0.1.12}/src/sinapsis_anomalib/templates/anomalib_export.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+import os
 from pathlib import Path
 
 from anomalib.deploy import CompressionType, ExportType
@@ -11,6 +12,7 @@ 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.env_var_keys import ANOMALIB_ROOT_DIR
 from sinapsis_anomalib.helpers.tags import Tags
 from sinapsis_anomalib.templates.anomalib_base import (
     AnomalibBase,
@@ -47,6 +49,7 @@ class AnomalibExportAttributes(AnomalibBaseAttributes):
         ckpt_path (str | None): Explicit path to model checkpoint.
         generic_key_chkpt (str | None): Key to retrieve training results.
     """
+
     folder_attributes: dict | None = None
     export_type: ExportType = ExportType.TORCH
     export_root: str | Path | None = None
@@ -82,7 +85,6 @@ class AnomalibExport(AnomalibBase):
             image_metrics: null
             pixel_metrics: null
             logger: null
-            default_root_dir: null
             callback_configs: null
             logger_configs: null
             export_type: 'openvino'
@@ -153,7 +155,8 @@ class AnomalibExport(AnomalibBase):
         generic_data = self._get_generic_data(container, self.attributes.generic_key_chkpt)
         if generic_data and isinstance(generic_data, AnomalibTrainDataClass):
             return generic_data.checkpoint_path
-
+        if generic_data and isinstance(generic_data, dict):
+            return generic_data.get("checkpoint_path")
         raise ValueError("No checkpoint path found")
 
     def export_model(self, container: DataContainer) -> AnomalibExportDataClass:
@@ -166,11 +169,16 @@ class AnomalibExport(AnomalibBase):
             AnomalibExportDataClass: Contains exported model path
         """
         ckpt_path = self._get_checkpoint_path(container)
+        export_dir = (
+            os.path.join(ANOMALIB_ROOT_DIR, self.attributes.export_root)
+            if self.attributes.export_root
+            else ANOMALIB_ROOT_DIR
+        )
 
         exported_path = self.engine.export(
             model=self.model,
             export_type=self.attributes.export_type,
-            export_root=self.attributes.export_root,
+            export_root=export_dir,
             input_size=self.attributes.input_size,
             compression_type=self.attributes.compression_type,
             datamodule=self.data_module,

{sinapsis_anomalib-0.1.10 → sinapsis_anomalib-0.1.12}/src/sinapsis_anomalib/templates/anomalib_train.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+import os
 from pathlib import Path
 from typing import Any
 
@@ -12,6 +13,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 sinapsis_anomalib.helpers.configs import TrainerConfig
+from sinapsis_anomalib.helpers.env_var_keys import ANOMALIB_ROOT_DIR
 from sinapsis_anomalib.helpers.tags import Tags
 from sinapsis_anomalib.templates.anomalib_base import (
     AnomalibBase,
@@ -67,6 +69,7 @@ class AnomalibTrainAttributes(AnomalibBaseAttributes):
     """
 
     ckpt_path: str | Path | None = None
+    train_root: str | Path | None = None
     trainer_args: TrainerConfig = Field(default_factory=TrainerConfig)
 
 
@@ -93,7 +96,6 @@ class AnomalibTrain(AnomalibBase):
             image_metrics: null
             pixel_metrics: null
             logger: null
-            default_root_dir: null
             callback_configs: null
             logger_configs: null
             ckpt_path: null
@@ -129,7 +131,13 @@ class AnomalibTrain(AnomalibBase):
         Specifically sets the maximum number of training epochs
         based on the attributes configuration.
         """
+        train_dir = (
+            os.path.join(ANOMALIB_ROOT_DIR, self.attributes.train_root)
+            if self.attributes.train_root
+            else ANOMALIB_ROOT_DIR
+        )
         existing_args = self.engine._cache.args
+        existing_args["default_root_dir"] = train_dir
         existing_args.update(self.attributes.trainer_args.model_dump(exclude_none=True))
         self.engine._cache = _TrainerArgumentsCache(**existing_args)
 

{sinapsis_anomalib-0.1.10 → sinapsis_anomalib-0.1.12/src/sinapsis_anomalib.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sinapsis-anomalib
-Version: 0.1.10
+Version: 0.1.12
 Summary: Templates for anomaly detection with computer vision using anomalib library.
 Author-email: SinapsisAI <dev@sinapsis.tech>
 Project-URL: Homepage, https://sinapsis.tech
@@ -118,7 +118,7 @@ _Export trained models for deployment in different formats._
 > [!TIP]
 > Use CLI command ```sinapsis info --example-template-config TEMPLATE_NAME``` to produce an example Agent config for the Template specified in ***TEMPLATE_NAME***.
 
-For example, for ***CfaTrain*** use ```sinapsis info --example-template-config CfaTrain``` to produce the following example config:
+For example, for ***CflowTrain*** use ```sinapsis info --example-template-config CflowTrain``` to produce the following example config:
 
 ```yaml
 agent:
@@ -127,30 +127,63 @@ templates:
 - template_name: InputTemplate
   class_name: InputTemplate
   attributes: {}
-- template_name: CfaTrain
-  class_name: CfaTrain
+- template_name: CflowTrain
+  class_name: CflowTrain
   template_input: InputTemplate
   attributes:
-    folder_attributes_config_path: null
-    generic_key: 'my_generic_key'
+    folder_attributes:
+      name: 'dataset'
+      root: null
+      normal_dir: 'images/normal'
+      abnormal_dir: null
+      normal_test_dir: null
+      mask_dir: null
+      normal_split_ratio: 0.2
+      extensions: null
+      train_batch_size: 32
+      eval_batch_size: 32
+      num_workers: 8
+      test_split_mode:
+      - from_dir
+      test_split_ratio: 0.2
+      val_split_mode:
+      - from_test
+      val_split_ratio: 0.5
+      seed: null
     callbacks: null
     normalization: null
     threshold: null
     image_metrics: null
     pixel_metrics: null
     logger: null
-    default_root_dir: null
     callback_configs: null
     logger_configs: null
-    max_epochs: null
     ckpt_path: null
-    cfa_init:
+    train_root: null
+    trainer_args:
+      devices: auto
+      accelerator: cpu
+      min_epochs: 1
+      max_epochs: 5
+    cflow_init:
       backbone: wide_resnet50_2
-      gamma_c: 1
-      gamma_d: 1
-      num_nearest_neighbors: 3
-      num_hard_negative_features: 3
-      radius: 1.0e-05
+      layers:
+      - layer2
+      - layer3
+      - layer4
+      pre_trained: true
+      fiber_batch_size: 64
+      decoder: freia-cflow
+      condition_vector: 128
+      coupling_blocks: 8
+      clamp_alpha: 1.9
+      permute_soft: false
+      lr: 0.0001
+      pre_processor: true
+      post_processor: true
+      evaluator: true
+      visualizer: true
+
 ```
 
 <details>
@@ -188,7 +221,7 @@ templates:
   class_name: CflowTrain
   attributes:
     folder_attributes_config_path: "configs/datamodule_config.yml"
-    default_root_dir: "results/model"
+    train_root: "model"
     max_epochs: 1
     cflow_init:
       lr: 0.0001

{sinapsis_anomalib-0.1.10 → sinapsis_anomalib-0.1.12}/src/sinapsis_anomalib.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@ src/sinapsis_anomalib.egg-info/top_level.txt
 src/sinapsis_anomalib/helpers/__init__.py
 src/sinapsis_anomalib/helpers/config_factory.py
 src/sinapsis_anomalib/helpers/configs.py
+src/sinapsis_anomalib/helpers/env_var_keys.py
 src/sinapsis_anomalib/helpers/tags.py
 src/sinapsis_anomalib/templates/__init__.py
 src/sinapsis_anomalib/templates/anomalib_base.py