halib 0.2.3__tar.gz → 0.2.5__tar.gz

{halib-0.2.3 → halib-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: halib
-Version: 0.2.3
+Version: 0.2.5
 Summary: Small library for common tasks
 Author: Hoang Van Ha
 Author-email: hoangvanhauit@gmail.com
@@ -53,7 +53,7 @@ Dynamic: summary
 
 # Helper package for coding and automation
 
-**Version 0.2.3**
+**Version 0.2.5**
 + reorganize packages with most changes in `research` package; also rename `research` to `exp` (package for experiment management and utilities)
 
 **Version 0.2.1**

{halib-0.2.3 → halib-0.2.5}/README.md

@@ -1,6 +1,6 @@
 # Helper package for coding and automation
 
-**Version 0.2.3**
+**Version 0.2.5**
 + reorganize packages with most changes in `research` package; also rename `research` to `exp` (package for experiment management and utilities)
 
 **Version 0.2.1**

{halib-0.2.3 → halib-0.2.5}/halib/exp/core/base_config.py

@@ -8,7 +8,7 @@ from dataclasses import dataclass
 from dataclass_wizard import YAMLWizard
 
 
-class NamedConfig(ABC):
+class NamedCfg(ABC):
     """
     Base class for named configurations.
     All configurations should have a name.
@@ -24,7 +24,7 @@ class NamedConfig(ABC):
 
 
 @dataclass
-class AutoNamedConfig(YAMLWizard, NamedConfig):
+class AutoNamedCfg(YAMLWizard, NamedCfg):
     """
     Mixin that automatically implements get_name() by returning self.name.
     Classes using this MUST have a 'name' field.
@@ -42,9 +42,9 @@ class AutoNamedConfig(YAMLWizard, NamedConfig):
             # or handled by the loader.
             pass
 
-T = TypeVar("T", bound=AutoNamedConfig)
+T = TypeVar("T", bound=AutoNamedCfg)
 
-class BaseSelectorConfig(Generic[T]):
+class BaseSelectorCfg(Generic[T]):
     """
     Base class to handle the logic of selecting an item from a list by name.
     """
@@ -63,7 +63,7 @@ class BaseSelectorConfig(Generic[T]):
         )
 
 
-class ExpBaseConfig(ABC, YAMLWizard):
+class ExpBaseCfg(ABC, YAMLWizard):
     """
     Base class for configuration objects.
     What a cfg class must have:
@@ -128,7 +128,7 @@ class ExpBaseConfig(ABC, YAMLWizard):
         pass
 
     @abstractmethod
-    def get_dataset_cfg(self) -> NamedConfig:
+    def get_dataset_cfg(self) -> NamedCfg:
         """
         Get the dataset configuration.
         This method should be implemented in subclasses.
@@ -136,7 +136,7 @@ class ExpBaseConfig(ABC, YAMLWizard):
         pass
 
     @abstractmethod
-    def get_metric_cfg(self) -> NamedConfig:
+    def get_metric_cfg(self) -> NamedCfg:
         """
         Get the metric configuration.
         This method should be implemented in subclasses.

{halib-0.2.3 → halib-0.2.5}/halib/exp/core/base_exp.py

@@ -1,21 +1,38 @@
 from abc import ABC, abstractmethod
 from typing import Tuple, Any, Optional
-from base_config import ExpBaseConfig
+from .base_config import ExpBaseCfg
 from ..perf.perfcalc import PerfCalc
 from ..perf.perfmetrics import MetricsBackend
 
+
+class ExpHook:
+    """Base interface for all experiment hooks."""
+    def on_before_run(self, exp): pass
+    def on_after_run(self, exp, results): pass
+
+
 # ! SEE https://github.com/hahv/base_exp for sample usage
-class BaseExperiment(PerfCalc, ABC):
+class BaseExp(PerfCalc, ABC):
     """
     Base class for experiments.
     Orchestrates the experiment pipeline using a pluggable metrics backend.
     """
 
-    def __init__(self, config: ExpBaseConfig):
+    def __init__(self, config: ExpBaseCfg):
         self.config = config
         self.metric_backend = None
         # Flag to track if init_general/prepare_dataset has run
         self._is_env_ready = False
+        self.hooks = []
+
+    def register_hook(self, hook: ExpHook):
+        self.hooks.append(hook)
+
+    def _trigger_hooks(self, method_name: str, *args, **kwargs):
+        for hook in self.hooks:
+            method = getattr(hook, method_name, None)
+            if callable(method):
+                method(*args, **kwargs)
 
     # -----------------------
     # PerfCalc Required Methods
@@ -52,11 +69,6 @@ class BaseExperiment(PerfCalc, ABC):
         """
         pass
 
