hydraflow 0.6.2__tar.gz → 0.7.0__tar.gz

{hydraflow-0.6.2 → hydraflow-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hydraflow
-Version: 0.6.2
+Version: 0.7.0
 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 → hydraflow-0.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "hydraflow"
-version = "0.6.2"
+version = "0.7.0"
 description = "Hydraflow integrates Hydra and MLflow to manage and track machine learning experiments."
 readme = "README.md"
 license = { file = "LICENSE" }

{hydraflow-0.6.2 → hydraflow-0.7.0}/src/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 → hydraflow-0.7.0}/tests/context/preemption.py

@@ -24,17 +24,12 @@ ConfigStore.instance().store(name="config", node=Config)
 def app(cfg: Config):
     hydraflow.set_experiment()
 
-    rc = hydraflow.list_runs()
+    rc = hydraflow.list_runs().filter(cfg, override=True)
 
-    if rc.filter(cfg, status="finished", override=True):
+    if rc.filter(status="finished"):
         return
 
-    if run := rc.try_find(cfg, override=True):
-        run_id = run.info.run_id
-    else:
-        run_id = None
-
-    with hydraflow.start_run(cfg, run_id=run_id) as run:
+    with hydraflow.start_run(cfg, run=rc.try_one()) as run:
         log(hydraflow.get_artifact_dir(run))
 
 

{hydraflow-0.6.2 → hydraflow-0.7.0}/tests/context/rerun.py

@@ -24,7 +24,7 @@ ConfigStore.instance().store(name="config", node=Config)
 def app(cfg: Config):
     hydraflow.set_experiment()
 
-    run = hydraflow.list_runs().try_find(cfg, override=True)
+    run = hydraflow.list_runs().try_get(cfg, override=True)
 
     with hydraflow.start_run(cfg, run=run) as run:
         log(hydraflow.get_artifact_dir(run))

{hydraflow-0.6.2 → hydraflow-0.7.0}/tests/run/test_collection.py

@@ -332,44 +332,6 @@ def test_get_param_dict_drop_const(rc: RunCollection):
     assert "r" in params
 
 
-def test_find_dict(rc: RunCollection):
-    run = rc.find({"r": 0})
-    assert run.data.params["p"] == "0"
-
-
-def test_find_kwarg(rc: RunCollection):
-    run = rc.find(r=2)
-    assert run.data.params["p"] == "2"
-
-
-def test_find_none(rc: RunCollection):
-    with pytest.raises(ValueError):
-        rc.find({"r": 10})
-
-
-def test_try_find_none(rc: RunCollection):
-    assert rc.try_find({"r": 10}) is None
-
-
-def test_find_last_dict(rc: RunCollection):
-    run = rc.find_last({"r": 0})
-    assert run.data.params["p"] == "3"
-
-
-def test_find_last_kwarg(rc: RunCollection):
-    run = rc.find_last(r=2)
-    assert run.data.params["p"] == "5"
-
-
-def test_find_last_none(rc: RunCollection):
-    with pytest.raises(ValueError):
-        rc.find_last({"p": 10})
-
-
-def test_try_find_last_none(rc: RunCollection):
-    assert rc.try_find_last({"p": 10}) is None
-
-
 @pytest.mark.parametrize("n_jobs", [0, 1, 2])
 def test_list_runs(rc: RunCollection, n_jobs: int):
     assert len(list_runs(n_jobs=n_jobs)) == 6