hydraflow 0.18.4__tar.gz → 0.19.1__tar.gz

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

@@ -1,34 +1,31 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.3
 Name: hydraflow
-Version: 0.18.4
+Version: 0.19.1
 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
-Project-URL: Issues, https://github.com/daizutabi/hydraflow/issues
+Keywords: machine-learning,mlflow,hydra,experiment-tracking,mlops,ai,deep-learning,research,data-science
+Author: daizutabi
 Author-email: daizutabi <daizutabi@gmail.com>
 License: MIT License
-        
-        Copyright (c) 2024 Daizu
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        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
+         
+         Copyright (c) 2024 Daizu
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -39,15 +36,18 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.13
 Requires-Dist: hydra-core>=1.3
 Requires-Dist: joblib>=1.4.0
-Requires-Dist: mlflow>=2.15
+Requires-Dist: mlflow>=3
 Requires-Dist: omegaconf>=2.3
 Requires-Dist: polars>=1.26
 Requires-Dist: python-ulid>=3.0.0
-Requires-Dist: rich>=13.9
-Requires-Dist: typer>=0.15
+Requires-Dist: rich>=14
+Requires-Dist: typer>=0.16
+Requires-Python: >=3.13
+Project-URL: Documentation, https://daizutabi.github.io/hydraflow/
+Project-URL: Issues, https://github.com/daizutabi/hydraflow/issues
+Project-URL: Source, https://github.com/daizutabi/hydraflow
 Description-Content-Type: text/markdown
 
 # HydraFlow
@@ -64,7 +64,7 @@ Description-Content-Type: text/markdown
 [pypi-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-image]: https://codecov.io/github/daizutabi/hydraflow/graph/badge.svg?token=Yu6lAdVVnd
 [codecov-link]: https://codecov.io/github/daizutabi/hydraflow?branch=main
 [docs-image]: https://img.shields.io/badge/docs-latest-blue.svg
 [docs-link]: https://daizutabi.github.io/hydraflow/

{hydraflow-0.18.4 → hydraflow-0.19.1}/README.md

@@ -12,7 +12,7 @@
 [pypi-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-image]: https://codecov.io/github/daizutabi/hydraflow/graph/badge.svg?token=Yu6lAdVVnd
 [codecov-link]: https://codecov.io/github/daizutabi/hydraflow?branch=main
 [docs-image]: https://img.shields.io/badge/docs-latest-blue.svg
 [docs-link]: https://daizutabi.github.io/hydraflow/

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

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
+requires = ["uv_build>=0.7.19,<0.8.0"]
+build-backend = "uv_build"
 
 [project]
 name = "hydraflow"
-version = "0.18.4"
+version = "0.19.1"
 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" }
@@ -36,12 +36,12 @@ keywords = [
 dependencies = [
   "hydra-core>=1.3",
   "joblib>=1.4.0",
-  "mlflow>=2.15",
+  "mlflow>=3",
   "omegaconf>=2.3",
   "polars>=1.26",
   "python-ulid>=3.0.0",
-  "rich>=13.9",
-  "typer>=0.15",
+  "rich>=14",
+  "typer>=0.16",
 ]
 
 [project.urls]
@@ -60,7 +60,7 @@ dev = [
   "pytest-order",
   "pytest-randomly",
   "pytest-xdist",
-  "ruff>=0.11",
+  "ruff>=0.12",
 ]
 docs = ["markdown-exec[ansi]", "mkapi>=4.4", "mkdocs-material"]
 
@@ -99,8 +99,8 @@ ignore = [
   "EM101",
   "FBT001",
   "FBT002",
-  "PD",
   "PGH003",
+  "PLC0415",
   "PLR0911",
   "PLR0913",
   "PLR1704",

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

@@ -140,7 +140,7 @@ class Run[C, I = None]:
         impl_factory: Callable[[Path], I] | Callable[[Path, C], I] | None = None,
         *,
         n_jobs: int = 0,
-    ) -> RunCollection[Self, I]: ...
+    ) -> RunCollection[Self]: ...
 
     @classmethod
     def load(
@@ -149,7 +149,7 @@ class Run[C, I = None]:
         impl_factory: Callable[[Path], I] | Callable[[Path, C], I] | None = None,
         *,
         n_jobs: int = 0,
-    ) -> Self | RunCollection[Self, I]:
+    ) -> Self | RunCollection[Self]:
         """Load a Run from a run directory.
 
         Args:

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

@@ -40,7 +40,6 @@ Note:
 
 from __future__ import annotations
 
-from functools import cached_property
 from typing import TYPE_CHECKING, overload
 
 import polars as pl
@@ -56,7 +55,7 @@ if TYPE_CHECKING:
     from polars import DataFrame
 
 
-class RunCollection[R: Run[Any, Any], I = None](Collection[R]):
+class RunCollection[R: Run[Any, Any]](Collection[R]):
     """A collection of Run instances that implements the Sequence protocol.
 
     RunCollection provides methods for filtering, sorting, grouping, and analyzing
