Skip to main content

HydraFlow

PyPI Version Build Status Coverage Status Documentation Status Python Version

Overview

HydraFlow seamlessly integrates Hydra and MLflow to streamline machine learning experiment workflows. By combining Hydra's powerful configuration management with MLflow's robust experiment tracking, HydraFlow provides a comprehensive solution for defining, executing, and analyzing machine learning experiments.

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. Analysis Capabilities - Providing powerful APIs for easily analyzing experiment results
  4. Workflow Integration - Creating a cohesive workflow by integrating Hydra's configuration management with MLflow's experiment tracking

Key Features

  • Type-safe Configuration Management - Define experiment parameters using Python dataclasses with full IDE support and validation
  • Seamless Hydra-MLflow Integration - Automatically register configurations with Hydra and track experiments with MLflow
  • Advanced Parameter Sweeps - Define complex parameter spaces using extended sweep syntax for numerical ranges, combinations, and SI prefixes
  • Workflow Automation - Create reusable experiment workflows with YAML-based job definitions
  • Powerful Analysis Tools - Filter, group, and analyze experiment results with type-aware APIs
  • Custom Implementation Support - Extend experiment analysis with domain-specific functionality

Installation

pip install hydraflow

Requirements: Python 3.13+

Quick Example

import hydraflow
from dataclasses import dataclass
from mlflow.entities import Run

@dataclass
class Config:
    width: int = 1024
    height: int = 768

@hydraflow.main(Config)
def app(run: Run, cfg: Config) -> None:
    # Your experiment code here
    print(f"Running with width={cfg.width}, height={cfg.height}")

if __name__ == "__main__":
    app()

Execute a parameter sweep with:

python app.py -m width=800,1200 height=600,900

Core Components

HydraFlow consists of the following key components:

Configuration Management

Define type-safe configurations using Python dataclasses:

@dataclass
class Config:
    learning_rate: float = 0.001
    batch_size: int = 32
    epochs: int = 10

Main Decorator

The @hydraflow.main decorator integrates Hydra and MLflow:

@hydraflow.main(Config)
def train(run: Run, cfg: Config) -> None:
    # Your experiment code

Workflow Automation

Define reusable experiment workflows in YAML:

jobs:
  train_models:
    run: python train.py
    sets:
      - each: model=small,medium,large
        all: learning_rate=0.001,0.01,0.1

Analysis Tools

Analyze experiment results with powerful APIs:

import mlflow
from hydraflow import Run, iter_run_dirs

# Load runs
runs = Run.load(iter_run_dirs())

# Filter and analyze
best_runs = runs.filter(model_type="transformer").to_frame("learning_rate", "accuracy")

Documentation

For detailed documentation, visit our documentation site:

License

This project is licensed under the MIT License.

Metadata

Release files for hydraflow 0.23.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hydraflow 0.23.2
File Size Uploaded
hydraflow-0.23.2.tar.gz 29.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hydraflow 0.23.2
File Interpreter ABI Platform
hydraflow-0.23.2-py3-none-any.whl Python 3 none any Details

Total release size: 66.1 kB

Release files / hydraflow-0.23.2.tar.gz

Download URL hydraflow-0.23.2.tar.gz
Size 29.4 kB
Tags Source
SHA-256 checksum
How to use checksums
4f32030f2b149ca989b21895cda3708e8727ae812a040956889b47d9480a117d
BLAKE2b-256 checksum
How to use checksums
c3ec16049e33cfde4f8882d39e4bd0673d3926ee6ded56cb16aed0ff87e21cfc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / hydraflow-0.23.2-py3-none-any.whl

Download URL hydraflow-0.23.2-py3-none-any.whl
Size 36.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a97f4f9c8dc8af7e1f8ce0346f3b7fa7791b17654b9c142dbebd3358f70b0590
BLAKE2b-256 checksum
How to use checksums
241d68552818eb9524825b37500f1421f2271acfa80a465292f286dca9016ebd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

This release

0.23.2 This release

2 release files

0.23.1

2 release files

0.23.0

2 release files

0.22.1

2 release files

0.21.2

2 release files

0.21.1

2 release files

0.21.0

2 release files

0.20.0

2 release files

0.19.2

2 release files

0.19.0

2 release files

0.18.4

2 release files

0.17.2

2 release files

0.17.1

2 release files

0.17.0

2 release files

0.16.2

2 release files

0.16.1

2 release files

0.16.0

2 release files

0.15.1

2 release files

0.15.0

2 release files

0.14.4

2 release files

0.14.3

2 release files

0.14.2

2 release files

0.14.1

2 release files

0.14.0

2 release files

0.13.1

2 release files

0.13.0

2 release files

0.12.5

2 release files

0.12.4

2 release files

0.10.1

2 release files

0.10.0

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.5

2 release files

0.7.4

2 release files

0.7.3

2 release files

0.7.2

2 release files

0.7.0

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.6

2 release files

0.4.5

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.18

2 release files

0.2.17

2 release files

0.2.16

2 release files

0.2.15

2 release files

0.2.14

2 release files

0.2.13

2 release files

0.2.12

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page