hydraflow 0.14.2__py3-none-any.whl → 0.14.3__py3-none-any.whl

{hydraflow-0.14.2.dist-info → hydraflow-0.14.3.dist-info}/METADATA

@@ -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.2.dist-info → hydraflow-0.14.3.dist-info}/RECORD

@@ -18,8 +18,8 @@ hydraflow/executor/conf.py,sha256=icGbLDh86KgkyiGXwDoEkmZpgAP3X8Jmu_PYqJoTooY,42
 hydraflow/executor/io.py,sha256=yZMcBVmAbPZZ82cAXhgiJfj9p8WvHmzOCMBg_vtEVek,1509
 hydraflow/executor/job.py,sha256=JX6xX9ffvHB7IiAVIfzVRjjnWKaPDxBgqdZf4ZO14CY,4651
 hydraflow/executor/parser.py,sha256=_Rfund3FDgrXitTt_znsTpgEtMDqZ_ICynaB_Zje14Q,14561
-hydraflow-0.14.2.dist-info/METADATA,sha256=vONAqVijZXLvD9rYh4AQKMbWbi-OllBkC_BF9iN5d08,4566
-hydraflow-0.14.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-hydraflow-0.14.2.dist-info/entry_points.txt,sha256=XI0khPbpCIUo9UPqkNEpgh-kqK3Jy8T7L2VCWOdkbSM,48
-hydraflow-0.14.2.dist-info/licenses/LICENSE,sha256=IGdDrBPqz1O0v_UwCW-NJlbX9Hy9b3uJ11t28y2srmY,1062
-hydraflow-0.14.2.dist-info/RECORD,,
+hydraflow-0.14.3.dist-info/METADATA,sha256=Y5fO4HFC2fgqhQnkB5k4mwITsCrq3DCFCSKNJcpa1y4,7460
+hydraflow-0.14.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+hydraflow-0.14.3.dist-info/entry_points.txt,sha256=XI0khPbpCIUo9UPqkNEpgh-kqK3Jy8T7L2VCWOdkbSM,48
+hydraflow-0.14.3.dist-info/licenses/LICENSE,sha256=IGdDrBPqz1O0v_UwCW-NJlbX9Hy9b3uJ11t28y2srmY,1062
+hydraflow-0.14.3.dist-info/RECORD,,