hydraflow 0.5.3__py3-none-any.whl → 0.5.4__py3-none-any.whl

hydraflow/config.py

@@ -22,7 +22,6 @@ def collect_params(config: object) -> dict[str, Any]:
 
     Returns:
         dict[str, Any]: A dictionary of collected parameters.
-
     """
     return dict(iter_params(config))
 
@@ -41,7 +40,6 @@ def iter_params(config: object, prefix: str = "") -> Iterator[tuple[str, Any]]:
 
     Yields:
         Key-value pairs representing the parameters in the configuration object.
-
     """
     if config is None:
         return
@@ -115,7 +113,6 @@ def select_config(config: object, names: list[str]) -> dict[str, Any]:
 
     Returns:
         DictConfig: A new configuration object containing only the selected parameters.
-
     """
     if not isinstance(config, DictConfig):
         config = OmegaConf.structured(config)

hydraflow/context.py

@@ -48,7 +48,6 @@ def log_run(
             # Perform operations within the MLflow run context
             pass
         ```
-
     """
     if config:
         log_params(config, synchronous=synchronous)
@@ -118,7 +117,6 @@ def start_run(  # noqa: PLR0913
         - `mlflow.start_run`: The MLflow function to start a run directly.
         - `log_run`: A context manager to log parameters and manage the MLflow
            run context.
-
     """
     with (
         mlflow.start_run(
@@ -169,7 +167,6 @@ def chdir_artifact(
     Args:
         run (Run): The run to get the artifact directory from.
         artifact_path (str | None): The artifact path.
-
     """
     curdir = Path.cwd()
     path = mlflow.artifacts.download_artifacts(

hydraflow/mlflow.py

@@ -54,7 +54,6 @@ def set_experiment(
     Returns:
         Experiment: An instance of `mlflow.entities.Experiment` representing
         the new active experiment.
-
     """
     if uri is not None:
         mlflow.set_tracking_uri(uri)
@@ -78,7 +77,6 @@ def log_params(config: object, *, synchronous: bool | None = None) -> None:
         config (object): The configuration object to log the parameters from.
         synchronous (bool | None): Whether to log the parameters synchronously.
             Defaults to None.
-
     """
     for key, value in iter_params(config):
         mlflow.log_param(key, value, synchronous=synchronous)
@@ -135,7 +133,6 @@ def search_runs(  # noqa: PLR0913
 
     Returns:
         A `RunCollection` object containing the search results.
-
     """
     runs = mlflow.search_runs(
         experiment_ids=experiment_ids,
@@ -180,7 +177,6 @@ def list_runs(
     Returns:
         RunCollection: A `RunCollection` instance containing the runs for the
         specified experiments.
-
     """
     rc = _list_runs(experiment_names, n_jobs)
     if status is None:

hydraflow/param.py

@@ -18,7 +18,7 @@ if TYPE_CHECKING:
     from mlflow.entities import Run
 
 
-def match(param: str, value: Any) -> bool:
+def match(param: str, value: Any) -> bool:  # noqa: PLR0911
     """Check if the string matches the specified value.
 
     Args:
@@ -28,8 +28,10 @@ def match(param: str, value: Any) -> bool:
     Returns:
         True if the parameter matches the specified value,
         False otherwise.
-
     """
+    if callable(value):
+        return value(param)
+
     if any(value is x for x in [None, True, False]):
         return param == str(value)
 
@@ -92,7 +94,6 @@ def to_value(param: str | None, type_: type) -> Any:
 
     Returns:
         The converted value.
-
     """
     if param is None or param == "None":
         return None
@@ -128,7 +129,6 @@ def get_params(run: Run, *names: str | list[str]) -> tuple[str | None, ...]:
     Returns:
         tuple[str | None, ...]: A tuple containing the values of the specified
         parameters in the order they were provided.
-
     """
     names_ = []
     for name in names:
@@ -155,7 +155,6 @@ def get_values(run: Run, names: list[str], types: list[type]) -> tuple[Any, ...]
     Returns:
         tuple[Any, ...]: A tuple containing the values of the specified
         parameters in the order they were provided.
-
     """
     params = get_params(run, names)
     it = zip(params, types, strict=True)

hydraflow/run_collection.py

@@ -106,7 +106,6 @@ class RunCollection:
 
         Returns:
             A new `RunCollection` instance with the runs from both collections.
-
         """
         return self.__class__(self._runs + other._runs)
 
@@ -119,7 +118,6 @@ class RunCollection:
         Returns:
             A new `RunCollection` instance with the runs that are in this collection
             but not in the other.
-
         """
         runs = [run for run in self._runs if run not in other._runs]  # noqa: SLF001
         return self.__class__(runs)
@@ -152,7 +150,6 @@ class RunCollection:
         Returns:
             A new `RunCollection` instance containing the first n runs if n is
             positive, or the last n runs if n is negative.
-
         """
         if n < 0:
             return self.__class__(self._runs[n:])
@@ -167,7 +164,6 @@ class RunCollection:
 
         Raises:
             ValueError: If the collection does not contain exactly one run.
-
         """
         if len(self._runs) != 1:
             raise ValueError("The collection does not contain exactly one run.")
@@ -180,7 +176,6 @@ class RunCollection:
         Returns:
             The only `Run` instance in the collection, or None if the collection
             does not contain exactly one run.
-
         """
         return self._runs[0] if len(self._runs) == 1 else None
 
@@ -192,7 +187,6 @@ class RunCollection:
 
         Raises:
             ValueError: If the collection is empty.
-
         """
         if not self._runs:
             raise ValueError("The collection is empty.")
@@ -205,7 +199,6 @@ class RunCollection:
         Returns:
             The first `Run` instance in the collection, or None if the collection
             is empty.
-
         """
         return self._runs[0] if self._runs else None
 
@@ -217,7 +210,6 @@ class RunCollection:
 
         Raises:
             ValueError: If the collection is empty.
-
         """
         if not self._runs:
             raise ValueError("The collection is empty.")
@@ -230,11 +222,18 @@ class RunCollection:
         Returns:
             The last `Run` instance in the collection, or None if the collection
             is empty.
-
         """
         return self._runs[-1] if self._runs else None
 
-    def filter(self, config: object | None = None, **kwargs) -> RunCollection:
+    def filter(
+        self,
+        config: object | None = None,
+        *,
+        override: bool = False,
+        select: list[str] | None = None,
+        status: str | list[str] | int | list[int] | None = None,
+        **kwargs,
+    ) -> RunCollection:
         """Filter the `Run` instances based on the provided configuration.
 
         This method filters the runs in the collection according to the
@@ -254,13 +253,26 @@ class RunCollection:
             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.
+            override (bool): If True, override the configuration object with the
+                provided key-value pairs.
+            select (list[str] | None): The list of parameters to select.
+            status (str | list[str] | int | list[int] | None): The status of the
+                runs to filter.
             **kwargs: Additional key-value pairs to filter the runs.
 
         Returns:
             A new `RunCollection` object containing the filtered runs.
-
         """
-        return RunCollection(filter_runs(self._runs, config, **kwargs))
+        return RunCollection(
+            filter_runs(
+                self._runs,
+                config,
+                override=override,
+                select=select,
+                status=status,
+                **kwargs,
+            ),
+        )
 
     def find(self, config: object | None = None, **kwargs) -> Run:
         """Find the first `Run` instance based on the provided configuration.
@@ -282,7 +294,6 @@ class RunCollection:
 
         See Also:
             `filter`: Perform the actual filtering logic.
-
         """
         try:
             return self.filter(config, **kwargs).first()
@@ -307,7 +318,6 @@ class RunCollection:
 
         See Also:
             `filter`: Perform the actual filtering logic.
-
         """
         return self.filter(config, **kwargs).try_first()
 
@@ -331,7 +341,6 @@ class RunCollection:
 
         See Also:
             `filter`: Perform the actual filtering logic.
-
         """
         try:
             return self.filter(config, **kwargs).last()
@@ -356,7 +365,6 @@ class RunCollection:
 
         See Also:
             `filter`: Perform the actual filtering logic.
-
         """
         return self.filter(config, **kwargs).try_last()
 
@@ -381,7 +389,6 @@ class RunCollection:
 
         See Also:
             `filter`: Perform the actual filtering logic.
-
         """
         try:
             return self.filter(config, **kwargs).one()
@@ -410,7 +417,6 @@ class RunCollection:
 
         See Also:
             `filter`: Perform the actual filtering logic.
-
         """
         return self.filter(config, **kwargs).try_one()
 
@@ -423,7 +429,6 @@ class RunCollection:
 
         Returns:
             A list of unique parameter names.
-
         """
         param_names = set()
 
@@ -448,7 +453,6 @@ class RunCollection:
         Returns:
             A dictionary where the keys are parameter names and the values are
             lists of parameter values.
-
         """
         params = {}
 
@@ -480,7 +484,6 @@ class RunCollection:
 
         Yields:
             Results obtained by applying the function to each run in the collection.
-
         """
         return (func(run, *args, **kwargs) for run in self)
 
@@ -501,7 +504,6 @@ class RunCollection:
         Yields:
             Results obtained by applying the function to each run id in the
             collection.
-
         """
         return (func(run_id, *args, **kwargs) for run_id in self.info.run_id)
 
@@ -522,7 +524,6 @@ class RunCollection:
         Yields:
             Results obtained by applying the function to each run configuration
             in the collection.
-
         """
         return (func(load_config(run), *args, **kwargs) for run in self)
 
@@ -547,7 +548,6 @@ class RunCollection:
         Yields:
             Results obtained by applying the function to each artifact URI in the
             collection.
-
         """
         return (func(uri, *args, **kwargs) for uri in self.info.artifact_uri)
 
@@ -571,7 +571,6 @@ class RunCollection:
         Yields:
             Results obtained by applying the function to each artifact directory
             in the collection.
-
         """
         return (func(dir, *args, **kwargs) for dir in self.info.artifact_dir)  # noqa: A001
 
@@ -595,7 +594,6 @@ class RunCollection:
             dictionary where the keys are tuples of parameter values and the
             values are `RunCollection` objects containing the runs that match
             those parameter values.
-
         """
         grouped_runs: dict[str | None | tuple[str | None, ...], list[Run]] = {}
         is_list = isinstance(names, list)
@@ -622,7 +620,6 @@ class RunCollection:
             key (Callable[[Run], Any] | None): A function that takes a run and returns
                 a value to sort by.
             reverse (bool): If True, sort in descending order.
-
         """
         self._runs.sort(key=key or (lambda x: x.info.start_time), reverse=reverse)
 
@@ -636,7 +633,6 @@ class RunCollection:
 
         Returns:
             A list of values for the specified parameters.
-
         """
         is_list = isinstance(names, list)
 
@@ -668,7 +664,6 @@ class RunCollection:
                 This can be a single parameter name or multiple names provided
                 as separate arguments or as a list.
             reverse (bool): If True, sort in descending order.
-
         """
         values = self.values(names)
         index = sorted(range(len(self)), key=lambda i: values[i], reverse=reverse)
@@ -726,7 +721,6 @@ def filter_runs(
 
     Returns:
         A list of runs that match the specified configuration and key-value pairs.
-
     """
     if override:
         config = select_overrides(config)
@@ -757,7 +751,6 @@ def filter_runs_by_status(
 
     Returns:
         A list of runs that match the specified status.
-
     """
     if isinstance(status, str):
         if status.startswith("!"):

hydraflow/run_data.py

@@ -37,7 +37,6 @@ class RunCollectionData:
 
         Returns:
             A DataFrame containing the runs' configurations.
-
         """
         return DataFrame(self._runs.map_config(collect_params))
 

hydraflow/utils.py

@@ -26,7 +26,6 @@ def get_artifact_dir(run: Run | None = None) -> Path:
 
     Returns:
         The local path to the directory where the artifacts are downloaded.
-
     """
     uri = mlflow.get_artifact_uri() if run is None else run.info.artifact_uri
 
@@ -53,7 +52,6 @@ def get_artifact_path(run: Run | None, path: str) -> Path:
 
     Returns:
         The local path to the artifact.
-
     """
     return get_artifact_dir(run) / path
 
@@ -76,7 +74,6 @@ def get_hydra_output_dir(run: Run | None = None) -> Path:
     Raises:
         FileNotFoundError: If the Hydra configuration file is not found
             in the artifacts.
-
     """
     if run is None:
         hc = HydraConfig.get()
@@ -105,7 +102,6 @@ def load_config(run: Run) -> DictConfig:
     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
@@ -130,7 +126,6 @@ def load_overrides(run: Run) -> list[str]:
     Returns:
         The loaded overrides as a list of strings. Returns an empty list
         if the overrides file is not found.
-
     """
     path = get_artifact_dir(run) / ".hydra/overrides.yaml"
     return [str(x) for x in OmegaConf.load(path)]

{hydraflow-0.5.3.dist-info → hydraflow-0.5.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hydraflow
-Version: 0.5.3
+Version: 0.5.4
 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.5.4.dist-info/RECORD

@@ -0,0 +1,14 @@
+hydraflow/__init__.py,sha256=9XO9FD3uiTTPN6X6UAC9FtkJjEqUQZNqpoAmSrjUHfI,855
+hydraflow/config.py,sha256=k6pwneDoC4mb7cVkafMfITn8QemICPnFbhIRGLsmF4w,4323
+hydraflow/context.py,sha256=KukvVexCF32myBOryYMVhINknbAgPFcanmr4cT2EXog,5521
+hydraflow/mlflow.py,sha256=TVp6O9rYNYcdqnlssstXQlI_P_N6inUG-F01X6uJNv4,8928
+hydraflow/param.py,sha256=kuVlxEfgoKL35rNu49M-PkdNr41djK0YZ5IO7fHTSSU,4568
+hydraflow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hydraflow/run_collection.py,sha256=mMGpr6cAh9Bf2SeRsYNHySOQJNrWNMI7esDWzyMxnJg,27415
+hydraflow/run_data.py,sha256=V_yhkBsJlDTkLbh1TShkvDxUQYUYTpXFahXJGfdmgro,1524
+hydraflow/run_info.py,sha256=Jf5wrIjRLIV1-k-obHDqwKHa6j_ZonrY8od-rXlbtMo,1024
+hydraflow/utils.py,sha256=ha-gSq3TkWWOlKmnDuyLNCuKNQdEG08CXRzKtb3C4mk,4344
+hydraflow-0.5.4.dist-info/METADATA,sha256=ijJv5powqpMjZ1adDCWdLxRLeEaosmKF3gG74L25fCs,4700
+hydraflow-0.5.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+hydraflow-0.5.4.dist-info/licenses/LICENSE,sha256=IGdDrBPqz1O0v_UwCW-NJlbX9Hy9b3uJ11t28y2srmY,1062
+hydraflow-0.5.4.dist-info/RECORD,,

hydraflow-0.5.3.dist-info/RECORD

@@ -1,14 +0,0 @@
-hydraflow/__init__.py,sha256=9XO9FD3uiTTPN6X6UAC9FtkJjEqUQZNqpoAmSrjUHfI,855
-hydraflow/config.py,sha256=MNX9da5bPVDcjnpji7Cm9ndK6ura92pt361m4PRh6_E,4326
-hydraflow/context.py,sha256=3g7OQXWcFvK6PVVbXpQg7Hr8nsJkF9pLFrXNi_3aV5A,5524
-hydraflow/mlflow.py,sha256=h2S_A2wElr_1lAq0D1wkoEfdtDZpPuWFNRcO8mV_VrA,8932
-hydraflow/param.py,sha256=c5sc6NwD6DKwZzVwprXzZD5FSi6qRgSHkc6TXBKQEdg,4502
-hydraflow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hydraflow/run_collection.py,sha256=zPrlKwLuzqePj57pXbgKWrE03S_kjxTaxY9trItf6Gc,26772
-hydraflow/run_data.py,sha256=dpyyfnuH9mCtIZeigMo1iFQo9bafMdEL4i4uI2l0UqY,1525
-hydraflow/run_info.py,sha256=Jf5wrIjRLIV1-k-obHDqwKHa6j_ZonrY8od-rXlbtMo,1024
-hydraflow/utils.py,sha256=oXjcyfQBbPzJNTh3_CbZfl23zgJS-mbNM9GAWBwsn8c,4349
-hydraflow-0.5.3.dist-info/METADATA,sha256=8grWqDq2SBXtVljA72NnKJPJjwaWmjOOXIvGSOP5kqM,4700
-hydraflow-0.5.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-hydraflow-0.5.3.dist-info/licenses/LICENSE,sha256=IGdDrBPqz1O0v_UwCW-NJlbX9Hy9b3uJ11t28y2srmY,1062
-hydraflow-0.5.3.dist-info/RECORD,,