halib 0.1.90__py3-none-any.whl → 0.1.91__py3-none-any.whl

halib/research/params_gen.py

@@ -0,0 +1,108 @@
+from typing import Dict, Any, List
+import numpy as np
+from ..common import *
+from ..filetype import yamlfile
+import yaml
+import os
+
+class ParamGen:
+
+    @staticmethod
+    def build_from_file(params_file):
+        builder = ParamGen(params_file)
+        return builder.params
+
+    def __init__(self, params_file=None):
+        self.params = {}
+        assert os.path.isfile(params_file), f"params_file not found: {params_file}"
+        self.params = self._build(params_file)
+
+    def _expand_param(self, param_name: str, config: Dict[str, Any]) -> List[Any]:
+        """
+        Validates and expands the values for a single parameter configuration.
+
+        Args:
+            param_name: The name of the parameter being processed.
+            config: The configuration dictionary for this parameter.
+
+        Returns:
+            A list of the expanded values for the parameter.
+
+        Raises:
+            TypeError: If the configuration or its values have an incorrect type.
+            ValueError: If the configuration is missing keys or has an invalid structure.
+        """
+        # 1. Validate the configuration structure
+        if not isinstance(config, dict):
+            raise TypeError(f"Config for '{param_name}' must be a dictionary.")
+
+        if "type" not in config or "values" not in config:
+            raise ValueError(
+                f"Config for '{param_name}' must contain 'type' and 'values' keys."
+            )
+
+        gen_type = config["type"]
+        values = config["values"]
+
+        # 2. Handle the generation based on type
+        if gen_type == "list":
+            # Ensure values are returned as a list, even if a single item was provided
+            return values if isinstance(values, list) else [values]
+
+        elif gen_type == "range":
+            if not isinstance(values, list) or len(values) != 3:
+                raise ValueError(
+                    f"For 'range' type on '{param_name}', 'values' must be a list of 3 numbers "
+                    f"[start, end, step], but got: {values}"
+                )
+
+            start, end, step = values
+            if all(isinstance(v, int) for v in values):
+                return list(range(start, end, step))
+            elif all(isinstance(v, (int, float)) for v in values):
+                # Use numpy for floating point ranges
+                temp_list = list(np.arange(start, end, step))
+                # convert to float (not np.float)
+                return [float(v) for v in temp_list]
+            else:
+                raise TypeError(
+                    f"All 'values' for 'range' on '{param_name}' must be numbers."
+                )
+
+        else:
+            raise ValueError(
+                f"Invalid 'type' for '{param_name}': '{gen_type}'. Must be 'list' or 'range'."
+            )
+
+    def _build(self, params_file):
+        """
+        Builds a full optimization configuration by expanding parameter values based on their type.
+
+        This function processes a dictionary where each key is a parameter name and each value
+        is a config dict specifying the 'type' ('list' or 'range') and 'values' for generation.
+
+        Args:
+            opt_cfg: The input configuration dictionary.
+                    Example:
+                    {
+                        "learning_rate": {"type": "range", "values": [0.01, 0.1, 0.01]},
+                        "optimizer": {"type": "list", "values": ["adam", "sgd"]},
+                        "epochs": {"type": "list", "values": 100}
+                    }
+
+        Returns:
+            A dictionary with parameter names mapped to their fully expanded list of values.
+        """
+        cfg_raw_dict = yamlfile.load_yaml(params_file, to_dict=True)
+        if not isinstance(cfg_raw_dict, dict):
+            raise TypeError("The entire opt_cfg must be a dictionary.")
+
+        # Use a dictionary comprehension for a clean and efficient build
+        return {
+            param_name: self._expand_param(param_name, config)
+            for param_name, config in cfg_raw_dict.items()
+        }
+
+    def save(self, outfile):
+        with open(outfile, "w") as f:
+            yaml.dump(self.params, f)

