Skip to main content

Flyte HITL Plugin

Human-in-the-Loop (HITL) plugin for Flyte. This plugin provides an event-based API for pausing workflows and waiting for human input.

Installation

pip install flyteplugins-hitl

Usage

import flyte
import flyteplugins.hitl as hitl

task_env = flyte.TaskEnvironment(
    name="my-hitl-workflow",
    image=flyte.Image.from_debian_base(python_version=(3, 12)),
    resources=flyte.Resources(cpu=1, memory="512Mi"),
    depends_on=[hitl.env],
)


@task_env.task
async def task1() -> int:
    """First task - returns an automated value."""
    return 42


@task_env.task
async def task2(x: int, y: int) -> int:
    """Second task - combines automated and human input."""
    return x + y


@task_env.task(report=True)
async def main() -> int:
    """
    Main workflow that orchestrates automated and human-in-the-loop tasks.

    Flow:
    1. task1() runs and returns an automated value (x)
    2. Create an Event (serves the app) and wait for human input (y)
    3. task2(x, y) combines both values and returns the result
    """
    print("Starting HITL workflow...")

    # Step 1: Automated task
    x = await task1()
    print(f"task1 completed: x = {x}")

    # Step 2: Human-in-the-loop using the Event-based API
    # Create an event (this serves the app if not already running)
    event = await hitl.new_event.aio(
        "integer_input_event",
        data_type=int,
        scope="run",
        prompt="What should I add to x?",
    )
    y = await event.wait.aio()
    print(f"Event completed: y = {y}")

    # Step 3: Combine results
    result = await task2(x, y)
    print(f"task2 completed: result = {result}")

    return result


if __name__ == "__main__":
    flyte.init_from_config()
    run = flyte.run(main)
    print(f"Run URL: {run.url}")
    run.wait()
    print(f"Result: {run.outputs()}")

Features

  • Event-based API: Create events that pause workflow execution until human input is received
  • Web Form: Automatically generates a web form for human input
  • Programmatic API: Submit input via curl or any HTTP client
  • Type Safety: Supports int, float, str, and bool data types

API Reference

hitl.new_event(name, data_type, scope, prompt, ...)

Create a new human-in-the-loop event.

Parameters:

  • name (str): A descriptive name for the event
  • data_type (Type): The expected type of the input (int, float, str, bool)
  • scope (str): The scope of the event. Currently only "run" is supported.
  • prompt (str): The prompt to display to the human
  • timeout_seconds (int): Maximum time to wait for human input (default: 3600)
  • poll_interval_seconds (int): How often to check for a response (default: 5)

Returns: An Event object

event.wait() / await event.wait.aio()

Wait for human input and return the result.

Returns: The value provided by the human, converted to the event's data_type

hitl.env

The TaskEnvironment that provides the HITL app infrastructure. Add this to your task environment's depends_on list.

hitl.Event

The Event class for type annotations and advanced usage.

Metadata

Release files for flyteplugins-hitl 2.12.2

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

Built distribution (wheel)

Table of built distributions (wheels) for flyteplugins-hitl 2.12.2
File Interpreter ABI Platform Actions
flyteplugins_hitl-2.12.2-py3-none-any.whl Python 3 none any Details for flyteplugins_hitl-2.12.2-py3-none-any.whl

Release files / flyteplugins_hitl-2.12.2-py3-none-any.whl

Download URL flyteplugins_hitl-2.12.2-py3-none-any.whl
Size 14.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0dfb4bf7418e25651174e2bae80650d3380c627549a161d22309ed315b1bc05f
BLAKE2b-256 checksum
How to use checksums
b1e943d4e7abc762ed587f8ef6592cb64b22b8a7b8bcb67aa5ec2ec19fc9f7c3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.17

Security for flyteplugins-hitl 2.12.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.12.2 This release

1 release file No provenance

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