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

hydraflow/config.py

@@ -22,6 +22,7 @@ def collect_params(config: object) -> dict[str, Any]:
 
     Returns:
         dict[str, Any]: A dictionary of collected parameters.
+
     """
     return dict(iter_params(config))
 
@@ -40,6 +41,7 @@ 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
@@ -113,6 +115,7 @@ 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,6 +48,7 @@ def log_run(
             # Perform operations within the MLflow run context
             pass
         ```
+
     """
     if config:
         log_params(config, synchronous=synchronous)
@@ -55,7 +56,7 @@ def log_run(
     hc = HydraConfig.get()
     output_dir = Path(hc.runtime.output_dir)
 
-    # Save '.hydra' config directory first.
+    # Save '.hydra' config directory.
     output_subdir = output_dir / (hc.output_subdir or "")
     mlflow.log_artifacts(output_subdir.as_posix(), hc.output_subdir)
 
@@ -68,14 +69,41 @@ def log_run(
         raise
 
     finally:
-        # Save output_dir including '.hydra' config directory.
-        mlflow.log_artifacts(output_dir.as_posix())
+        log_hydra(output_dir)
+
+
+def log_hydra(output_dir: Path) -> None:
+    """Log hydra logs of the current run as artifacts.
+
+    Args:
+        output_dir (Path): The output directory of the Hydra job.
+
+    """
+    uri = mlflow.get_artifact_uri()
+    artifact_dir = Path(mlflow.artifacts.download_artifacts(uri))
+
+    for file_hydra in output_dir.glob("*.log"):
+        if not file_hydra.is_file():
+            continue
+
+        file_artifact = artifact_dir / file_hydra.name
+        if file_artifact.exists():
+            text = file_artifact.read_text()
+            if not text.endswith("\n"):
+                text += "\n"
+        else:
+            text = ""
+
+        text += file_hydra.read_text()
+        mlflow.log_text(text, file_hydra.name)
 
 
 @contextmanager
 def start_run(  # noqa: PLR0913
     config: object,
     *,
+    chdir: bool = False,
+    run: Run | None = None,
     run_id: str | None = None,
     experiment_id: str | None = None,
     run_name: str | None = None,
@@ -93,6 +121,9 @@ def start_run(  # noqa: PLR0913
 
     Args:
         config (object): The configuration object to log parameters from.
+        chdir (bool): Whether to change the current working directory to the
+            artifact directory of the current run. Defaults to False.
+        run (Run | None): The existing run. Defaults to None.
         run_id (str | None): The existing run ID. Defaults to None.
         experiment_id (str | None): The experiment ID. Defaults to None.
         run_name (str | None): The name of the run. Defaults to None.
@@ -117,7 +148,11 @@ 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.
+
     """
+    if run:
+        run_id = run.info.run_id
+
     with (
         mlflow.start_run(
             run_id=run_id,
@@ -131,7 +166,11 @@ def start_run(  # noqa: PLR0913
         ) as run,
         log_run(config if run_id is None else None, synchronous=synchronous),
     ):
-        yield run
+        if chdir:
+            with chdir_artifact(run):
+                yield run
+        else:
+            yield run
 
 
 @contextmanager
@@ -167,6 +206,7 @@ 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,6 +54,7 @@ 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)
@@ -77,6 +78,7 @@ 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)
@@ -133,6 +135,7 @@ def search_runs(  # noqa: PLR0913
 
     Returns:
         A `RunCollection` object containing the search results.
+
     """
     runs = mlflow.search_runs(
         experiment_ids=experiment_ids,
@@ -177,6 +180,7 @@ 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

@@ -28,6 +28,7 @@ def match(param: str, value: Any) -> bool:  # noqa: PLR0911
     Returns:
         True if the parameter matches the specified value,
         False otherwise.
+
     """
     if callable(value):
         return value(param)
@@ -94,6 +95,7 @@ def to_value(param: str | None, type_: type) -> Any:
 
     Returns:
         The converted value.
+
     """
     if param is None or param == "None":
         return None
@@ -129,6 +131,7 @@ 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,6 +158,7 @@ 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,6 +106,7 @@ class RunCollection:
 
         Returns:
             A new `RunCollection` instance with the runs from both collections.
+
         """
         return self.__class__(self._runs + other._runs)
 
@@ -118,6 +119,7 @@ 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)
@@ -150,6 +152,7 @@ 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:])
@@ -164,6 +167,7 @@ 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.")
@@ -176,6 +180,7 @@ 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
 
@@ -187,6 +192,7 @@ class RunCollection:
 
         Raises:
             ValueError: If the collection is empty.
+
         """
         if not self._runs:
             raise ValueError("The collection is empty.")
@@ -199,6 +205,7 @@ 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
 
@@ -210,6 +217,7 @@ class RunCollection:
 
         Raises:
             ValueError: If the collection is empty.
+
         """
         if not self._runs:
             raise ValueError("The collection is empty.")
@@ -222,6 +230,7 @@ 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
 
@@ -262,6 +271,7 @@ class RunCollection:
 
         Returns:
             A new `RunCollection` object containing the filtered runs.
+
         """
         return RunCollection(
             filter_runs(
@@ -294,6 +304,7 @@ class RunCollection:
 
         See Also:
             `filter`: Perform the actual filtering logic.
+
         """
         try:
             return self.filter(config, **kwargs).first()
@@ -318,6 +329,7 @@ class RunCollection:
 
         See Also:
             `filter`: Perform the actual filtering logic.
+
         """
         return self.filter(config, **kwargs).try_first()
 
@@ -341,6 +353,7 @@ class RunCollection:
 
         See Also:
             `filter`: Perform the actual filtering logic.
+
         """
         try:
             return self.filter(config, **kwargs).last()
@@ -365,6 +378,7 @@ class RunCollection:
 
         See Also:
             `filter`: Perform the actual filtering logic.
+
         """
         return self.filter(config, **kwargs).try_last()
 
@@ -389,6 +403,7 @@ class RunCollection:
 
         See Also:
             `filter`: Perform the actual filtering logic.
+
         """
         try:
             return self.filter(config, **kwargs).one()
@@ -417,6 +432,7 @@ class RunCollection:
 
         See Also:
             `filter`: Perform the actual filtering logic.
+
         """
         return self.filter(config, **kwargs).try_one()
 
@@ -429,6 +445,7 @@ class RunCollection:
 
         Returns:
             A list of unique parameter names.
+
         """
         param_names = set()
 
@@ -453,6 +470,7 @@ class RunCollection:
         Returns:
             A dictionary where the keys are parameter names and the values are
             lists of parameter values.
+
         """
         params = {}
 
@@ -484,6 +502,7 @@ class RunCollection:
 
         Yields:
             Results obtained by applying the function to each run in the collection.
+
         """
         return (func(run, *args, **kwargs) for run in self)
 
@@ -504,6 +523,7 @@ 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)
 
@@ -524,6 +544,7 @@ 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)
 
@@ -548,6 +569,7 @@ 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,6 +593,7 @@ 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
 
@@ -594,6 +617,7 @@ 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)
@@ -620,6 +644,7 @@ 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)
 
@@ -633,6 +658,7 @@ class RunCollection:
 
         Returns:
             A list of values for the specified parameters.
+
         """
         is_list = isinstance(names, list)
 
@@ -664,6 +690,7 @@ 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)
@@ -721,6 +748,7 @@ def filter_runs(
 
     Returns:
         A list of runs that match the specified configuration and key-value pairs.
+
     """
     if override:
         config = select_overrides(config)
@@ -751,6 +779,7 @@ 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,6 +37,7 @@ class RunCollectionData:
 
         Returns:
             A DataFrame containing the runs' configurations.
+
         """
         return DataFrame(self._runs.map_config(collect_params))
 

hydraflow/utils.py

@@ -26,6 +26,7 @@ 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
 
@@ -52,6 +53,7 @@ def get_artifact_path(run: Run | None, path: str) -> Path:
 
     Returns:
         The local path to the artifact.
+
     """
     return get_artifact_dir(run) / path
 
@@ -74,6 +76,7 @@ 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()
@@ -102,6 +105,7 @@ 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
@@ -126,6 +130,7 @@ 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.4.dist-info → hydraflow-0.6.0.dist-info}/METADATA

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

@@ -0,0 +1,14 @@
+hydraflow/__init__.py,sha256=9XO9FD3uiTTPN6X6UAC9FtkJjEqUQZNqpoAmSrjUHfI,855
+hydraflow/config.py,sha256=MNX9da5bPVDcjnpji7Cm9ndK6ura92pt361m4PRh6_E,4326
+hydraflow/context.py,sha256=rc43zvE2ueki0zEzorCMIthD9cho_PkbLLJYF9WgDqY,6562
+hydraflow/mlflow.py,sha256=h2S_A2wElr_1lAq0D1wkoEfdtDZpPuWFNRcO8mV_VrA,8932
+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_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.6.0.dist-info/METADATA,sha256=xUib1EsbG3Es5jFx0cSkF1QItfTuciBHYM1040GqFzA,4700
+hydraflow-0.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+hydraflow-0.6.0.dist-info/licenses/LICENSE,sha256=IGdDrBPqz1O0v_UwCW-NJlbX9Hy9b3uJ11t28y2srmY,1062
+hydraflow-0.6.0.dist-info/RECORD,,

hydraflow-0.5.4.dist-info/RECORD

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