-    @abstractmethod
-    def before_exec_exp_once(self, *args, **kwargs):
-        """Optional: any setup before exec_exp. Note this is called once per run_exp."""
-        pass
-
     @abstractmethod
     def exec_exp(self, *args, **kwargs) -> Optional[Tuple[Any, Any]]:
         """Run experiment process, e.g.: training/evaluation loop.
@@ -64,13 +76,6 @@ class BaseExperiment(PerfCalc, ABC):
         """
         pass
 
-    @abstractmethod
-    def exec_eval(self, *args, **kwargs) -> Optional[Tuple[Any, Any]]:
-        """Run evaluation process.
-        Return: either `None` or a tuple of (raw_metrics_data, extra_data) for calc_and_save_exp_perfs
-        """
-        pass
-
     # -----------------------
     # Internal Helpers
     # -----------------------
@@ -121,8 +126,8 @@ class BaseExperiment(PerfCalc, ABC):
         """
         self._prepare_environment(force_reload=reload_env)
 
-        # Any pre-exec setup (loading models, etc)
-        self.before_exec_exp_once(*args, **kwargs)
+        self._trigger_hooks("before_run", self)
+
         # Save config before running
         self.config.save_to_outdir()
 
@@ -135,23 +140,8 @@ class BaseExperiment(PerfCalc, ABC):
             perf_results = self.calc_perfs(
                 raw_metrics_data=metrics_data, extra_data=extra_data, *args, **kwargs
             )
+            self._trigger_hooks("after_run", self, perf_results)
             return perf_results
         else:
+            self._trigger_hooks("after_run", self, results)
             return results
-
-    # -----------------------
-    # Main Experiment Evaluator
-    # -----------------------
-    def eval_exp(self, reload_env=False, *args, **kwargs):
-        """
-        Run evaluation only.
-        :param reload_env: If True, forces dataset/general init to run again.
-        """
-        self._prepare_environment(force_reload=reload_env)
-        results = self.exec_eval(*args, **kwargs)
-        if results is not None:
-            metrics_data, extra_data = self._validate_and_unpack(results)
-            return self.calc_perfs(
-                raw_metrics_data=metrics_data, extra_data=extra_data, *args, **kwargs
-            )
-        return None

{halib-0.2.3 → halib-0.2.5}/halib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: halib
-Version: 0.2.3
+Version: 0.2.5
 Summary: Small library for common tasks
 Author: Hoang Van Ha
 Author-email: hoangvanhauit@gmail.com
@@ -53,7 +53,7 @@ Dynamic: summary
 
 # Helper package for coding and automation
 
-**Version 0.2.3**
+**Version 0.2.5**
 + reorganize packages with most changes in `research` package; also rename `research` to `exp` (package for experiment management and utilities)
 
 **Version 0.2.1**

{halib-0.2.3 → halib-0.2.5}/setup.py

@@ -8,7 +8,7 @@ with open("requirements.txt") as f:
 
 setuptools.setup(
     name="halib",
-    version="0.2.3",
+    version="0.2.5",
     author="Hoang Van Ha",
     author_email="hoangvanhauit@gmail.com",
     description="Small library for common tasks",