hydraflow 0.2.18__tar.gz → 0.3.0__tar.gz

{hydraflow-0.2.18 → hydraflow-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: hydraflow
-Version: 0.2.18
+Version: 0.3.0
 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
@@ -17,6 +17,7 @@ Requires-Python: >=3.10
 Requires-Dist: hydra-core>=1.3
 Requires-Dist: joblib
 Requires-Dist: mlflow>=2.15
+Requires-Dist: polars
 Requires-Dist: rich
 Requires-Dist: watchdog
 Requires-Dist: watchfiles

{hydraflow-0.2.18 → hydraflow-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "hydraflow"
-version = "0.2.18"
+version = "0.3.0"
 description = "Hydraflow integrates Hydra and MLflow to manage and track machine learning experiments."
 readme = "README.md"
 license = "MIT"
@@ -21,6 +21,7 @@ dependencies = [
   "hydra-core>=1.3",
   "joblib",
   "mlflow>=2.15",
+  "polars",
   "rich",
   "watchdog",
   "watchfiles",
@@ -80,7 +81,7 @@ ignore = [
   "PGH003",
   "TRY003",
 ]
-exclude = ["tests/scripts/*.py", "src/hydraflow/__init__.py"]
+exclude = ["tests/scripts/*.py"]
 
 [tool.ruff.lint.per-file-ignores]
 "tests/*" = [
@@ -89,6 +90,7 @@ exclude = ["tests/scripts/*.py", "src/hydraflow/__init__.py"]
   "ARG",
   "D",
   "FBT",
+  "PD",
   "PLR",
   "PT",
   "S",

{hydraflow-0.2.18 → hydraflow-0.3.0}/src/hydraflow/__init__.py

@@ -1,5 +1,6 @@
+"""Provide a collection of MLflow runs."""
+
 from .context import chdir_artifact, log_run, start_run, watch
-from .info import get_artifact_dir, get_hydra_output_dir, load_config
 from .mlflow import (
     list_runs,
     search_runs,
@@ -7,6 +8,8 @@ from .mlflow import (
 )
 from .progress import multi_tasks_progress, parallel_progress
 from .run_collection import RunCollection
+from .run_data import load_config
+from .run_info import get_artifact_dir, get_hydra_output_dir
 
 __all__ = [
     "RunCollection",

{hydraflow-0.2.18 → hydraflow-0.3.0}/src/hydraflow/config.py

@@ -11,6 +11,20 @@ if TYPE_CHECKING:
     from typing import Any
 
 
+def collect_params(config: object) -> dict[str, Any]:
+    """Iterate over parameters and collect them into a dictionary.
+
+    Args:
+        config (object): The configuration object to iterate over.
+        prefix (str): The prefix to prepend to the parameter keys.
+
+    Returns:
+        dict[str, Any]: A dictionary of collected parameters.
+
+    """
+    return dict(iter_params(config))
+
+
 def iter_params(config: object, prefix: str = "") -> Iterator[tuple[str, Any]]:
     """Recursively iterate over the parameters in the given configuration object.
 

{hydraflow-0.2.18 → hydraflow-0.3.0}/src/hydraflow/context.py

@@ -14,8 +14,8 @@ from hydra.core.hydra_config import HydraConfig
 from watchdog.events import FileModifiedEvent, PatternMatchingEventHandler
 from watchdog.observers import Observer
 
-from hydraflow.info import get_artifact_dir
 from hydraflow.mlflow import log_params
+from hydraflow.run_info import get_artifact_dir
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Iterator

{hydraflow-0.2.18 → hydraflow-0.3.0}/src/hydraflow/run_collection.py

@@ -24,10 +24,12 @@ from itertools import chain
 from typing import TYPE_CHECKING, Any, Concatenate, ParamSpec, TypeVar, overload
 
 from mlflow.entities import RunStatus
+from polars.dataframe import DataFrame
 
 import hydraflow.param
-from hydraflow.config import iter_params
-from hydraflow.info import RunCollectionInfo
+from hydraflow.config import collect_params, iter_params
+from hydraflow.run_data import RunCollectionData
+from hydraflow.run_info import RunCollectionInfo
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Iterator
@@ -61,8 +63,12 @@ class RunCollection:
     _info: RunCollectionInfo = field(init=False)
     """An instance of `RunCollectionInfo`."""
 
+    _data: RunCollectionData = field(init=False)
+    """An instance of `RunCollectionData`."""
+
     def __post_init__(self) -> None:
         self._info = RunCollectionInfo(self)
+        self._data = RunCollectionData(self)
 
     def __repr__(self) -> str:
         return f"{self.__class__.__name__}({len(self)})"
@@ -101,6 +107,11 @@ class RunCollection:
         """An instance of `RunCollectionInfo`."""
         return self._info
 
+    @property
+    def data(self) -> RunCollectionData:
+        """An instance of `RunCollectionData`."""
+        return self._data
+
     def take(self, n: int) -> RunCollection:
         """Take the first n runs from the collection.
 
@@ -371,7 +382,7 @@ class RunCollection:
             raise ValueError(msg)
 
     def try_get(self, config: object | None = None, **kwargs) -> Run | None:
-        """Try to retrieve a specific `Run` instance based on the provided config.
+        """Try to get a specific `Run` instance based on the provided configuration.
 
         This method filters the runs in the collection according to the
         specified configuration object and returns the run that matches the
@@ -505,7 +516,7 @@ class RunCollection:
             in the collection.
 
         """
-        return (func(config, *args, **kwargs) for config in self.info.config)
+        return (func(config, *args, **kwargs) for config in self.data.config)
 
     def map_uri(
         self,
@@ -584,6 +595,16 @@ class RunCollection:
 
         return {key: RunCollection(runs) for key, runs in grouped_runs.items()}
 
+    @property
+    def config(self) -> DataFrame:
+        """Get the runs' configurations as a polars DataFrame.
+
+        Returns:
+            A polars DataFrame containing the runs' configurations.
+
+        """
+        return DataFrame(self.map_config(collect_params))
+
 
 def _param_matches(run: Run, key: str, value: Any) -> bool:
     params = run.data.params
@@ -634,8 +655,10 @@ def filter_runs(
     """
     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:
+            return []
 
-    if len(runs) == 0 or status is None:
+    if status is None:
         return runs
 
     return filter_runs_by_status(runs, status)

hydraflow-0.3.0/src/hydraflow/run_data.py

@@ -0,0 +1,56 @@
+"""Provide information about MLflow runs."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from omegaconf import DictConfig, OmegaConf
+
+from hydraflow.run_info import get_artifact_dir
+
+if TYPE_CHECKING:
+    from mlflow.entities import Run
+
+    from hydraflow.run_collection import RunCollection
+
+
+class RunCollectionData:
+    """Provide information about MLflow runs."""
+
+    def __init__(self, runs: RunCollection) -> None:
+        self._runs = runs
+
+    @property
+    def params(self) -> list[dict[str, str]]:
+        """Get the parameters for each run in the collection."""
+        return [run.data.params for run in self._runs]
+
+    @property
+    def metrics(self) -> list[dict[str, float]]:
+        """Get the metrics for each run in the collection."""
+        return [run.data.metrics for run in self._runs]
+
+    @property
+    def config(self) -> list[DictConfig]:
+        """Get the configuration for each run in the collection."""
+        return [load_config(run) for run in self._runs]
+
+
+def load_config(run: Run) -> DictConfig:
+    """Load the configuration for a given run.
+
+    This function loads the configuration for the provided Run instance
+    by downloading the configuration file from the MLflow artifacts and
+    loading it using OmegaConf. It returns an empty config if
+    `.hydra/config.yaml` is not found in the run's artifact directory.
+
+    Args:
+        run (Run): The Run instance for which to load the configuration.
+
+    Returns:
+        The loaded configuration as a DictConfig object. Returns an empty
+        DictConfig if the configuration file is not found.
+
+    """
+    path = get_artifact_dir(run) / ".hydra/config.yaml"
+    return OmegaConf.load(path)  # type: ignore

hydraflow-0.2.18/src/hydraflow/info.py → hydraflow-0.3.0/src/hydraflow/run_info.py

@@ -8,7 +8,7 @@ from typing import TYPE_CHECKING
 import mlflow
 from hydra.core.hydra_config import HydraConfig
 from mlflow.tracking import artifact_utils
-from omegaconf import DictConfig, OmegaConf
+from omegaconf import OmegaConf
 
 if TYPE_CHECKING:
     from mlflow.entities import Run
@@ -27,16 +27,6 @@ class RunCollectionInfo:
         """Get the run ID for each run in the collection."""
         return [run.info.run_id for run in self._runs]
 
-    @property
-    def params(self) -> list[dict[str, str]]:
-        """Get the parameters for each run in the collection."""
-        return [run.data.params for run in self._runs]
-
-    @property
-    def metrics(self) -> list[dict[str, float]]:
-        """Get the metrics for each run in the collection."""
-        return [run.data.metrics for run in self._runs]
-
     @property
     def artifact_uri(self) -> list[str | None]:
         """Get the artifact URI for each run in the collection."""
@@ -47,11 +37,6 @@ class RunCollectionInfo:
         """Get the artifact directory for each run in the collection."""
         return [get_artifact_dir(run) for run in self._runs]
 
-    @property
-    def config(self) -> list[DictConfig]:
-        """Get the configuration for each run in the collection."""
-        return [load_config(run) for run in self._runs]
-
 
 def get_artifact_dir(run: Run | None = None) -> Path:
     """Retrieve the artifact directory for the given run.
@@ -104,23 +89,3 @@ def get_hydra_output_dir(run: Run | None = None) -> Path:
         return Path(hc.hydra.runtime.output_dir)
 
     raise FileNotFoundError
-
-
-def load_config(run: Run) -> DictConfig:
-    """Load the configuration for a given run.
-
-    This function loads the configuration for the provided Run instance
-    by downloading the configuration file from the MLflow artifacts and
-    loading it using OmegaConf. It returns an empty config if
-    `.hydra/config.yaml` is not found in the run's artifact directory.
-
-    Args:
-        run (Run): The Run instance for which to load the configuration.
-
-    Returns:
-        The loaded configuration as a DictConfig object. Returns an empty
-        DictConfig if the configuration file is not found.
-
-    """
-    path = get_artifact_dir(run) / ".hydra/config.yaml"
-    return OmegaConf.load(path)  # type: ignore

{hydraflow-0.2.18 → hydraflow-0.3.0}/tests/test_app.py

@@ -90,24 +90,24 @@ def test_app_info_run_id(rc: RunCollection):
     assert len(rc.info.run_id) == 4
 
 
-def test_app_info_params(rc: RunCollection):
-    params = rc.info.params
+def test_app_data_params(rc: RunCollection):
+    params = rc.data.params
     assert params[0] == {"port": "1", "host": "x", "values": "[1, 2, 3]"}
     assert params[1] == {"port": "2", "host": "x", "values": "[1, 2, 3]"}
     assert params[2] == {"port": "1", "host": "y", "values": "[1, 2, 3]"}
     assert params[3] == {"port": "2", "host": "y", "values": "[1, 2, 3]"}
 
 
-def test_app_info_metrics(rc: RunCollection):
-    metrics = rc.info.metrics
+def test_app_data_metrics(rc: RunCollection):
+    metrics = rc.data.metrics
     assert metrics[0] == {"m": 11, "watch": 3}
     assert metrics[1] == {"m": 12, "watch": 3}
     assert metrics[2] == {"m": 2, "watch": 3}
     assert metrics[3] == {"m": 3, "watch": 3}
 
 
-def test_app_info_config(rc: RunCollection):
-    config = rc.info.config
+def test_app_data_config(rc: RunCollection):
+    config = rc.data.config
     assert config[0].port == 1
     assert config[1].port == 2
     assert config[2].host == "y"
@@ -122,14 +122,14 @@ def test_app_info_artifact_uri(rc: RunCollection):
 
 
 def test_app_info_artifact_dir(rc: RunCollection):
-    from hydraflow.info import get_artifact_dir
+    from hydraflow.run_info import get_artifact_dir
 
     dirs = list(rc.map(get_artifact_dir))
     assert rc.info.artifact_dir == dirs
 
 
 def test_app_hydra_output_dir(rc: RunCollection):
-    from hydraflow.info import get_hydra_output_dir
+    from hydraflow.run_info import get_hydra_output_dir
 
     dirs = list(rc.map(get_hydra_output_dir))
     assert dirs[0].stem == "0"
@@ -154,13 +154,13 @@ def test_app_group_by(rc: RunCollection):
     grouped = rc.group_by("host")
     assert len(grouped) == 2
     x = {"port": "1", "host": "x", "values": "[1, 2, 3]"}
-    assert grouped[("x",)].info.params[0] == x
+    assert grouped[("x",)].data.params[0] == x
     x = {"port": "2", "host": "x", "values": "[1, 2, 3]"}
-    assert grouped[("x",)].info.params[1] == x
+    assert grouped[("x",)].data.params[1] == x
     x = {"port": "1", "host": "y", "values": "[1, 2, 3]"}
-    assert grouped[("y",)].info.params[0] == x
+    assert grouped[("y",)].data.params[0] == x
     x = {"port": "2", "host": "y", "values": "[1, 2, 3]"}
-    assert grouped[("y",)].info.params[1] == x
+    assert grouped[("y",)].data.params[1] == x
 
 
 def test_app_filter_list(rc: RunCollection):
@@ -170,3 +170,11 @@ def test_app_filter_list(rc: RunCollection):
     assert len(filtered) == 4
     filtered = rc.filter(values=[1])
     assert not filtered
+
+
+def test_config(rc: RunCollection):
+    df = rc.config
+    assert df.columns == ["host", "port", "values"]
+    assert df.shape == (4, 3)
+    assert df.select("host").to_series().to_list() == ["x", "x", "y", "y"]
+    assert df.select("port").to_series().to_list() == [1, 2, 1, 2]

{hydraflow-0.2.18 → hydraflow-0.3.0}/tests/test_config.py

@@ -87,6 +87,14 @@ def test_iter_params():
     assert next(it) == ("l.1.3", "c")
 
 
+def test_collect_params():
+    from hydraflow.config import collect_params
+
+    conf = OmegaConf.create({"k": "v", "l": [1, {"a": "1", "b": "2", 3: "c"}]})
+    params = collect_params(conf)
+    assert params == {"k": "v", "l.0": 1, "l.1.a": "1", "l.1.b": "2", "l.1.3": "c"}
+
+
 @dataclass
 class Size:
     x: int = 1

{hydraflow-0.2.18 → hydraflow-0.3.0}/tests/test_log_run.py

@@ -50,7 +50,7 @@ def read_log(run_id: str, path: str) -> str:
 
 
 def test_load_config(run: Run):
-    from hydraflow.info import load_config
+    from hydraflow.run_data import load_config
 
     log = read_log(run.info.run_id, "log_run.log")
     assert "START" in log

hydraflow-0.3.0/tests/test_run_data.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+import mlflow
+import pytest
+
+from hydraflow.run_collection import RunCollection
+
+
+@pytest.fixture
+def runs(monkeypatch, tmp_path):
+    from hydraflow.mlflow import search_runs
+
+    monkeypatch.chdir(tmp_path)
+
+    mlflow.set_experiment("test_info")
+
+    for x in range(3):
+        with mlflow.start_run(run_name=f"{x}"):
+            mlflow.log_param("p", x)
+            mlflow.log_metric("metric1", x + 1)
+            mlflow.log_metric("metric2", x + 2)
+
+    x = search_runs()
+    assert isinstance(x, RunCollection)
+    return x
+
+
+def test_data_params(runs: RunCollection):
+    assert runs.data.params == [{"p": "0"}, {"p": "1"}, {"p": "2"}]
+
+
+def test_data_metrics(runs: RunCollection):
+    m = runs.data.metrics
+    assert m[0] == {"metric1": 1, "metric2": 2}
+    assert m[1] == {"metric1": 2, "metric2": 3}
+    assert m[2] == {"metric1": 3, "metric2": 4}
+
+
+def test_data_empty_run_collection():
+    rc = RunCollection([])
+    assert rc.data.params == []
+    assert rc.data.metrics == []
+    assert rc.data.config == []

hydraflow-0.2.18/tests/test_info.py → hydraflow-0.3.0/tests/test_run_info.py

@@ -18,9 +18,7 @@ def runs(monkeypatch, tmp_path):
 
     for x in range(3):
         with mlflow.start_run(run_name=f"{x}"):
-            mlflow.log_param("p", x)
-            mlflow.log_metric("metric1", x + 1)
-            mlflow.log_metric("metric2", x + 2)
+            pass
 
     x = search_runs()
     assert isinstance(x, RunCollection)
@@ -31,17 +29,6 @@ def test_info_run_id(runs: RunCollection):
     assert len(runs.info.run_id) == 3
 
 
-def test_info_params(runs: RunCollection):
-    assert runs.info.params == [{"p": "0"}, {"p": "1"}, {"p": "2"}]
-
-
-def test_info_metrics(runs: RunCollection):
-    m = runs.info.metrics
-    assert m[0] == {"metric1": 1, "metric2": 2}
-    assert m[1] == {"metric1": 2, "metric2": 3}
-    assert m[2] == {"metric1": 3, "metric2": 4}
-
-
 def test_info_artifact_uri(runs: RunCollection):
     uri = runs.info.artifact_uri
     assert all(u.startswith("file://") for u in uri)  # type: ignore
@@ -57,8 +44,5 @@ def test_info_artifact_dir(runs: RunCollection):
 def test_info_empty_run_collection():
     rc = RunCollection([])
     assert rc.info.run_id == []
-    assert rc.info.params == []
-    assert rc.info.metrics == []
     assert rc.info.artifact_uri == []
     assert rc.info.artifact_dir == []
-    assert rc.info.config == []