@@ -194,16 +193,6 @@ class RunCollection[R: Run[Any, Any], I = None](Collection[R]):
         """
         return pl.concat(run.to_frame(function, *keys) for run in self)
 
-    @cached_property
-    def impls(self) -> Collection[I]:
-        """Get the implementation objects for all runs in the collection.
-
-        Returns:
-            Collection[I]: A collection of implementation objects for all runs.
-
-        """
-        return Collection(run.impl for run in self)
-
     def iterdir(self, relative_dir: str = "") -> Iterator[Path]:
         """Iterate over the artifact directories for all runs in the collection.
 

hydraflow-0.18.4/.devcontainer/devcontainer.json

@@ -1,19 +0,0 @@
-{
-  "image": "mcr.microsoft.com/vscode/devcontainers/base:ubuntu24.04",
-  "features": {
-    "ghcr.io/devcontainers-contrib/features/starship:1": {}
-  },
-  "customizations": {
-    "vscode": {
-      "extensions": [
-        "charliermarsh.ruff",
-        "fill-labs.dependi",
-        "markis.code-coverage",
-        "ms-python.python",
-        "ms-python.vscode-pylance",
-        "tamasfe.even-better-toml"
-      ]
-    }
-  },
-  "postCreateCommand": ".devcontainer/postCreate.sh"
-}

hydraflow-0.18.4/.devcontainer/postCreate.sh

@@ -1,8 +0,0 @@
-#!/bin/bash
-
-echo 'eval "$(starship init bash)"' >> ~/.bashrc
-mkdir -p ~/.config
-cp .devcontainer/starship.toml ~/.config
-
-curl -LsSf https://astral.sh/uv/install.sh | sh
-echo 'eval "$(uv generate-shell-completion bash)"' >> ~/.bashrc

hydraflow-0.18.4/.devcontainer/starship.toml

@@ -1,29 +0,0 @@
-"$schema" = 'https://starship.rs/config-schema.json'
-
-add_newline = true
-
-[username]
-disabled = true
-
-[hostname]
-disabled = true
-
-[package]
-format = '[$symbol$version]($style) '
-symbol = "󰏗 "
-style = 'bold blue'
-
-[git_branch]
-format = '[$symbol$branch(:$remote_branch)]($style)'
-symbol = ' '
-style = 'bold green'
-
-[git_status]
-style = 'red'
-modified = '*'
-format = '([$modified]($style)) '
-
-[python]
-format = '[${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'
-symbol = ' '
-style = 'yellow'

hydraflow-0.18.4/.gitattributes

@@ -1,2 +0,0 @@
-* text eol=lf
-.devcontainer/* linguist-vendored

hydraflow-0.18.4/.github/workflows/ci.yaml

@@ -1,50 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-
-concurrency:
-  group: test-${{ github.head_ref }}
-  cancel-in-progress: true
-
-env:
-  PYTHONUNBUFFERED: "1"
-  FORCE_COLOR: "1"
-
-jobs:
-  ci:
-    name: Python ${{ matrix.python-version }} on ${{ startsWith(matrix.os, 'macos-') && 'macOS' || startsWith(matrix.os, 'windows-') && 'Windows' || 'Linux' }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ["3.13"]
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install uv and ruff
-        run: pip install uv ruff
-      - name: Install the project
-        run: uv sync
-      - name: Ruff check
-        run: ruff check
-      - name: Run test
-        run: uv run pytest -v -n8 --junitxml=junit.xml
-      - name: Upload Codecov Results
-        if: success()
-        uses: codecov/codecov-action@v4
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          file: lcov.info
-      - name: Upload test results to Codecov
-        if: ${{ !cancelled() }}
-        uses: codecov/test-results-action@v1
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}

hydraflow-0.18.4/.github/workflows/docs.yaml

@@ -1,29 +0,0 @@
-name: Documentation
-
-on:
-  push:
-    branches: [main]
-    tags:
-      - "[0-9]+.[0-9]+.[0-9]+"
-
-jobs:
-  docs:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - uses: actions/checkout@v4
-      - name: Configure Git Credentials
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-      - name: Set up Python 3.13
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.13
-      - name: Install uv
-        run: pip install uv
-      - name: Install the project
-        run: uv sync --group docs
-      - name: Deploy documentation
-        run: uv run mkdocs gh-deploy --force

hydraflow-0.18.4/.github/workflows/publish.yaml

@@ -1,37 +0,0 @@
-name: Publish
-
-on:
-  push:
-    tags:
-      - "[0-9]+.[0-9]+.[0-9]+"
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    permissions:
-      id-token: write
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Verify version match
-        run: |
-          TAG=${GITHUB_REF#refs/tags/}
-          PYPROJECT_VERSION=$(grep -m 1 "version = " pyproject.toml | cut -d'"' -f2)
-          if [ "$TAG" != "$PYPROJECT_VERSION" ]; then
-            echo "Error: Git tag ($TAG) does not match pyproject.toml version ($PYPROJECT_VERSION)"
-            exit 1
-          fi
-          echo "Version verified: $TAG"
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.13
-      - name: Install uv
-        run: pip install uv
-      - name: Install the project
-        run: uv sync
-      - name: Build the project
-        run: uv build --no-sources
-      - name: Upload the project to PyPI
-        run: uv publish

hydraflow-0.18.4/.gitignore

@@ -1,11 +0,0 @@
-*.db
-**/mlruns/
-**/multirun/
-**/outputs/
-.coverage*
-.env
-.venv/
-__pycache__/
-dist/
-lcov.info
-uv.lock

