hydraflow 0.14.2__tar.gz → 0.14.3__tar.gz

{hydraflow-0.14.2 → hydraflow-0.14.3}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: hydraflow
-Version: 0.14.2
-Summary: Hydraflow integrates Hydra and MLflow to manage and track machine learning experiments.
+Version: 0.14.3
+Summary: HydraFlow seamlessly integrates Hydra and MLflow to streamline ML experiment management. It combines Hydra's configuration management with MLflow's tracking capabilities, offering automated experiment tracking, versioning, and a rich CLI interface. Perfect for ML researchers and teams who need reproducibility while scaling experiments.
 Project-URL: Documentation, https://daizutabi.github.io/hydraflow/
 Project-URL: Source, https://github.com/daizutabi/hydraflow
 Project-URL: Issues, https://github.com/daizutabi/hydraflow/issues
@@ -28,13 +28,20 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
 License-File: LICENSE
+Keywords: ai,data-science,deep-learning,experiment-tracking,hydra,machine-learning,mlflow,mlops,research
 Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
 Requires-Dist: hydra-core>=1.3
 Requires-Dist: mlflow>=2.15
@@ -50,6 +57,7 @@ Description-Content-Type: text/markdown
 [![Python Version][python-v-image]][python-v-link]
 [![Build Status][GHAction-image]][GHAction-link]
 [![Coverage Status][codecov-image]][codecov-link]
+[![Documentation Status][docs-image]][docs-link]
 
 <!-- Badges -->
 [pypi-v-image]: https://img.shields.io/pypi/v/hydraflow.svg
@@ -60,6 +68,8 @@ Description-Content-Type: text/markdown
 [GHAction-link]: https://github.com/daizutabi/hydraflow/actions?query=event%3Apush+branch%3Amain
 [codecov-image]: https://codecov.io/github/daizutabi/hydraflow/coverage.svg?branch=main
 [codecov-link]: https://codecov.io/github/daizutabi/hydraflow?branch=main
+[docs-image]: https://readthedocs.org/projects/hydraflow/badge/?version=latest
+[docs-link]: https://daizutabi.github.io/hydraflow/
 
 ## Overview
 
@@ -80,6 +90,8 @@ machine learning workflows.
   checkpoints and configuration files, with MLflow.
 - **Seamless Integration**: Easily integrate Hydra and MLflow in your machine learning
   projects with minimal setup.
+- **Rich CLI Interface**: Command-line tools for managing experiments and viewing results.
+- **Cross-Platform Support**: Works consistently across different operating systems.
 
 ## Installation
 
@@ -89,7 +101,7 @@ You can install Hydraflow via pip:
 pip install hydraflow
 ```
 
-## Getting Started
+## Quick Start
 
 Here is a simple example to get you started with Hydraflow:
 
@@ -100,6 +112,7 @@ from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
 import hydraflow
+import mlflow
 
 if TYPE_CHECKING:
     from mlflow.entities import Run
@@ -107,15 +120,73 @@ if TYPE_CHECKING:
 
 @dataclass
 class Config:
-    count: int = 1
-    name: str = "a"
+    """Configuration for the ML training experiment."""
+    # Training hyperparameters
+    learning_rate: float = 0.001
+    batch_size: int = 32
+    epochs: int = 10
+
+    # Model architecture parameters
+    hidden_size: int = 128
+    dropout: float = 0.1
+
+    # Dataset parameters
+    train_size: float = 0.8
+    random_seed: int = 42
 
 
 @hydraflow.main(Config)
 def app(run: Run, cfg: Config):
-    """Your app code here."""
+    """Train a model with the given configuration.
+
+    This example demonstrates how to:
+
+    1. Define a configuration using dataclasses
+    2. Use Hydraflow to integrate with MLflow
+    3. Track metrics and parameters automatically
+
+    Args:
+        run: MLflow run for the experiment corresponding to the Hydra app.
+            This `Run` instance is automatically created by Hydraflow.
+        cfg: Configuration for the experiment's run.
+            This `Config` instance is originally defined by Hydra, and then
+            automatically passed to the app by Hydraflow.
+    """
+    # Training loop
+    for epoch in range(cfg.epochs):
+        # Simulate training and validation
+        train_loss = 1.0 / (epoch + 1)
+        val_loss = 1.1 / (epoch + 1)
+
+        # Log metrics to MLflow
+        mlflow.log_metrics({
+            "train_loss": train_loss,
+            "val_loss": val_loss
+        }, step=epoch)
+
+        print(f"Epoch {epoch}: train_loss={train_loss:.4f}, val_loss={val_loss:.4f}")
 
 
 if __name__ == "__main__":
     app()
 ```
