hydraflow 0.5.0__py3-none-any.whl → 0.5.2__py3-none-any.whl

hydraflow/__init__.py

@@ -6,6 +6,7 @@ from .mlflow import list_runs, search_runs, set_experiment
 from .run_collection import RunCollection
 from .utils import (
     get_artifact_dir,
+    get_artifact_path,
     get_hydra_output_dir,
     get_overrides,
     load_config,
@@ -18,6 +19,7 @@ __all__ = [
     "chdir_artifact",
     "chdir_hydra_output",
     "get_artifact_dir",
+    "get_artifact_path",
     "get_hydra_output_dir",
     "get_overrides",
     "list_runs",

hydraflow/mlflow.py

@@ -37,6 +37,7 @@ def set_experiment(
     prefix: str = "",
     suffix: str = "",
     uri: str | Path | None = None,
+    name: str | None = None,
 ) -> Experiment:
     """Set the experiment name and tracking URI optionally.
 
@@ -48,6 +49,7 @@ def set_experiment(
         prefix (str): The prefix to prepend to the experiment name.
         suffix (str): The suffix to append to the experiment name.
         uri (str | Path | None): The tracking URI to use. Defaults to None.
+        name (str | None): The name of the experiment. Defaults to None.
 
     Returns:
         Experiment: An instance of `mlflow.entities.Experiment` representing
@@ -57,6 +59,9 @@ def set_experiment(
     if uri is not None:
         mlflow.set_tracking_uri(uri)
 
+    if name is not None:
+        return mlflow.set_experiment(name)
+
     hc = HydraConfig.get()
     name = f"{prefix}{hc.job.name}{suffix}"
     return mlflow.set_experiment(name)
@@ -214,7 +219,7 @@ def _list_runs(
                 elif Path(loc).is_dir():
                     path = Path(loc)
                 else:
-                    continue
+                    continue  # no cov
 
                 run_ids.extend(file.stem for file in path.iterdir() if file.is_dir())
 

hydraflow/run_collection.py

@@ -609,8 +609,8 @@ class RunCollection:
 
     def sort(
         self,
-        key: Callable[[Run], Any] | None = None,
         *,
+        key: Callable[[Run], Any] | None = None,
         reverse: bool = False,
     ) -> None:
         """Sort the runs in the collection.
@@ -652,7 +652,7 @@ class RunCollection:
 
         return [v[0] for v in values]
 
-    def sort_by(
+    def sorted(
         self,
         names: str | list[str],
         *,

hydraflow/run_info.py

@@ -15,6 +15,8 @@ if TYPE_CHECKING:
 class RunCollectionInfo:
     """Provide information about a `RunCollection` instance."""
 
+    _runs: RunCollection
+
     def __init__(self, runs: RunCollection) -> None:
         self._runs = runs
 

hydraflow/utils.py

@@ -30,10 +30,32 @@ def get_artifact_dir(run: Run | None = None) -> Path:
     """
     uri = mlflow.get_artifact_uri() if run is None else run.info.artifact_uri
 
-    if not (isinstance(uri, str) and uri.startswith("file://")):
+    if not isinstance(uri, str):
         raise NotImplementedError
 
-    return Path(mlflow.artifacts.download_artifacts(uri))
+    if uri.startswith("file://"):
+        return Path(mlflow.artifacts.download_artifacts(uri))
+
+    if Path(uri).is_dir():
+        return Path(uri)
+
+    raise NotImplementedError
+
+
+def get_artifact_path(run: Run | None, path: str) -> Path:
+    """Retrieve the artifact path for the given run and path.
+
+    This function uses MLflow to get the artifact path for the given run and path.
+
+    Args:
+        run (Run | None): The run object. Defaults to None.
+        path (str): The path to the artifact.
+
+    Returns:
+        The local path to the artifact.
+
+    """
+    return get_artifact_dir(run) / path
 
 
 def get_hydra_output_dir(run: Run | None = None) -> Path:

{hydraflow-0.5.0.dist-info → hydraflow-0.5.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hydraflow
-Version: 0.5.0
+Version: 0.5.2
 Summary: Hydraflow integrates Hydra and MLflow to manage and track machine learning experiments.
 Project-URL: Documentation, https://github.com/daizutabi/hydraflow
 Project-URL: Source, https://github.com/daizutabi/hydraflow
@@ -111,7 +111,7 @@ def my_app(cfg: MySQLConfig) -> None:
     hydraflow.set_experiment()
 
     # Automatically log Hydra config as params.
-    with hydraflow.start_run():
+    with hydraflow.start_run(cfg):
         # Your app code below.
 
 

hydraflow-0.5.2.dist-info/RECORD

@@ -0,0 +1,14 @@
+hydraflow/__init__.py,sha256=9XO9FD3uiTTPN6X6UAC9FtkJjEqUQZNqpoAmSrjUHfI,855
+hydraflow/config.py,sha256=MNX9da5bPVDcjnpji7Cm9ndK6ura92pt361m4PRh6_E,4326
+hydraflow/context.py,sha256=3g7OQXWcFvK6PVVbXpQg7Hr8nsJkF9pLFrXNi_3aV5A,5524
+hydraflow/mlflow.py,sha256=vor1w8twfBQx9kmlAkvmJ4q7n_GrNyqGXBP1xwTAGD0,8934
+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=32dCP7rmkB7_dyGJgY6auy8162jotd5JSaVi-qB9vnU,4351
+hydraflow-0.5.2.dist-info/METADATA,sha256=ou8nVe6VIYi52Prp26VZcoxixJItFmojKaINgG1DWQo,4700
+hydraflow-0.5.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+hydraflow-0.5.2.dist-info/licenses/LICENSE,sha256=IGdDrBPqz1O0v_UwCW-NJlbX9Hy9b3uJ11t28y2srmY,1062
+hydraflow-0.5.2.dist-info/RECORD,,

hydraflow-0.5.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-hydraflow/__init__.py,sha256=DKtFjTXHTgceX7rpWHiKqhcpG5xtGIseFvN28f7iwYo,807
-hydraflow/config.py,sha256=MNX9da5bPVDcjnpji7Cm9ndK6ura92pt361m4PRh6_E,4326
-hydraflow/context.py,sha256=3g7OQXWcFvK6PVVbXpQg7Hr8nsJkF9pLFrXNi_3aV5A,5524
-hydraflow/mlflow.py,sha256=kWVK_Xw2hkRnTg33jSP3VW13UZF6_hBGhN52mPmLgvk,8753
-hydraflow/param.py,sha256=c5sc6NwD6DKwZzVwprXzZD5FSi6qRgSHkc6TXBKQEdg,4502
-hydraflow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hydraflow/run_collection.py,sha256=RQRN50k5m_bDWn4vzOProbnjzVejI5hsr5WSd4owbhQ,26773
-hydraflow/run_data.py,sha256=dpyyfnuH9mCtIZeigMo1iFQo9bafMdEL4i4uI2l0UqY,1525
-hydraflow/run_info.py,sha256=sMXOo20ClaRIommMEzuAbO_OrcXx7M1Yt4FMV7spxz0,998
-hydraflow/utils.py,sha256=jbNrbtIfMqxE4LrdTNd1g7sF68XgAvydGqW5iAZ6n-c,3834
-hydraflow-0.5.0.dist-info/METADATA,sha256=pv7eNdU5mT05N936AWyuLzZfzYSgVrsGZ5d354bD_-8,4697
-hydraflow-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-hydraflow-0.5.0.dist-info/licenses/LICENSE,sha256=IGdDrBPqz1O0v_UwCW-NJlbX9Hy9b3uJ11t28y2srmY,1062
-hydraflow-0.5.0.dist-info/RECORD,,