hydraflow-0.18.4/docs/getting-started/concepts.md

@@ -1,189 +0,0 @@
-# Core Concepts
-
-This page introduces the fundamental concepts of HydraFlow that
-form the foundation of the framework.
-
-## Design Principles
-
-HydraFlow is built on the following design principles:
-
-1. **Type Safety** - Utilizing Python dataclasses for configuration
-    type checking and IDE support
-2. **Reproducibility** - Automatically tracking all experiment configurations
-    for fully reproducible experiments
-3. **Workflow Integration** - Creating a cohesive workflow by integrating
-    Hydra's configuration management with MLflow's experiment tracking
-4. **Analysis Capabilities** - Providing powerful APIs for easily
-    analyzing experiment results
-
-## Key Components
-
-HydraFlow consists of the following key components:
-
-### Configuration Management
-
-HydraFlow uses a hierarchical configuration system based on
-OmegaConf and Hydra. This provides:
-
-- Type-safe configuration using Python dataclasses
-- Schema validation to ensure configuration correctness
-- Configuration composition from multiple sources
-- Command-line overrides
-
-Example configuration:
-
-```python
-from dataclasses import dataclass
-
-@dataclass
-class Config:
-    learning_rate: float = 0.001
-    batch_size: int = 32
-    epochs: int = 10
-```
-
-This configuration class defines the structure and default values
-for your experiment, enabling type checking and auto-completion.
-
-### Main Decorator
-
-The [`@hydraflow.main`][hydraflow.main] decorator defines the entry
-point for a HydraFlow application:
-
-```python
-import hydraflow
-from mlflow.entities import Run
-
-@hydraflow.main(Config)
-def train(run: Run, cfg: Config) -> None:
-    # Your experiment code
-    print(f"Training with lr={cfg.learning_rate}, batch_size={cfg.batch_size}")
-
-    # Log metrics
-    hydraflow.log_metric("accuracy", 0.95)
-```
-
-This decorator provides:
-
-- Automatic registration of your config class with Hydra's `ConfigStore`
-- Automatic setup of an MLflow experiment
-- Storage of Hydra configurations and logs as MLflow artifacts
-- Support for type-safe APIs and IDE integration
-
-### Workflow Automation
-
-HydraFlow allows you to automate experiment workflows using a
-YAML-based job definition system:
-
-```yaml
-jobs:
-  train_models:
-    run: python train.py
-    sets:
-      - each: model=small,medium,large
-        all: learning_rate=0.001,0.01,0.1
-```
-
-This enables:
-
-- Defining reusable experiment workflows
-- Efficient configuration of parameter sweeps
-- Organization of complex experiment campaigns
-
-You can also define more complex parameter spaces using extended sweep syntax:
-
-```bash
-# Ranges (start:end:step)
-python train.py -m "learning_rate=0.01:0.03:0.01"
-
-# SI prefixes
-python train.py -m "batch_size=1k,2k,4k"
-# 1000, 2000, 4000
-
-# Grid within a single parameter
-python train.py -m "model=(small,large)_(v1,v2)"
-# small_v1, small_v2, large_v1, large_v2
-```
-
-### Analysis Tools
-
-After running experiments, HydraFlow provides powerful tools for accessing
-and analyzing results. These tools help you track, compare, and derive
-insights from your experiments.
-
-#### Working with Individual Runs
-
-For individual experiment analysis, HydraFlow provides the `Run` class,
-which represents a single experiment run:
-
-```python
-from hydraflow import Run
-
-# Load an existing run
-run = Run.load("path/to/run")
-
-# Access configuration values
-learning_rate = run.get("learning_rate")
-```
-
-The `Run` class provides:
-
-- Access to experiment configurations used during the run
-- Methods for loading and analyzing experiment results
-- Support for custom implementations through the factory pattern
-- Type-safe access to configuration values
-
-You can use type parameters for more powerful IDE support:
-
-```python
-from dataclasses import dataclass
-from hydraflow import Run
-
-@dataclass
-class MyConfig:
-    learning_rate: float
-    batch_size: int
-
-# Load a Run with type information
-run = Run[MyConfig].load("path/to/run")
-print(run.cfg.learning_rate)  # IDE auto-completion works
-```
-
-#### Comparing Multiple Runs
-
-For comparing multiple runs, HydraFlow offers the `RunCollection` class,
-which enables efficient analysis across runs:
-
-```python
-# Load multiple runs
-runs = Run.load(["path/to/run1", "path/to/run2", "path/to/run3"])
-
-# Filter runs by parameter value
-filtered_runs = runs.filter(model_type="lstm")
-
-# Group runs by a parameter
-grouped_runs = runs.group_by("dataset_name")
-
-# Convert to DataFrame for analysis
-df = runs.to_frame("learning_rate", "batch_size", "accuracy")
-```
-
-Key features of experiment comparison:
-
-- Filtering runs based on configuration parameters
-- Grouping runs by common attributes
-- Aggregating data across runs
-- Converting to Polars DataFrames for advanced analysis
-
-## Summary
-
-These core concepts work together to provide a comprehensive framework
-for managing machine learning experiments:
-
-1. **Configuration Management** - Type-safe configuration with Python dataclasses
-2. **Main Decorator** - The entry point that integrates Hydra and MLflow
-3. **Workflow Automation** - Reusable experiment definitions and advanced parameter sweeps
-4. **Analysis Tools** - Access, filter, and analyze experiment results
-
-Understanding these fundamental concepts will help you leverage the full power
-of HydraFlow for your machine learning projects.

