hydraflow 0.3.3__tar.gz → 0.3.5__tar.gz

{hydraflow-0.3.3 → hydraflow-0.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: hydraflow
-Version: 0.3.3
+Version: 0.3.5
 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.3 → hydraflow-0.3.5}/pyproject.toml

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

{hydraflow-0.3.3 → hydraflow-0.3.5}/src/hydraflow/__init__.py

@@ -1,6 +1,7 @@
 """Integrate Hydra and MLflow to manage and track machine learning experiments."""
 
-from .context import chdir_artifact, chdir_hydra, log_run, start_run, watch
+from .config import select_config
+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
 from .run_collection import RunCollection
@@ -15,7 +16,7 @@ from .utils import (
 __all__ = [
     "RunCollection",
     "chdir_artifact",
-    "chdir_hydra",
+    "chdir_hydra_output",
     "get_artifact_dir",
     "get_hydra_output_dir",
     "get_overrides",
@@ -26,6 +27,7 @@ __all__ = [
     "multi_tasks_progress",
     "parallel_progress",
     "search_runs",
+    "select_config",
     "set_experiment",
     "start_run",
     "watch",

{hydraflow-0.3.3 → hydraflow-0.3.5}/src/hydraflow/config.py

@@ -44,12 +44,25 @@ def iter_params(config: object, prefix: str = "") -> Iterator[tuple[str, Any]]:
     if config is None:
         return
 
+    if isinstance(config, list) and all(isinstance(x, str) for x in config):
+        config = _from_dotlist(config)
+
     if not isinstance(config, DictConfig | ListConfig):
         config = OmegaConf.create(config)  # type: ignore
 
     yield from _iter_params(config, prefix)
 
 
+def _from_dotlist(config: list[str]) -> dict[str, str]:
+    result = {}
+    for item in config:
+        if "=" in item:
+            key, value = item.split("=", 1)
+            result[key.strip()] = value.strip()
+
+    return result
+
+
 def _iter_params(config: object, prefix: str = "") -> Iterator[tuple[str, Any]]:
     if isinstance(config, DictConfig):
         for key, value in config.items():
@@ -86,3 +99,32 @@ 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):
+        cfg = OmegaConf.structured(config)
+
+    return {name: _get(cfg, name) for name in names}
+
+
+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)

{hydraflow-0.3.3 → hydraflow-0.3.5}/src/hydraflow/context.py

@@ -239,7 +239,7 @@ class Handler(PatternMatchingEventHandler):
 
 
 @contextmanager
-def chdir_hydra() -> Iterator[Path]:
+def chdir_hydra_output() -> Iterator[Path]:
     """Change the current working directory to the hydra output directory.
 
     This context manager changes the current working directory to the hydra output

{hydraflow-0.3.3 → hydraflow-0.3.5}/src/hydraflow/param.py

@@ -34,7 +34,10 @@ def match(param: str, value: Any) -> bool:
     if isinstance(value, tuple) and (m := _match_tuple(param, value)) is not None:
         return m
 
-    if isinstance(value, int | float | str):
+    if isinstance(value, str):
+        return param == value
+
+    if isinstance(value, int | float):
         return type(value)(param) == value
 
     return param == str(value)

{hydraflow-0.3.3 → hydraflow-0.3.5}/tests/scripts/app.py

@@ -27,7 +27,7 @@ cs.store(name="config", node=MySQLConfig)
 
 @hydra.main(version_base=None, config_name="config")
 def app(cfg: MySQLConfig):
-    with hydraflow.chdir_hydra() as path:
+    with hydraflow.chdir_hydra_output() as path:
         Path("chdir_hydra.txt").write_text(path.as_posix())
 
     hydraflow.set_experiment(prefix="_", suffix="_")

{hydraflow-0.3.3 → hydraflow-0.3.5}/tests/test_config.py

@@ -205,3 +205,52 @@ def test_list_config_str(s):
     assert isinstance(b, ListConfig)
     t = OmegaConf.create(json.loads(s))
     assert b == t
+
+
+@pytest.mark.parametrize("x", [{"a": 1}, {"a": [1, 2, 3]}])
+def test_collect_params_dict(x):
+    from hydraflow.config import collect_params
+
+    assert collect_params(x) == x
+
+
+def test_collect_params_dict_dot():
+    from hydraflow.config import collect_params
+
+    assert collect_params({"a": {"b": 1}}) == {"a.b": 1}
+    assert collect_params({"a.b": 1}) == {"a.b": 1}
+
+
+def test_collect_params_list_dot():
+    from hydraflow.config import collect_params
+
+    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}

{hydraflow-0.3.3 → hydraflow-0.3.5}/tests/test_run_collection.py

@@ -67,6 +67,8 @@ def test_filter_one(run_list: list[Run]):
     assert len(x) == 1
     x = filter_runs(run_list, p=1)
     assert len(x) == 1
+    x = filter_runs(run_list, ["p=1"])
+    assert len(x) == 1
 
 
 def test_filter_all(run_list: list[Run]):
@@ -77,6 +79,8 @@ def test_filter_all(run_list: list[Run]):
     assert len(x) == 5
     x = filter_runs(run_list, q=0)
     assert len(x) == 5
+    x = filter_runs(run_list, ["q=0"])
+    assert len(x) == 5
 
 
 def test_filter_list(run_list: list[Run]):
@@ -98,6 +102,8 @@ def test_filter_invalid_param(run_list: list[Run]):
 
     x = filter_runs(run_list, {"invalid": 0})
     assert len(x) == 6
+    x = filter_runs(run_list, ["invalid=0"])
+    assert len(x) == 6
 
 
 def test_filter_status(run_list: list[Run]):
@@ -181,15 +187,20 @@ def test_filter(rc: RunCollection):
     assert len(rc.filter()) == 6
     assert len(rc.filter({})) == 6
     assert len(rc.filter({"p": 1})) == 1
+    assert len(rc.filter(["p=1"])) == 1
     assert len(rc.filter({"q": 0})) == 5
+    assert len(rc.filter(["q=0"])) == 5
     assert len(rc.filter({"q": -1})) == 0
+    assert len(rc.filter(["q=-1"])) == 0
     assert not rc.filter({"q": -1})
     assert len(rc.filter(p=5)) == 1
     assert len(rc.filter(q=0)) == 5
     assert len(rc.filter(q=-1)) == 0
     assert not rc.filter(q=-1)
     assert len(rc.filter({"r": 2})) == 2
+    assert len(rc.filter(["r=2"])) == 2
     assert len(rc.filter(r=0)) == 2
+    assert len(rc.filter(["r=0"])) == 2
 
 
 def test_get(rc: RunCollection):
@@ -197,15 +208,21 @@ def test_get(rc: RunCollection):
     assert isinstance(run, Run)
     run = rc.get(p=2)
     assert isinstance(run, Run)
+    run = rc.get(["p=3"])
+    assert isinstance(run, Run)
 
 
 def test_try_get(rc: RunCollection):
     run = rc.try_get({"p": 5})
     assert isinstance(run, Run)
+    run = rc.try_get(["p=2"])
+    assert isinstance(run, Run)
     run = rc.try_get(p=1)
     assert isinstance(run, Run)
     run = rc.try_get(p=-1)
     assert run is None
+    run = rc.try_get(["p=-2"])
+    assert run is None
 
 
 def test_get_param_names(rc: RunCollection):

{hydraflow-0.3.3 → hydraflow-0.3.5}/src/hydraflow/utils.py

@@ -68,11 +68,6 @@ def get_hydra_output_dir(run: Run | None = None) -> Path:
     raise FileNotFoundError
 
 
-def get_overrides() -> list[str]:
-    """Retrieve the overrides for the current run."""
-    return HydraConfig.get().overrides.task
-
-
 def load_config(run: Run) -> DictConfig:
     """Load the configuration for a given run.
 
@@ -93,6 +88,11 @@ def load_config(run: Run) -> DictConfig:
     return OmegaConf.load(path)  # type: ignore
 
 
+def get_overrides() -> list[str]:
+    """Retrieve the overrides for the current run."""
+    return HydraConfig.get().overrides.task
+
+
 def load_overrides(run: Run) -> list[str]:
     """Load the overrides for a given run.