hydraflow 0.6.1__py3-none-any.whl → 0.7.0__py3-none-any.whl

hydraflow/run_collection.py

@@ -236,7 +236,7 @@ class RunCollection:
 
     def filter(
         self,
-        config: object | None = None,
+        config: object | Callable[[Run], bool] | None = None,
         *,
         override: bool = False,
         select: list[str] | None = None,
@@ -257,11 +257,13 @@ class RunCollection:
         - Membership checks for lists of values.
         - Range checks for tuples of two values (inclusive of both the lower
           and upper bound).
+        - Callable that takes a `Run` object and returns a boolean value.
 
         Args:
-            config (object | None): The configuration object to filter the runs.
-                This can be any object that provides key-value pairs through
-                the `iter_params` function.
+            config (object | Callable[[Run], bool] | None): The configuration object
+                to filter the runs. 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.
             override (bool): If True, override the configuration object with the
                 provided key-value pairs.
             select (list[str] | None): The list of parameters to select.
@@ -284,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
@@ -391,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:
@@ -411,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
@@ -420,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:
@@ -711,7 +629,7 @@ def _param_matches(run: Run, key: str, value: Any) -> bool:
 
 def filter_runs(
     runs: list[Run],
-    config: object | None = None,
+    config: object | Callable[[Run], bool] | None = None,
     *,
     override: bool = False,
     select: list[str] | None = None,
@@ -735,9 +653,11 @@ def filter_runs(
 
     Args:
         runs (list[Run]): The list of runs to filter.
-        config (object | None, optional): The configuration object to filter the
-            runs. This can be any object that provides key-value pairs through
-            the `iter_params` function. Defaults to None.
+        config (object | Callable[[Run], bool] | None, optional): The
+            configuration object to filter the runs. This can be any object
+            that provides key-value pairs through the `iter_params` function.
+            This can also be a callable that takes a `Run` object and returns
+            a boolean value. Defaults to None.
         override (bool, optional): If True, filter the runs based on
             the overrides. Defaults to False.
         select (list[str] | None, optional): The list of parameters to select.
@@ -750,15 +670,19 @@ def filter_runs(
         A list of runs that match the specified configuration and key-value pairs.
 
     """
-    if override:
-        config = select_overrides(config)
-    elif select:
-        config = select_config(config, select)
-
-    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 callable(config):
+        runs = [run for run in runs if config(run)]
+
+    else:
+        if override:
+            config = select_overrides(config)
+        elif select:
+            config = select_config(config, select)
+
+        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 status is None:
         return runs

{hydraflow-0.6.1.dist-info → hydraflow-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hydraflow
-Version: 0.6.1
+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.1.dist-info → hydraflow-0.7.0.dist-info}/RECORD

@@ -4,11 +4,11 @@ hydraflow/context.py,sha256=3xfKhMozkKFqtWeOp9Gie0A5o5URMta4US6iVD5TcLU,6002
 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=2GRVOy87_2SPjHuCzzUvRNugO_grtFUVjtTfhznwBAc,27444
+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.1.dist-info/METADATA,sha256=FzLPE3L9VlZdrYOicnzTda7BhHuLTU0-WRz02TLgt6c,4700
-hydraflow-0.6.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-hydraflow-0.6.1.dist-info/licenses/LICENSE,sha256=IGdDrBPqz1O0v_UwCW-NJlbX9Hy9b3uJ11t28y2srmY,1062
-hydraflow-0.6.1.dist-info/RECORD,,
+hydraflow-0.7.0.dist-info/METADATA,sha256=hfKlxd1X1BKemmK_ph-ylWe4JaBCSw5SnXxK4MIKBN0,4700
+hydraflow-0.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+hydraflow-0.7.0.dist-info/licenses/LICENSE,sha256=IGdDrBPqz1O0v_UwCW-NJlbX9Hy9b3uJ11t28y2srmY,1062
+hydraflow-0.7.0.dist-info/RECORD,,