hydraflow-0.18.4/docs/getting-started/index.md

@@ -1,80 +0,0 @@
-# Getting Started with HydraFlow
-
-Welcome to HydraFlow, a framework designed to streamline machine learning
-workflows by integrating Hydra's configuration management with MLflow's
-experiment tracking capabilities.
-
-## Overview
-
-This section provides everything you need to begin using HydraFlow
-effectively:
-
-- [Installation](installation.md): Step-by-step instructions for installing
-  HydraFlow and its dependencies
-- [Core Concepts](concepts.md): An introduction to the fundamental concepts
-  that underpin HydraFlow's design and functionality
-
-## Why HydraFlow?
-
-Managing machine learning experiments involves numerous challenges, including:
-
-- **Configuration Management**: Tracking hyperparameters and settings across
-  multiple experiment runs
-- **Reproducibility**: Ensuring experiments can be reliably reproduced
-- **Result Analysis**: Efficiently comparing and analyzing experiment outcomes
-- **Workflow Automation**: Organizing and managing experiment workflows
-
-HydraFlow addresses these challenges by providing:
-
-1. **Type-safe Configuration**: Using Python's native dataclasses for
-   robust configuration management
-2. **Seamless Integration**: Bridging Hydra and MLflow to combine their
-   respective strengths
-3. **Analysis Tools**: Providing powerful APIs for filtering, grouping,
-   and analyzing results
-4. **Workflow Automation**: Simplifying the organization and execution of
-   machine learning experiments
-
-## Quick Example
-
-Here's a simple example to demonstrate HydraFlow's basic usage:
-
-```python
-from dataclasses import dataclass
-from mlflow.entities import Run
-import hydraflow
-
-@dataclass
-class Config:
-    learning_rate: float = 0.01
-    batch_size: int = 32
-    epochs: int = 10
-
-@hydraflow.main(Config)
-def train(run: Run, cfg: Config) -> None:
-    # Your training code here
-    print(f"Training with lr={cfg.learning_rate}, batch_size={cfg.batch_size}")
-
-    # Log metrics
-    hydraflow.log_metric("accuracy", 0.95)
-
-if __name__ == "__main__":
-    train()
-```
-
-Run this example with:
-
-```bash
-python train.py learning_rate=0.001 batch_size=64
-```
-
-## Next Steps
-
-After installing HydraFlow and understanding its core concepts, you're ready to:
-
-1. Follow our [Practical Tutorials](../practical-tutorials/index.md) to see HydraFlow in action
-2. Explore the detailed [User Guide](../part1-applications/index.md) to learn more about HydraFlow's capabilities
-3. Check the [API Reference](../api/hydraflow/README.md) for detailed documentation of HydraFlow's API
-
-Continue to the [Installation Guide](installation.md) to get started with
-HydraFlow.