hydraflow 0.18.3__tar.gz → 0.18.4__tar.gz

{hydraflow-0.18.3 → hydraflow-0.18.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hydraflow
-Version: 0.18.3
+Version: 0.18.4
 Summary: HydraFlow seamlessly integrates Hydra and MLflow to streamline ML experiment management, combining Hydra's configuration management with MLflow's tracking capabilities.
 Project-URL: Documentation, https://daizutabi.github.io/hydraflow/
 Project-URL: Source, https://github.com/daizutabi/hydraflow

{hydraflow-0.18.3 → hydraflow-0.18.4}/docs/part3-analysis/run-class.md

@@ -191,22 +191,6 @@ run = Run[Config, AdvancedModelLoader](run_dir, AdvancedModelLoader)
 model = run.impl.load_model()  # Uses configuration information
 ```
 
-## Loading Multiple Runs
-
-The `load` class method can load both individual runs and collections of runs:
-
-```python
-# Load a single run
-run = Run.load("mlruns/exp_id/run_id")
-
-# Load multiple runs to create a RunCollection
-run_dirs = ["mlruns/exp_id/run_id1", "mlruns/exp_id/run_id2"]
-runs = Run.load(run_dirs)
-
-# Load runs with parallel processing
-runs = Run.load(run_dirs, n_jobs=4)  # Use 4 parallel jobs for loading
-runs = Run.load(run_dirs, n_jobs=-1)  # Use all available CPU cores
-```
 ## Converting to DataFrame
 
 To convert a Run instance to a Polars DataFrame, use the
@@ -231,12 +215,27 @@ df = run.to_frame(
 
 The `to_frame` method accepts the following parameters:
 
-- `func`: A function that takes a Run instance and returns a DataFrame
+- `function`: A function that takes a Run instance and returns a DataFrame
 - `*keys`: Keys for the Run's information to add. Accepts the following formats:
-  - String: A simple key (e.g., "run_id")
-  - Tuple: A tuple of (key, default value or function returning default value)
+    - String: A simple key (e.g., "run_id")
+    - Tuple: A tuple of (key, default value or function returning default value)
 
+## Loading Multiple Runs
+
+The `load` class method can load both individual runs and collections of runs:
+
+```python
+# Load a single run
+run = Run.load("mlruns/exp_id/run_id")
 
+# Load multiple runs to create a RunCollection
+run_dirs = ["mlruns/exp_id/run_id1", "mlruns/exp_id/run_id2"]
+runs = Run.load(run_dirs)
+
+# Load runs with parallel processing
+runs = Run.load(run_dirs, n_jobs=4)  # Use 4 parallel jobs for loading
+runs = Run.load(run_dirs, n_jobs=-1)  # Use all available CPU cores
+```
 
 ### Finding Runs with `iter_run_dirs`
 
@@ -294,4 +293,4 @@ based on experiment names or custom filtering criteria.
 The [`Run`][hydraflow.core.run.Run] class provides a powerful interface for
 working with experiment runs in HydraFlow. Its type-safe configuration access,
 custom implementation support, and convenient loading mechanisms make it easy
-to analyze and compare experiment results effectively.
+to analyze and compare experiment results effectively.

{hydraflow-0.18.3 → hydraflow-0.18.4}/docs/part3-analysis/run-collection.md

@@ -327,10 +327,10 @@ df = run_collection.concat(
 
 The `concat` method accepts the following parameters:
 
-- `func`: A function that takes each Run instance and returns a DataFrame
+- `function`: A function that takes each Run instance and returns a DataFrame
 - `*keys`: Keys for the Run's information to add. Accepts the following formats:
-  - String: A simple key (e.g., "run_id")
-  - Tuple: A tuple of (key, default value or function returning default value)
+    - String: A simple key (e.g., "run_id")
+    - Tuple: A tuple of (key, default value or function returning default value)
 
 ## Grouping Runs
 
@@ -468,4 +468,4 @@ filtering, grouping, and data extraction capabilities enable efficient extractio
 of insights from large sets of experiments, helping you identify optimal
 configurations and understand performance trends.
 
-[hydraflow.core.collection.Collection]: ../../api/hydraflow/core/collection.html#hydraflow.core.collection.Collection
+[hydraflow.core.collection.Collection]: ../../api/hydraflow/core/collection.html#hydraflow.core.collection.Collection

{hydraflow-0.18.3 → hydraflow-0.18.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "hydraflow"
-version = "0.18.3"
+version = "0.18.4"
 description = "HydraFlow seamlessly integrates Hydra and MLflow to streamline ML experiment management, combining Hydra's configuration management with MLflow's tracking capabilities."
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -62,7 +62,7 @@ dev = [
   "pytest-xdist",
   "ruff>=0.11",
 ]
-docs = ["markdown-exec[ansi]", "mkapi", "mkdocs-material"]
+docs = ["markdown-exec[ansi]", "mkapi>=4.4", "mkdocs-material"]
 
 [tool.pytest.ini_options]
 addopts = [

{hydraflow-0.18.3 → hydraflow-0.18.4}/src/hydraflow/core/run.py

@@ -343,13 +343,13 @@ class Run[C, I = None]:
 
     def to_frame(
         self,
-        func: Callable[[Self], DataFrame],
+        function: Callable[[Self], DataFrame],
         *keys: str | tuple[str, Any | Callable[[Self], Any]],
     ) -> DataFrame:
         """Convert the Run to a DataFrame.
 
         Args:
-            func (Callable[[Run], DataFrame]): A function that takes a Run
+            function (Callable[[Run], DataFrame]): A function that takes a Run
                 instance and returns a DataFrame.
             keys (str | tuple[str, Any | Callable[[Run], Any]]): The keys to
                 add to the DataFrame.
@@ -358,7 +358,7 @@ class Run[C, I = None]:
             DataFrame: A DataFrame representation of the Run.
 
         """
-        return func(self).with_columns(
+        return function(self).with_columns(
             self.lit(k) if isinstance(k, str) else self.lit(k[0], k[1]) for k in keys
         )
 

{hydraflow-0.18.3 → hydraflow-0.18.4}/src/hydraflow/core/run_collection.py

@@ -174,7 +174,7 @@ class RunCollection[R: Run[Any, Any], I = None](Collection[R]):
 
     def concat(
         self,
-        func: Callable[[R], DataFrame],
+        function: Callable[[R], DataFrame],
         *keys: str | tuple[str, Any | Callable[[R], Any]],
     ) -> DataFrame:
         """Concatenate the results of a function applied to all runs in the collection.
@@ -183,16 +183,16 @@ class RunCollection[R: Run[Any, Any], I = None](Collection[R]):
         and concatenates the resulting DataFrames along the specified keys.
 
         Args:
-            func (Callable[[R], DataFrame]): A function that takes a Run
+            function (Callable[[R], DataFrame]): A function that takes a Run
                 instance and returns a DataFrame.
             keys (str | tuple[str, Any | Callable[[R], Any]]): The keys to
                 add to the DataFrame.
 
         Returns:
-            DataFrame: A DataFrame representation of the Run.
+            DataFrame: A DataFrame representation of the Run collection.
 
         """
-        return pl.concat(run.to_frame(func, *keys) for run in self)
+        return pl.concat(run.to_frame(function, *keys) for run in self)
 
     @cached_property
     def impls(self) -> Collection[I]: