hydraflow 0.3.4__tar.gz → 0.3.6__tar.gz

{hydraflow-0.3.4 → hydraflow-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: hydraflow
-Version: 0.3.4
+Version: 0.3.6
 Summary: Hydraflow integrates Hydra and MLflow to manage and track machine learning experiments.
 Project-URL: Documentation, https://github.com/daizutabi/hydraflow
 Project-URL: Source, https://github.com/daizutabi/hydraflow

{hydraflow-0.3.4 → hydraflow-0.3.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "hydraflow"
-version = "0.3.4"
+version = "0.3.6"
 description = "Hydraflow integrates Hydra and MLflow to manage and track machine learning experiments."
 readme = "README.md"
 license = "MIT"

{hydraflow-0.3.4 → hydraflow-0.3.6}/src/hydraflow/__init__.py

@@ -1,5 +1,6 @@
 """Integrate Hydra and MLflow to manage and track machine learning experiments."""
 
+from .config import select_config, select_overrides
 from .context import chdir_artifact, chdir_hydra_output, log_run, start_run, watch
 from .mlflow import list_runs, search_runs, set_experiment
 from .progress import multi_tasks_progress, parallel_progress
@@ -26,6 +27,8 @@ __all__ = [
     "multi_tasks_progress",
     "parallel_progress",
     "search_runs",
+    "select_config",
+    "select_overrides",
     "set_experiment",
     "start_run",
     "watch",

{hydraflow-0.3.4 → hydraflow-0.3.6}/src/hydraflow/config.py

@@ -6,6 +6,8 @@ from typing import TYPE_CHECKING
 
 from omegaconf import DictConfig, ListConfig, OmegaConf
 
+from hydraflow.utils import get_overrides
+
 if TYPE_CHECKING:
     from collections.abc import Iterator
     from typing import Any
@@ -99,3 +101,39 @@ def _convert(value: Any) -> Any:
         return list(value)
 
     return value
+
+
+def select_config(config: object, names: list[str]) -> dict[str, Any]:
+    """Select the given parameters from the configuration object.
+
+    This function selects the given parameters from the configuration object
+    and returns a new configuration object containing only the selected parameters.
+
+    Args:
+        config (object): The configuration object to select parameters from.
+        names (list[str]): The names of the parameters to select.
+
+    Returns:
+        DictConfig: A new configuration object containing only the selected parameters.
+
+    """
+    if not isinstance(config, DictConfig):
+        config = OmegaConf.structured(config)
+
+    return {name: _get(config, name) for name in names}  # type: ignore
+
+
+def _get(config: DictConfig, name: str) -> Any:
+    """Get the value of the given parameter from the configuration object."""
+    if "." not in name:
+        return config.get(name)
+
+    prefix, name = name.split(".", 1)
+    return _get(config.get(prefix), name)
+
+
+def select_overrides(config: object) -> dict[str, Any]:
+    """Select the given overrides from the configuration object."""
+    overrides = get_overrides()
+    names = [override.split("=")[0].strip() for override in overrides]
+    return select_config(config, names)

{hydraflow-0.3.4 → hydraflow-0.3.6}/src/hydraflow/run_collection.py

@@ -26,7 +26,7 @@ from typing import TYPE_CHECKING, Any, Concatenate, ParamSpec, TypeVar, overload
 from mlflow.entities import RunStatus
 
 import hydraflow.param
-from hydraflow.config import iter_params
+from hydraflow.config import iter_params, select_config, select_overrides
 from hydraflow.run_data import RunCollectionData
 from hydraflow.run_info import RunCollectionInfo
 from hydraflow.utils import load_config
@@ -616,6 +616,8 @@ def filter_runs(
     runs: list[Run],
     config: object | None = None,
     *,
+    override: bool = False,
+    select: list[str] | None = None,
     status: str | list[str] | int | list[int] | None = None,
     **kwargs,
 ) -> list[Run]:
@@ -636,17 +638,26 @@ def filter_runs(
 
     Args:
         runs (list[Run]): The list of runs to filter.
-        config (object | None): The configuration object to filter the runs.
-            This can be any object that provides key-value pairs through the
-            `iter_params` function.
-        status (str | list[str] | RunStatus | list[RunStatus] | None): The status of
-            the runs to filter.
+        config (object | None, optional): The configuration object to filter the
+            runs. This can be any object that provides key-value pairs through
+            the `iter_params` function. Defaults to None.
+        override (bool, optional): If True, filter the runs based on
+            the overrides. Defaults to False.
+        select (list[str] | None, optional): The list of parameters to select.
+            Defaults to None.
+        status (str | list[str] | RunStatus | list[RunStatus] | None, optional): The
+            status of the runs to filter. Defaults to None.
         **kwargs: Additional key-value pairs to filter the runs.
 
     Returns:
         A list of runs that match the specified configuration and key-value pairs.
 
     """
+    if override:
+        config = select_overrides(config)
+    elif select:
+        config = select_config(config, select)
+
     for key, value in chain(iter_params(config), kwargs.items()):
         runs = [run for run in runs if _param_matches(run, key, value)]
         if not runs:

{hydraflow-0.3.4 → hydraflow-0.3.6}/src/hydraflow/utils.py

@@ -90,7 +90,7 @@ def load_config(run: Run) -> DictConfig:
 
 def get_overrides() -> list[str]:
     """Retrieve the overrides for the current run."""
-    return HydraConfig.get().overrides.task
+    return list(HydraConfig.get().overrides.task)  # ListConifg -> list
 
 
 def load_overrides(run: Run) -> list[str]:

hydraflow-0.3.6/tests/integ/app.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import logging
+from dataclasses import dataclass, field
+
+import hydra
+from hydra.core.config_store import ConfigStore
+
+import hydraflow
+
+log = logging.getLogger(__name__)
+
+
+@dataclass
+class B:
+    z: float = 0.0
+
+
+@dataclass
+class A:
+    y: str = "y"
+    b: B = field(default_factory=B)
+
+
+@dataclass
+class Config:
+    x: int = 0
+    y: int = 0
+    a: A = field(default_factory=A)
+
+
+cs = ConfigStore.instance()
+cs.store(name="config", node=Config)
+
+
+@hydra.main(version_base=None, config_name="config")
+def app(cfg: Config):
+    hydraflow.set_experiment()
+    rc = hydraflow.list_runs()
+    log.info(rc)
+    log.info(hydraflow.select_overrides(cfg))
+    log.info(rc.filter(cfg, override=True))
+    log.info(rc.filter(cfg, select=["x"]))
+    log.info(rc.try_find_last(cfg, override=True))
+    log.info(rc.try_find_last(cfg, select=["x"]))
+    log.info(rc.filter(cfg))
+
+    cfg.y = 2 * cfg.x
+    with hydraflow.start_run(cfg):
+        pass
+
+
+if __name__ == "__main__":
+    app()

{hydraflow-0.3.4 → hydraflow-0.3.6}/tests/test_config.py

@@ -226,3 +226,31 @@ def test_collect_params_list_dot():
 
     assert collect_params(["a=1"]) == {"a": "1"}
     assert collect_params(["a.b=2", "c"]) == {"a.b": "2"}
+
+
+@dataclass
+class C:
+    z: int = 3
+
+
+@dataclass
+class B:
+    y: int = 2
+    c: C = field(default_factory=C)
+
+
+@dataclass
+class A:
+    x: int = 1
+    b: B = field(default_factory=B)
+
+
+def test_select_config():
+    from hydraflow.config import select_config
+
+    a = A()
+    assert select_config(a, ["x"]) == {"x": 1}
+    assert select_config(a, ["b.y"]) == {"b.y": 2}
+    assert select_config(a, ["b.c.z"]) == {"b.c.z": 3}
+    assert select_config(a, ["b.c.z", "x"]) == {"b.c.z": 3, "x": 1}
+    assert select_config(a, ["b.c.z", "b.y"]) == {"b.c.z": 3, "b.y": 2}