{halib-0.1.90.dist-info → halib-0.1.91.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: halib
-Version: 0.1.90
+Version: 0.1.91
 Summary: Small library for common tasks
 Author: Hoang Van Ha
 Author-email: hoangvanhauit@gmail.com
@@ -52,6 +52,9 @@ Dynamic: summary
 
 Helper package for coding and automation
 
+**Version 0.1.91**
++ `research/param_gen`: add `ParamGen` class to generate parameter list from yaml file for hyperparameter search (grid search, random search, etc.)
+
 **Version 0.1.90**
 
 + `research/profiler`: add `zProfiler` class to measure execution time of contexts and steps, with support for dynamic color scales in plots.

{halib-0.1.90.dist-info → halib-0.1.91.dist-info}/RECORD

@@ -34,6 +34,7 @@ halib/research/benchquery.py,sha256=FuKnbWQtCEoRRtJAfN-zaN-jPiO_EzsakmTOMiqi7GQ,
 halib/research/dataset.py,sha256=QU0Hr5QFb8_XlvnOMgC9QJGIpwXAZ9lDd0RdQi_QRec,6743
 halib/research/metrics.py,sha256=PXPCy8r1_0lpMKfjc5SjIpRHnX80gHmeZ1C4eVj9U_s,5200
 halib/research/mics.py,sha256=uX17AGrBGER-OFMqUULE_A9YPPbn1RpQ4o5-omrmqZ8,377
+halib/research/params_gen.py,sha256=GcTMlniL0iE3HalJY-gVRiYa8Qy8u6nX4LkKZeMkct8,4262
 halib/research/perfcalc.py,sha256=qDa0sqfpWrwGZVJtjuUVFK7JX6j8xyXP9OnnfYmdamg,15898
 halib/research/perftb.py,sha256=FWg0b8wSgy4UwuvHSXwEqvTq1Rhi-z-HtAKuQg1lWc4,30989
 halib/research/plot.py,sha256=A3di1HZhIHIKf7d9b-I68yu_cm4u2LpHoPKlirCaNOI,17956
@@ -53,8 +54,8 @@ halib/utils/gpu_mon.py,sha256=vD41_ZnmPLKguuq9X44SB_vwd9JrblO4BDzHLXZhhFY,2233
 halib/utils/listop.py,sha256=Vpa8_2fI0wySpB2-8sfTBkyi_A4FhoFVVvFiuvW8N64,339
 halib/utils/tele_noti.py,sha256=-4WXZelCA4W9BroapkRyIdUu9cUVrcJJhegnMs_WpGU,5928
 halib/utils/video.py,sha256=ZqzNVPgc1RZr_T0OlHvZ6SzyBpL7O27LtB86JMbBuR0,3059
-halib-0.1.90.dist-info/licenses/LICENSE.txt,sha256=qZssdna4aETiR8znYsShUjidu-U4jUT9Q-EWNlZ9yBQ,1100
-halib-0.1.90.dist-info/METADATA,sha256=Y4k_phq_7NXqZrr9JjNG2jgUM8n2XKXwI5pFt9HVIAQ,5864
-halib-0.1.90.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-halib-0.1.90.dist-info/top_level.txt,sha256=7AD6PLaQTreE0Fn44mdZsoHBe_Zdd7GUmjsWPyQ7I-k,6
-halib-0.1.90.dist-info/RECORD,,
+halib-0.1.91.dist-info/licenses/LICENSE.txt,sha256=qZssdna4aETiR8znYsShUjidu-U4jUT9Q-EWNlZ9yBQ,1100
+halib-0.1.91.dist-info/METADATA,sha256=Fx00uk-QuxbR2R_Z2fJhnfHXSNEa3fHD0SdUFs-IiEs,6035
+halib-0.1.91.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+halib-0.1.91.dist-info/top_level.txt,sha256=7AD6PLaQTreE0Fn44mdZsoHBe_Zdd7GUmjsWPyQ7I-k,6
+halib-0.1.91.dist-info/RECORD,,