hydraflow 0.6.2__py3-none-any.whl → 0.7.2__py3-none-any.whl

hydraflow/__init__.py

@@ -1,10 +1,11 @@
 """Integrate Hydra and MLflow to manage and track machine learning experiments."""
 
-from .config import select_config, select_overrides
-from .context import chdir_artifact, log_run, start_run
-from .mlflow import list_runs, search_runs, set_experiment
-from .run_collection import RunCollection
-from .utils import (
+from hydraflow.config import select_config, select_overrides
+from hydraflow.context import chdir_artifact, log_run, start_run
+from hydraflow.main import main
+from hydraflow.mlflow import list_runs, search_runs, set_experiment
+from hydraflow.run_collection import RunCollection
+from hydraflow.utils import (
     get_artifact_dir,
     get_artifact_path,
     get_hydra_output_dir,
@@ -25,6 +26,7 @@ __all__ = [
     "load_config",
     "load_overrides",
     "log_run",
+    "main",
     "remove_run",
     "search_runs",
     "select_config",

hydraflow/main.py

@@ -0,0 +1,55 @@
+"""main decorator."""
+
+from __future__ import annotations
+
+from functools import wraps
+from typing import TYPE_CHECKING, Any
+
+import hydra
+from hydra.core.config_store import ConfigStore
+from mlflow.entities import RunStatus
+
+import hydraflow
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+    from mlflow.entities import Run
+
+FINISHED = RunStatus.to_string(RunStatus.FINISHED)
+
+
+def main(
+    node: Any,
+    config_name: str = "config",
+    *,
+    chdir: bool = True,
+    skip_finished: bool = True,
+    force_new_run: bool = False,
+    override: bool = True,
+):
+    """Main decorator."""
+
+    def decorator(app: Callable[[Run, Any], None]) -> Callable[[], None]:
+        ConfigStore.instance().store(name=config_name, node=node)
+
+        @wraps(app)
+        @hydra.main(version_base=None, config_name=config_name)
+        def inner_app(cfg: object) -> None:
+            hydraflow.set_experiment()
+
+            if force_new_run:
+                run = None
+            else:
+                rc = hydraflow.search_runs()
+                run = rc.try_get(cfg, override=override)
+
+                if skip_finished and run and run.info.status == FINISHED:
+                    return
+
+            with hydraflow.start_run(cfg, run=run, chdir=chdir) as run:
+                app(run, cfg)
+
+        return inner_app
+
+    return decorator

hydraflow/run_collection.py

@@ -286,105 +286,11 @@ class RunCollection:
             ),
         )
 
-    def find(self, config: object | None = None, **kwargs) -> Run:
-        """Find the first `Run` instance based on the provided configuration.
-
-        This method filters the runs in the collection according to the
-        specified configuration object and returns the first run that matches
-        the provided parameters. If no run matches the criteria, a `ValueError`
-        is raised.
-
-        Args:
-            config (object | None): The configuration object to identify the run.
-            **kwargs: Additional key-value pairs to filter the runs.
-
-        Returns:
-            The first `Run` instance that matches the provided configuration.
-
-        Raises:
-            ValueError: If no run matches the criteria.
-
-        See Also:
-            `filter`: Perform the actual filtering logic.
-
-        """
-        try:
-            return self.filter(config, **kwargs).first()
-        except ValueError:
-            raise ValueError("No run matches the provided configuration.")
-
-    def try_find(self, config: object | None = None, **kwargs) -> Run | None:
-        """Try to find the first `Run` instance based on the provided configuration.
-
-        This method filters the runs in the collection according to the
-        specified configuration object and returns the first run that matches
-        the provided parameters. If no run matches the criteria, None is
-        returned.
-
-        Args:
-            config (object | None): The configuration object to identify the run.
-            **kwargs: Additional key-value pairs to filter the runs.
-
-        Returns:
-            The first `Run` instance that matches the provided configuration, or
-            None if no runs match the criteria.
-
-        See Also:
-            `filter`: Perform the actual filtering logic.
-
-        """
-        return self.filter(config, **kwargs).try_first()
-
-    def find_last(self, config: object | None = None, **kwargs) -> Run:
-        """Find the last `Run` instance based on the provided configuration.
-
-        This method filters the runs in the collection according to the
-        specified configuration object and returns the last run that matches
-        the provided parameters. If no run matches the criteria, a `ValueError`
-        is raised.
-
-        Args:
-            config (object | None): The configuration object to identify the run.
-            **kwargs: Additional key-value pairs to filter the runs.
-
-        Returns:
-            The last `Run` instance that matches the provided configuration.
-
-        Raises:
-            ValueError: If no run matches the criteria.
-
-        See Also:
-            `filter`: Perform the actual filtering logic.
-
-        """
-        try:
-            return self.filter(config, **kwargs).last()
-        except ValueError:
-            raise ValueError("No run matches the provided configuration.")
-
-    def try_find_last(self, config: object | None = None, **kwargs) -> Run | None:
-        """Try to find the last `Run` instance based on the provided configuration.
-
-        This method filters the runs in the collection according to the
-        specified configuration object and returns the last run that matches
-        the provided parameters. If no run matches the criteria, None is
-        returned.
-
-        Args:
-            config (object | None): The configuration object to identify the run.
-            **kwargs: Additional key-value pairs to filter the runs.
-
-        Returns:
-            The last `Run` instance that matches the provided configuration, or
-            None if no runs match the criteria.
-
-        See Also:
-            `filter`: Perform the actual filtering logic.
-
-        """
-        return self.filter(config, **kwargs).try_last()
-
-    def get(self, config: object | None = None, **kwargs) -> Run:
+    def get(
+        self,
+        config: object | Callable[[Run], bool] | None = None,
+        **kwargs,
+    ) -> Run:
         """Retrieve a specific `Run` instance based on the provided configuration.
 
         This method filters the runs in the collection according to the
@@ -393,7 +299,10 @@ class RunCollection:
         one run matches the criteria, a `ValueError` is raised.
 
         Args:
-            config (object | None): The configuration object to identify the run.
+            config (object | Callable[[Run], bool] | None): The configuration object
+                to identify the run. This can be any object that provides key-value
+                pairs through the `iter_params` function, or a callable that
+                takes a `Run` object and returns a boolean value.
             **kwargs: Additional key-value pairs to filter the runs.
 
         Returns:
@@ -413,7 +322,11 @@ class RunCollection:
             msg = "The filtered collection does not contain exactly one run."
             raise ValueError(msg)
 
-    def try_get(self, config: object | None = None, **kwargs) -> Run | None:
+    def try_get(
+        self,
+        config: object | Callable[[Run], bool] | None = None,
+        **kwargs,
+    ) -> Run | None:
         """Try to get a specific `Run` instance based on the provided configuration.
 
         This method filters the runs in the collection according to the
@@ -422,7 +335,10 @@ class RunCollection:
         If more than one run matches the criteria, a `ValueError` is raised.
 
         Args:
-            config (object | None): The configuration object to identify the run.
+            config (object | Callable[[Run], bool] | None): The configuration object
+                to identify the run. This can be any object that provides key-value
+                pairs through the `iter_params` function, or a callable that
+                takes a `Run` object and returns a boolean value.
             **kwargs: Additional key-value pairs to filter the runs.
 
         Returns:

{hydraflow-0.6.2.dist-info → hydraflow-0.7.2.dist-info}/METADATA

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

{hydraflow-0.6.2.dist-info → hydraflow-0.7.2.dist-info}/RECORD

@@ -1,14 +1,15 @@
-hydraflow/__init__.py,sha256=VPIPNNCyjMAkWBbdvB7Ltwe3QWoc2FwuqkV8uJM5JoM,809
+hydraflow/__init__.py,sha256=rujOGabEPPhPfyqTHynem3unqIEQ1haTWWSMuu2LuoQ,898
 hydraflow/config.py,sha256=MNX9da5bPVDcjnpji7Cm9ndK6ura92pt361m4PRh6_E,4326
 hydraflow/context.py,sha256=3xfKhMozkKFqtWeOp9Gie0A5o5URMta4US6iVD5TcLU,6002
+hydraflow/main.py,sha256=8DYYxyyS1sToEIoIQlzGcGDNgzIFg3fLnjBufQtQASc,1344
 hydraflow/mlflow.py,sha256=imD3XL0RTlpnKrkyvO8FNy_Bv6hwSfLiOu1yJuL40ck,8773
 hydraflow/param.py,sha256=yu1aMNXRLegXGDL-68vwIkfeDF9CaU784WZENGLwl7Q,4572
 hydraflow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hydraflow/run_collection.py,sha256=w_GZdc_6yviwzRWLndWDSWB4DKyGyA9di9d9UpkkLZo,27926
+hydraflow/run_collection.py,sha256=YCWg5Dz1j49xB2LA75onq5wsAeQQbifXpG4yPUwRN4I,24776
 hydraflow/run_data.py,sha256=dpyyfnuH9mCtIZeigMo1iFQo9bafMdEL4i4uI2l0UqY,1525
 hydraflow/run_info.py,sha256=Jf5wrIjRLIV1-k-obHDqwKHa6j_ZonrY8od-rXlbtMo,1024
 hydraflow/utils.py,sha256=a9i5PEJn8Ssowv9dqHadAihZXlsqtVjHZ9MZvkPq1bY,4747
-hydraflow-0.6.2.dist-info/METADATA,sha256=9a3blsQ91rNP1Ql4kFDc7tZxDMbdK5PzEAfP9ZyUY6A,4700
-hydraflow-0.6.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-hydraflow-0.6.2.dist-info/licenses/LICENSE,sha256=IGdDrBPqz1O0v_UwCW-NJlbX9Hy9b3uJ11t28y2srmY,1062
-hydraflow-0.6.2.dist-info/RECORD,,
+hydraflow-0.7.2.dist-info/METADATA,sha256=TJfrv_OjNiZskkog8UFmJI9wXjatNBKFTovPdMjnbK8,4700
+hydraflow-0.7.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+hydraflow-0.7.2.dist-info/licenses/LICENSE,sha256=IGdDrBPqz1O0v_UwCW-NJlbX9Hy9b3uJ11t28y2srmY,1062
+hydraflow-0.7.2.dist-info/RECORD,,