+
+This example demonstrates:
+
+- Configuration management with Hydra
+- Automatic experiment tracking with MLflow
+- Parameter logging and metric tracking
+- Type-safe configuration with dataclasses
+
+## Documentation
+
+For detailed documentation, including advanced usage examples and API reference,
+visit our [documentation site](https://daizutabi.github.io/hydraflow/).
+
+## 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.

hydraflow-0.14.3/README.md

@@ -0,0 +1,139 @@
+# Hydraflow
+
+[![PyPI Version][pypi-v-image]][pypi-v-link]
+[![Python Version][python-v-image]][python-v-link]
+[![Build Status][GHAction-image]][GHAction-link]
+[![Coverage Status][codecov-image]][codecov-link]
+[![Documentation Status][docs-image]][docs-link]
+
+<!-- Badges -->
+[pypi-v-image]: https://img.shields.io/pypi/v/hydraflow.svg
+[pypi-v-link]: https://pypi.org/project/hydraflow/
+[python-v-image]: https://img.shields.io/pypi/pyversions/hydraflow.svg
+[python-v-link]: https://pypi.org/project/hydraflow
+[GHAction-image]: https://github.com/daizutabi/hydraflow/actions/workflows/ci.yaml/badge.svg?branch=main&event=push
+[GHAction-link]: https://github.com/daizutabi/hydraflow/actions?query=event%3Apush+branch%3Amain
+[codecov-image]: https://codecov.io/github/daizutabi/hydraflow/coverage.svg?branch=main
+[codecov-link]: https://codecov.io/github/daizutabi/hydraflow?branch=main
+[docs-image]: https://readthedocs.org/projects/hydraflow/badge/?version=latest
+[docs-link]: https://daizutabi.github.io/hydraflow/
+
+## Overview
+
+Hydraflow is a library designed to seamlessly integrate
+[Hydra](https://hydra.cc/) and [MLflow](https://mlflow.org/), making it easier to
+manage and track machine learning experiments. By combining the flexibility of
+Hydra's configuration management with the robust experiment tracking capabilities
+of MLflow, Hydraflow provides a comprehensive solution for managing complex
+machine learning workflows.
+
+## Key Features
+
+- **Configuration Management**: Utilize Hydra's advanced configuration management
+  to handle complex parameter sweeps and experiment setups.
+- **Experiment Tracking**: Leverage MLflow's tracking capabilities to log parameters,
+  metrics, and artifacts for each run.
+- **Artifact Management**: Automatically log and manage artifacts, such as model
+  checkpoints and configuration files, with MLflow.
+- **Seamless Integration**: Easily integrate Hydra and MLflow in your machine learning
+  projects with minimal setup.
+- **Rich CLI Interface**: Command-line tools for managing experiments and viewing results.
+- **Cross-Platform Support**: Works consistently across different operating systems.
+
+## Installation
+
+You can install Hydraflow via pip:
+
+```bash
+pip install hydraflow
+```
+
+## Quick Start
+
+Here is a simple example to get you started with Hydraflow:
+
+```python
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+import hydraflow
+import mlflow
+
+if TYPE_CHECKING:
+    from mlflow.entities import Run
+
+
+@dataclass
+class Config:
+    """Configuration for the ML training experiment."""
+    # Training hyperparameters
+    learning_rate: float = 0.001
+    batch_size: int = 32
+    epochs: int = 10
+
+    # Model architecture parameters
+    hidden_size: int = 128
+    dropout: float = 0.1
+
+    # Dataset parameters
+    train_size: float = 0.8
+    random_seed: int = 42
+
+
+@hydraflow.main(Config)
+def app(run: Run, cfg: Config):
+    """Train a model with the given configuration.
+
+    This example demonstrates how to:
+
+    1. Define a configuration using dataclasses
+    2. Use Hydraflow to integrate with MLflow
+    3. Track metrics and parameters automatically
+
+    Args:
+        run: MLflow run for the experiment corresponding to the Hydra app.
+            This `Run` instance is automatically created by Hydraflow.
+        cfg: Configuration for the experiment's run.
+            This `Config` instance is originally defined by Hydra, and then
+            automatically passed to the app by Hydraflow.
+    """
+    # Training loop
+    for epoch in range(cfg.epochs):
+        # Simulate training and validation
+        train_loss = 1.0 / (epoch + 1)
+        val_loss = 1.1 / (epoch + 1)
+
+        # Log metrics to MLflow
+        mlflow.log_metrics({
+            "train_loss": train_loss,
+            "val_loss": val_loss
+        }, step=epoch)
+
+        print(f"Epoch {epoch}: train_loss={train_loss:.4f}, val_loss={val_loss:.4f}")
+
+
+if __name__ == "__main__":
+    app()
+```
+
+This example demonstrates:
+
+- Configuration management with Hydra
+- Automatic experiment tracking with MLflow
+- Parameter logging and metric tracking
+- Type-safe configuration with dataclasses
+
+## Documentation
+
+For detailed documentation, including advanced usage examples and API reference,
+visit our [documentation site](https://daizutabi.github.io/hydraflow/).
+
+## 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.

{hydraflow-0.14.2 → hydraflow-0.14.3}/pyproject.toml

@@ -4,22 +4,40 @@ build-backend = "hatchling.build"
 
 [project]
 name = "hydraflow"
-version = "0.14.2"
-description = "Hydraflow integrates Hydra and MLflow to manage and track machine learning experiments."
+version = "0.14.3"
+description = "HydraFlow seamlessly integrates Hydra and MLflow to streamline ML experiment management. It combines Hydra's configuration management with MLflow's tracking capabilities, offering automated experiment tracking, versioning, and a rich CLI interface. Perfect for ML researchers and teams who need reproducibility while scaling experiments."
 readme = "README.md"
 license = { file = "LICENSE" }
 authors = [{ name = "daizutabi", email = "daizutabi@gmail.com" }]
 classifiers = [
   "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
   "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
+  "Topic :: Scientific/Engineering :: Artificial Intelligence",
+  "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 requires-python = ">=3.10"
+keywords = [
+  "machine-learning",
+  "mlflow",
+  "hydra",
+  "experiment-tracking",
+  "mlops",
+  "ai",
+  "deep-learning",
+  "research",
+  "data-science",
+]
 dependencies = [
+
   "hydra-core>=1.3",
   "mlflow>=2.15",
   "omegaconf>=2.3",

hydraflow-0.14.3/tests/cli/app.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import logging
+import time
+from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+import hydraflow
+
+if TYPE_CHECKING:
+    from mlflow.entities import Run
+
+log = logging.getLogger(__name__)
+
+
+@dataclass
+class Config:
+    """Configuration for the example app.
+
+    Attributes:
+        count: Number of iterations to run
+        name: Identifier for the run
+    """
+
+    count: int = 1
+    name: str = "a"
+
+
+@hydraflow.main(Config)
+def app(run: Run, cfg: Config):
+    """Example app demonstrating Hydraflow's basic functionality.
+
+    This app shows how to:
+
+    1. Define a configuration using dataclasses
+    2. Use the Hydraflow decorator to integrate with MLflow
+    3. Access the MLflow run object and configuration
+
+    Args:
+        run: MLflow run object for tracking metrics and parameters
+        cfg: Configuration object containing run parameters
+    """
+    # Start the run
+    log.info("start")
+
+    # Simulate some work
+    time.sleep(0.2)
+
+    # End the run
+    log.info("end")
+
+
+if __name__ == "__main__":
+    app()

hydraflow-0.14.2/README.md

@@ -1,75 +0,0 @@
-# Hydraflow
-
-[![PyPI Version][pypi-v-image]][pypi-v-link]
-[![Python Version][python-v-image]][python-v-link]
-[![Build Status][GHAction-image]][GHAction-link]
-[![Coverage Status][codecov-image]][codecov-link]
-
-<!-- Badges -->
-[pypi-v-image]: https://img.shields.io/pypi/v/hydraflow.svg
-[pypi-v-link]: https://pypi.org/project/hydraflow/
-[python-v-image]: https://img.shields.io/pypi/pyversions/hydraflow.svg
-[python-v-link]: https://pypi.org/project/hydraflow
-[GHAction-image]: https://github.com/daizutabi/hydraflow/actions/workflows/ci.yaml/badge.svg?branch=main&event=push
-[GHAction-link]: https://github.com/daizutabi/hydraflow/actions?query=event%3Apush+branch%3Amain
-[codecov-image]: https://codecov.io/github/daizutabi/hydraflow/coverage.svg?branch=main
-[codecov-link]: https://codecov.io/github/daizutabi/hydraflow?branch=main
-
-## Overview
-
-Hydraflow is a library designed to seamlessly integrate
-[Hydra](https://hydra.cc/) and [MLflow](https://mlflow.org/), making it easier to
-manage and track machine learning experiments. By combining the flexibility of
-Hydra's configuration management with the robust experiment tracking capabilities
-of MLflow, Hydraflow provides a comprehensive solution for managing complex
-machine learning workflows.
-
-## Key Features
-
-- **Configuration Management**: Utilize Hydra's advanced configuration management
-  to handle complex parameter sweeps and experiment setups.
-- **Experiment Tracking**: Leverage MLflow's tracking capabilities to log parameters,
-  metrics, and artifacts for each run.
-- **Artifact Management**: Automatically log and manage artifacts, such as model
-  checkpoints and configuration files, with MLflow.
-- **Seamless Integration**: Easily integrate Hydra and MLflow in your machine learning
-  projects with minimal setup.
-
-## Installation
-
-You can install Hydraflow via pip:
-
-```bash
-pip install hydraflow
-```
-
-## Getting Started
-
-Here is a simple example to get you started with Hydraflow:
-
-```python
-from __future__ import annotations
-
-from dataclasses import dataclass
-from typing import TYPE_CHECKING
-
-import hydraflow
-
-if TYPE_CHECKING:
-    from mlflow.entities import Run
-
-
-@dataclass
-class Config:
-    count: int = 1
-    name: str = "a"
-
-
-@hydraflow.main(Config)
-def app(run: Run, cfg: Config):
-    """Your app code here."""
-
-
-if __name__ == "__main__":
-    app()
-```

hydraflow-0.14.2/tests/cli/app.py

@@ -1,30 +0,0 @@
-from __future__ import annotations
-
-import logging
-import time
-from dataclasses import dataclass
-from typing import TYPE_CHECKING
-
-import hydraflow
-
-if TYPE_CHECKING:
-    from mlflow.entities import Run
-
-log = logging.getLogger(__name__)
-
-
-@dataclass
-class Config:
-    count: int = 1
-    name: str = "a"
-
-
-@hydraflow.main(Config)
-def app(run: Run, cfg: Config):
-    log.info("start")
-    time.sleep(0.2)
-    log.info("end")
-
-
-if __name__ == "__main__":
-    app()