hydraflow 0.16.0__tar.gz → 0.16.2__tar.gz

{hydraflow-0.16.0 → hydraflow-0.16.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hydraflow
-Version: 0.16.0
+Version: 0.16.2
 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
@@ -194,10 +194,6 @@ For detailed documentation, visit our [documentation site](https://daizutabi.git
 - [User Guide](https://daizutabi.github.io/hydraflow/part1-applications/) - Detailed documentation of HydraFlow's capabilities
 - [API Reference](https://daizutabi.github.io/hydraflow/api/hydraflow/) - Complete API documentation
 
-## Contributing
-
-We welcome contributions! Please see our [contributing guide](CONTRIBUTING.md) for details.
-
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License.

{hydraflow-0.16.0 → hydraflow-0.16.2}/README.md

@@ -141,10 +141,6 @@ For detailed documentation, visit our [documentation site](https://daizutabi.git
 - [User Guide](https://daizutabi.github.io/hydraflow/part1-applications/) - Detailed documentation of HydraFlow's capabilities
 - [API Reference](https://daizutabi.github.io/hydraflow/api/hydraflow/) - Complete API documentation
 
-## Contributing
-
-We welcome contributions! Please see our [contributing guide](CONTRIBUTING.md) for details.
-
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License.

{hydraflow-0.16.0 → hydraflow-0.16.2}/docs/part1-applications/main-decorator.md

@@ -242,6 +242,36 @@ This option is particularly useful when:
 - You're iterating on experiments with command-line variations
 - Your configuration contains volatile or automatically generated values
 
+### Dynamic Configuration Updates (`update`)
+
+Modify or enhance the configuration after it has been loaded by Hydra
+but before the run starts:
+
+```python
+def update_config(cfg: Config) -> Config:
+    # Calculate derived values or add runtime information
+    if cfg.width > 0 and cfg.height > 0:
+        cfg.area = cfg.width * cfg.height
+    return cfg
+
+@hydraflow.main(Config, update=update_config)
+def train(run: Run, cfg: Config) -> None:
+    # Configuration has been updated with calculated area
+    print(f"Area: {cfg.area}")
+```
+
+This option is powerful when you need to:
+
+- Calculate derived parameters based on existing configuration values
+- Apply conditional logic to adjust parameters based on their relationships
+- Ensure consistency between related parameters
+- Adapt configurations to the current environment (e.g., hardware capabilities)
+
+The `update` function should accept a configuration object and
+return the same object (or None).
+Any changes made to the configuration will be saved to the run's configuration file,
+ensuring that the stored configuration accurately reflects all updates.
+
 ## Best Practices
 
 1. **Keep Configuration Classes Focused**: Break down complex configurations

{hydraflow-0.16.0 → hydraflow-0.16.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "hydraflow"
-version = "0.16.0"
+version = "0.16.2"
 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" }

{hydraflow-0.16.0 → hydraflow-0.16.2}/src/hydraflow/core/io.py

@@ -5,9 +5,12 @@ from __future__ import annotations
 import fnmatch
 import urllib.parse
 import urllib.request
+from functools import cache
 from pathlib import Path
 from typing import TYPE_CHECKING
 
+from omegaconf import OmegaConf
+
 if TYPE_CHECKING:
     from collections.abc import Callable, Iterator
 
@@ -74,27 +77,37 @@ def log_text(run: Run, from_dir: Path, pattern: str = "*.log") -> None:
         mlflow.log_text(text, file.name)
 
 
-def get_experiment_name(path: Path) -> str | None:
-    """Get the experiment name from the meta file."""
-    metafile = path / "meta.yaml"
-    if not metafile.exists():
-        return None
-    lines = metafile.read_text().splitlines()
-    for line in lines:
-        if line.startswith("name:"):
-            return line.split(":")[1].strip()
-    return None
+@cache
+def get_experiment_name(experiment_dir: Path) -> str:
+    """Get the job name from an experiment directory.
+
+    Extracts the job name from the meta.yaml file. Returns an empty string
+    if the file does not exist or if the job name cannot be found.
+
+    Args:
+        experiment_dir: Path to the experiment directory containing the meta.yaml file
+
+    Returns:
+        The job name as a string, or an empty string if the file does not exist
+
+    """
+    path = experiment_dir / "meta.yaml"
+    if not path.exists():
+        return ""
+
+    meta = OmegaConf.load(experiment_dir / "meta.yaml")
+    return OmegaConf.select(meta, "name", default="")
 
 
 def predicate_experiment_dir(
-    path: Path,
+    experiment_dir: Path,
     experiment_names: list[str] | Callable[[str], bool] | None = None,
 ) -> bool:
     """Predicate an experiment directory based on the path and experiment names."""
-    if not path.is_dir() or path.name in [".trash", "0"]:
+    if not experiment_dir.is_dir() or experiment_dir.name in [".trash", "0"]:
         return False
 
-    name = get_experiment_name(path)
+    name = get_experiment_name(experiment_dir)
     if not name:
         return False
 
@@ -108,9 +121,14 @@ def predicate_experiment_dir(
 
 
 def get_experiment_names(tracking_dir: str | Path) -> list[str]:
-    """Get the experiment names from the tracking directory."""
+    """Get the experiment names from the tracking directory.
+
+    Returns:
+        list[str]: A list of experiment names sorted by the name.
+
+    """
     names = [get_experiment_name(path) for path in Path(tracking_dir).iterdir()]
-    return [name for name in names if name is not None and name != "Default"]
+    return sorted(name for name in names if name and name != "Default")
 
 
 def iter_experiment_dirs(

{hydraflow-0.16.0 → hydraflow-0.16.2}/src/hydraflow/core/main.py

@@ -82,7 +82,12 @@ def main[C](
         rerun_finished: If True, allows rerunning completed runs. Defaults to
             False.
         update: A function that takes a configuration and returns a new
-            configuration. Defaults to None.
+            configuration or None. The function can modify the configuration in-place
+            and/or return it. If the function returns None, the original (potentially
+            modified) configuration is used. Changes made by this function are saved
+            to the configuration file. This is useful for adding derived parameters,
+            ensuring consistency between related values, or adding runtime information
+            to the configuration. Defaults to None.
 
     """
     import mlflow

{hydraflow-0.16.0 → hydraflow-0.16.2}/src/hydraflow/core/run_info.py

@@ -11,11 +11,11 @@ was created.
 from __future__ import annotations
 
 from dataclasses import dataclass
-from functools import cache, cached_property
+from functools import cached_property
 from pathlib import Path
 from typing import TYPE_CHECKING
 
-from omegaconf import OmegaConf
+from .io import get_experiment_name
 
 if TYPE_CHECKING:
     from pathlib import Path
@@ -50,7 +50,7 @@ class RunInfo:
         Hydra configuration file (e.g., if the file does not exist or does not
         contain the expected format).
         """
-        return get_job_name(self.run_dir.parent)
+        return get_experiment_name(self.run_dir.parent)
 
     def to_dict(self) -> dict[str, Any]:
         """Convert the RunInfo to a dictionary."""
@@ -59,25 +59,3 @@ class RunInfo:
             "run_dir": self.run_dir.as_posix(),
             "job_name": self.job_name,
         }
-
-
-@cache
-def get_job_name(experiment_dir: Path) -> str:
-    """Get the job name from an experiment directory.
-
-    Extracts the job name from the meta.yaml file. Returns an empty string
-    if the file does not exist or if the job name cannot be found.
-
-    Args:
-        experiment_dir: Path to the experiment directory containing the meta.yaml file
-
-    Returns:
-        The job name as a string, or an empty string if the file does not exist
-
-    """
-    path = experiment_dir / "meta.yaml"
-    if not path.exists():
-        return ""
-
-    meta = OmegaConf.load(experiment_dir / "meta.yaml")
-    return OmegaConf.select(meta, "name")

{hydraflow-0.16.0 → hydraflow-0.16.2}/tests/core/test_io.py

@@ -90,14 +90,14 @@ def test_predicate_experiment_dir():
 def test_get_experiment_name_none(tracking_dir: Path):
     from hydraflow.core.io import get_experiment_name
 
-    assert get_experiment_name(tracking_dir.parent) is None
+    assert get_experiment_name(tracking_dir.parent) == ""
 
 
 def test_get_experiment_name_metafile_none(tracking_dir: Path):
     from hydraflow.core.io import get_experiment_name
 
     (tracking_dir / "meta.yaml").touch()
-    assert get_experiment_name(tracking_dir) is None
+    assert get_experiment_name(tracking_dir) == ""
 
 
 def test_iter_run_dirs(tracking_dir: Path):