hydraflow 0.3.0__tar.gz → 0.3.1__tar.gz

{hydraflow-0.3.0 → hydraflow-0.3.1}/.devcontainer/devcontainer.json

@@ -1,5 +1,4 @@
 {
-  "name": "hydraflow",
   "image": "mcr.microsoft.com/vscode/devcontainers/python:3.12",
   "features": {
     "ghcr.io/devcontainers-contrib/features/starship:1": {},

{hydraflow-0.3.0 → hydraflow-0.3.1}/.gitignore

@@ -1,7 +1,11 @@
+*.db
 .coverage
 .env
 .venv/
 __pycache__/
 dist/
 lcov.info
+mlruns/
+multirun/
+outputs/
 uv.lock

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: hydraflow
-Version: 0.3.0
+Version: 0.3.1
 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.1/apps/hello.py

@@ -0,0 +1,31 @@
+import logging
+from dataclasses import dataclass
+
+import hydra
+from hydra.core.config_store import ConfigStore
+
+import hydraflow
+
+log = logging.getLogger(__name__)
+
+
+@dataclass
+class Config:
+    width: int = 1024
+    height: int = 768
+
+
+cs = ConfigStore.instance()
+cs.store(name="config", node=Config)
+
+
+@hydra.main(version_base=None, config_name="config")
+def app(cfg: Config) -> None:
+    hydraflow.set_experiment()
+
+    with hydraflow.start_run(cfg):
+        log.info(f"{cfg.width=}, {cfg.height=}")
+
+
+if __name__ == "__main__":
+    app()

{hydraflow-0.3.0 → hydraflow-0.3.1}/mkdocs.yml

@@ -38,6 +38,7 @@ theme:
     - navigation.tracking
 plugins:
   - search
+  - markdown-exec
   - mkapi
 markdown_extensions:
   - pymdownx.magiclink
@@ -50,4 +51,6 @@ markdown_extensions:
       alternate_style: true
 nav:
   - Home: index.md
+  - Usage:
+      - Hydra application: usage/hydra.md
   - Reference: $api/hydraflow.**

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

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "hydraflow"
-version = "0.3.0"
+version = "0.3.1"
 description = "Hydraflow integrates Hydra and MLflow to manage and track machine learning experiments."
 readme = "README.md"
 license = "MIT"
@@ -34,6 +34,10 @@ Issues = "https://github.com/daizutabi/hydraflow/issues"
 
 [tool.uv]
 dev-dependencies = [
+  "markdown-exec[ansi]",
+  "mkapi",
+  "mkdocs-material",
+  "mkdocs>=1.6",
   "pytest-asyncio",
   "pytest-clarity",
   "pytest-cov",
@@ -97,3 +101,4 @@ exclude = ["tests/scripts/*.py"]
   "SIM117",
   "SLF",
 ]
+"apps/*.py" = ["INP", "D", "G", "T"]

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

@@ -1,19 +1,15 @@
-"""Provide a collection of MLflow runs."""
+"""Integrate Hydra and MLflow to manage and track machine learning experiments."""
 
-from .context import chdir_artifact, log_run, start_run, watch
-from .mlflow import (
-    list_runs,
-    search_runs,
-    set_experiment,
-)
+from .context import chdir_artifact, chdir_hydra, 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
-from .run_data import load_config
-from .run_info import get_artifact_dir, get_hydra_output_dir
+from .utils import get_artifact_dir, get_hydra_output_dir, load_config
 
 __all__ = [
     "RunCollection",
     "chdir_artifact",
+    "chdir_hydra",
     "get_artifact_dir",
     "get_hydra_output_dir",
     "list_runs",

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

@@ -54,7 +54,7 @@ def _iter_params(config: object, prefix: str = "") -> Iterator[tuple[str, Any]]:
     if isinstance(config, DictConfig):
         for key, value in config.items():
             if _is_param(value):
-                yield f"{prefix}{key}", value
+                yield f"{prefix}{key}", _convert(value)
 
             else:
                 yield from _iter_params(value, f"{prefix}{key}.")
@@ -62,7 +62,7 @@ def _iter_params(config: object, prefix: str = "") -> Iterator[tuple[str, Any]]:
     elif isinstance(config, ListConfig):
         for index, value in enumerate(config):
             if _is_param(value):
-                yield f"{prefix}{index}", value
+                yield f"{prefix}{index}", _convert(value)
 
             else:
                 yield from _iter_params(value, f"{prefix}{index}.")
@@ -78,3 +78,11 @@ def _is_param(value: object) -> bool:
             return False
 
     return True
+
+
+def _convert(value: Any) -> Any:
+    """Convert the given value to a Python object."""
+    if isinstance(value, ListConfig):
+        return list(value)
+
+    return value

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

@@ -238,6 +238,25 @@ class Handler(PatternMatchingEventHandler):
             self.func(file)
 
 
+@contextmanager
+def chdir_hydra() -> Iterator[Path]:
+    """Change the current working directory to the hydra output directory.
+
+    This context manager changes the current working directory to the hydra output
+    directory. It ensures that the directory is changed back to the original
+    directory after the context is exited.
+    """
+    curdir = Path.cwd()
+    path = HydraConfig.get().runtime.output_dir
+
+    os.chdir(path)
+    try:
+        yield Path(path)
+
+    finally:
+        os.chdir(curdir)
+
+
 @contextmanager
 def chdir_artifact(
     run: Run,

{hydraflow-0.3.0 → hydraflow-0.3.1}/src/hydraflow/mlflow.py

@@ -207,8 +207,14 @@ def _list_runs(
         if experiment := mlflow.get_experiment_by_name(name):
             loc = experiment.artifact_location
 
-            if isinstance(loc, str) and loc.startswith("file://"):
-                path = Path(mlflow.artifacts.download_artifacts(loc))
+            if isinstance(loc, str):
+                if loc.startswith("file://"):
+                    path = Path(mlflow.artifacts.download_artifacts(loc))
+                elif Path(loc).is_dir():
+                    path = Path(loc)
+                else:
+                    continue
+
                 run_ids.extend(file.stem for file in path.iterdir() if file.is_dir())
 
     it = (joblib.delayed(mlflow.get_run)(run_id) for run_id in run_ids)

hydraflow-0.3.1/src/hydraflow/run_data.py

@@ -0,0 +1,34 @@
+"""Provide data about `RunCollection` instances."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from hydraflow.utils import load_config
+
+if TYPE_CHECKING:
+    from omegaconf import DictConfig
+
+    from hydraflow.run_collection import RunCollection
+
+
+class RunCollectionData:
+    """Provide data about a `RunCollection` instance."""
+
+    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]

hydraflow-0.3.1/src/hydraflow/run_info.py

@@ -0,0 +1,34 @@
+"""Provide information about `RunCollection` instances."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from hydraflow.utils import get_artifact_dir
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    from hydraflow.run_collection import RunCollection
+
+
+class RunCollectionInfo:
+    """Provide information about a `RunCollection` instance."""
+
+    def __init__(self, runs: RunCollection) -> None:
+        self._runs = runs
+
+    @property
+    def run_id(self) -> list[str]:
+        """Get the run ID for each run in the collection."""
+        return [run.info.run_id for run in self._runs]
+
+    @property
+    def artifact_uri(self) -> list[str | None]:
+        """Get the artifact URI for each run in the collection."""
+        return [run.info.artifact_uri for run in self._runs]
+
+    @property
+    def artifact_dir(self) -> list[Path]:
+        """Get the artifact directory for each run in the collection."""
+        return [get_artifact_dir(run) for run in self._runs]

hydraflow-0.3.0/src/hydraflow/run_info.py → hydraflow-0.3.1/src/hydraflow/utils.py

@@ -1,4 +1,4 @@
-"""Provide information about MLflow runs."""
+"""Provide utility functions for HydraFlow."""
 
 from __future__ import annotations
 
@@ -7,36 +7,13 @@ from typing import TYPE_CHECKING
 
 import mlflow
 from hydra.core.hydra_config import HydraConfig
+from mlflow.entities import Run
 from mlflow.tracking import artifact_utils
-from omegaconf import OmegaConf
+from omegaconf import DictConfig, OmegaConf
 
 if TYPE_CHECKING:
     from mlflow.entities import Run
 
-    from hydraflow.run_collection import RunCollection
-
-
-class RunCollectionInfo:
-    """Provide information about MLflow runs."""
-
-    def __init__(self, runs: RunCollection) -> None:
-        self._runs = runs
-
-    @property
-    def run_id(self) -> list[str]:
-        """Get the run ID for each run in the collection."""
-        return [run.info.run_id for run in self._runs]
-
-    @property
-    def artifact_uri(self) -> list[str | None]:
-        """Get the artifact URI for each run in the collection."""
-        return [run.info.artifact_uri for run in self._runs]
-
-    @property
-    def artifact_dir(self) -> list[Path]:
-        """Get the artifact directory for each run in the collection."""
-        return [get_artifact_dir(run) for run in self._runs]
-
 
 def get_artifact_dir(run: Run | None = None) -> Path:
     """Retrieve the artifact directory for the given run.
@@ -89,3 +66,23 @@ 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.3.0 → hydraflow-0.3.1}/tests/scripts/app.py

@@ -27,6 +27,9 @@ cs.store(name="config", node=MySQLConfig)
 
 @hydra.main(version_base=None, config_name="config")
 def app(cfg: MySQLConfig):
+    with hydraflow.chdir_hydra() as path:
+        Path("chdir_hydra.txt").write_text(path.as_posix())
+
     hydraflow.set_experiment(prefix="_", suffix="_")
     with hydraflow.start_run(cfg):
         log.info(f"START, {cfg.host}, {cfg.port} ")
@@ -34,6 +37,8 @@ def app(cfg: MySQLConfig):
         artifact_dir = hydraflow.get_artifact_dir()
         output_dir = hydraflow.get_hydra_output_dir()
 
+        assert (output_dir / "chdir_hydra.txt").exists()
+
         mlflow.log_text("A " + artifact_dir.as_posix(), "artifact_dir.txt")
         mlflow.log_text("B " + output_dir.as_posix(), "output_dir.txt")
 

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

@@ -8,7 +8,7 @@ from typing import TYPE_CHECKING
 import mlflow
 import pytest
 from mlflow.entities import RunStatus
-from omegaconf import OmegaConf
+from omegaconf import ListConfig, OmegaConf
 
 if TYPE_CHECKING:
     from omegaconf import DictConfig
@@ -114,6 +114,13 @@ def test_app_data_config(rc: RunCollection):
     assert config[3].host == "y"
 
 
+def test_app_data_config_list(rc: RunCollection):
+    config = rc.data.config
+    assert isinstance(config[0]["values"], ListConfig)
+    assert not isinstance(config[0]["values"], list)
+    assert config[0]["values"] == [1, 2, 3]
+
+
 def test_app_info_artifact_uri(rc: RunCollection):
     uris = rc.info.artifact_uri
     assert all(uri.startswith("file://") for uri in uris)  # type: ignore
@@ -122,14 +129,14 @@ def test_app_info_artifact_uri(rc: RunCollection):
 
 
 def test_app_info_artifact_dir(rc: RunCollection):
-    from hydraflow.run_info import get_artifact_dir
+    from hydraflow.utils 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.run_info import get_hydra_output_dir
+    from hydraflow.utils import get_hydra_output_dir
 
     dirs = list(rc.map(get_hydra_output_dir))
     assert dirs[0].stem == "0"
@@ -178,3 +185,10 @@ def test_config(rc: RunCollection):
     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]
+    assert str(df.select("values").dtypes) == "[List(Int64)]"
+    assert df.select("values").to_series().to_list() == [
+        [1, 2, 3],
+        [1, 2, 3],
+        [1, 2, 3],
+        [1, 2, 3],
+    ]

hydraflow-0.3.0/src/hydraflow/run_data.py

@@ -1,56 +0,0 @@
-"""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