Skip to main content

SDK for the HUD platform.

Project description

HUD

OSS RL environment + evals toolkit. Wrap software as environments, run benchmarks, and train with RL โ€“ locally or at scale.

PyPI version License Add docs to Cursor Discord X Follow Shop

Are you a startup building agents?

๐Ÿ“… Hop on a call or ๐Ÿ“ง founders@hud.so

Highlights

  • ๐Ÿš€ MCP environment skeleton โ€“ any agent can call any environment.
  • โšก๏ธ Live telemetry โ€“ inspect every tool call, observation, and reward in real time.
  • ๐Ÿ—‚๏ธ Public benchmarks โ€“ OSWorld-Verified, SheetBench-50, and more.
  • ๐ŸŒ Cloud browsers โ€“ AnchorBrowser, Steel, BrowserBase integrations for browser automation.
  • ๐Ÿ› ๏ธ Hot-reload dev loop โ€“ hud dev for iterating on environments without rebuilds.
  • ๐ŸŽ“ One-click RL โ€“ Run hud rl to get a trained model on any environment.

We welcome contributors and feature requests โ€“ open an issue or hop on a call to discuss improvements!

Installation

# SDK - MCP servers, telemetry, evaluation
pip install hud-python

# CLI - RL pipeline, environment design
uv tool install hud-python
# uv tool update-shell

See docs.hud.so, or add docs to any MCP client: claude mcp add --transport http docs-hud https://docs.hud.so/mcp

Before starting, get your HUD_API_KEY at hud.so.

Quickstart: Evals

For a tutorial that explains the agent and evaluation design, run:

uvx hud-python quickstart

Or just write your own agent loop (more examples here).

import asyncio, hud, os
from hud.settings import settings
from hud.clients import MCPClient
from hud.agents import ClaudeAgent
from hud.datasets import Task  # See docs: https://docs.hud.so/reference/tasks

async def main() -> None:
    with hud.trace("Quick Start 2048"): # All telemetry works for any MCP-based agent (see https://hud.so)
        task = {
            "prompt": "Reach 64 in 2048.",
            "mcp_config": {
                "hud": {
                    "url": "https://mcp.hud.so/v3/mcp",  # HUD's cloud MCP server (see https://docs.hud.so/core-concepts/architecture)
                    "headers": {
                        "Authorization": f"Bearer {settings.api_key}",  # Get your key at https://hud.so
                        "Mcp-Image": "hudpython/hud-text-2048:v1.2"  # Docker image from https://hub.docker.com/u/hudpython
                    }
                }
            },
            "evaluate_tool": {"name": "evaluate", "arguments": {"name": "max_number", "arguments": {"target": 64}}},
        }
        task = Task(**task)

        # 1. Define the client explicitly:
        client = MCPClient(mcp_config=task.mcp_config)
        agent = ClaudeAgent(
            mcp_client=client,
            model="claude-sonnet-4-20250514",  # requires ANTHROPIC_API_KEY
        )

        result = await agent.run(task)

        # 2. Or just:
        # result = await ClaudeAgent().run(task)

        print(f"Reward: {result.reward}")
        await client.shutdown()

asyncio.run(main())

The above example let's the agent play 2048 (See replay)

Agent playing 2048

Quickstart: Training

RL using GRPO a Qwen2.5-VL model on any hud dataset:

hud get hud-evals/2048-basic # from HF
hud rl 2048-basic.json

See agent training docs

Or make your own environment and dataset:

hud init my-env && cd my-env
hud dev --interactive
# When ready to run:
hud rl

See environment design docs

Benchmarking Agents

This is Claude Computer Use running on our proprietary financial analyst benchmark SheetBench-50:

Trace screenshot

See this trace on hud.so

This example runs the full dataset (only takes ~20 minutes) using run_evaluation.py:

python examples/run_evaluation.py hud-evals/SheetBench-50 --full --agent claude

Or in code:

import asyncio
from hud.datasets import run_dataset
from hud.agents import ClaudeAgent

results = await run_dataset(
    name="My SheetBench-50 Evaluation",
    dataset="hud-evals/SheetBench-50",      # <-- HuggingFace dataset
    agent_class=ClaudeAgent,                # <-- Your custom agent can replace this (see https://docs.hud.so/evaluate-agents/create-agents)
    agent_config={"model": "claude-sonnet-4-20250514"},
    max_concurrent=50,
    max_steps=30,
)
print(f"Average reward: {sum(r.reward for r in results) / len(results):.2f}")

Running a dataset creates a job and streams results to the hud.so platform for analysis and leaderboard submission.

Building Environments (MCP)

This is how you can make any environment into an interactable one in 5 steps:

  1. Define MCP server layer using MCPServer
from hud.server import MCPServer
from hud.tools import HudComputerTool

mcp = MCPServer("My Environment")

# Add hud tools (see all tools: https://docs.hud.so/reference/tools)
mcp.tool(HudComputerTool())

# Or custom tools (see https://docs.hud.so/build-environments/adapting-software)
@mcp.tool("launch_app"):
def launch_app(name: str = "Gmail")
...

if __name__ == "__main__":
    mcp.run()
  1. Write a simple Dockerfile that installs packages and runs:
CMD ["python", "-m", "hud_controller.server"]

And build the image:

hud build # runs docker build under the hood

Or run it in interactible mode

hud dev
  1. Debug it with the CLI to see if it launches:
$ hud debug my-name/my-environment:latest

โœ“ Phase 1: Docker image exists
โœ“ Phase 2: MCP server responds to initialize 
โœ“ Phase 3: Tools are discoverable
โœ“ Phase 4: Basic tool execution works
โœ“ Phase 5: Parallel performance is good

Progress: [โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ] 5/5 phases (100%)
โœ… All phases completed successfully!

Analyze it to see if all tools appear:

$ hud analyze hudpython/hud-remote-browser:latest
โ  โœ“ Analysis complete
...
Tools
โ”œโ”€โ”€ Regular Tools
โ”‚   โ”œโ”€โ”€ computer
โ”‚   โ”‚   โ””โ”€โ”€ Control computer with mouse, keyboard, and screenshots
...
โ””โ”€โ”€ Hub Tools
    โ”œโ”€โ”€ setup
    โ”‚   โ”œโ”€โ”€ navigate_to_url
    โ”‚   โ”œโ”€โ”€ set_cookies
    โ”‚   โ”œโ”€โ”€ ...
    โ””โ”€โ”€ evaluate
        โ”œโ”€โ”€ url_match
        โ”œโ”€โ”€ page_contains
        โ”œโ”€โ”€ cookie_exists
        โ”œโ”€โ”€ ...

๐Ÿ“ก Telemetry Data
 Live URL  https://live.anchorbrowser.io?sessionId=abc123def456
  1. When the tests pass, push it up to the docker registry:
hud push # needs docker login, hud api key
  1. Now you can use mcp.hud.so to launch 100s of instances of this environment in parallel with any agent, and see everything live on hud.so:
from hud.agents import ClaudeAgent

result = await ClaudeAgent().run({  # See all agents: https://docs.hud.so/reference/agents
    "prompt": "Please explore this environment",
    "mcp_config": {
        "my-environment": {
            "url": "https://mcp.hud.so/v3/mcp",
            "headers": {
                "Authorization": f"Bearer {os.getenv('HUD_API_KEY')}",
                "Mcp-Image": "my-name/my-environment:latest"
            }
        }
        # "my-environment": { # or use hud run which wraps local and remote running
        #     "cmd": "hud",
        #     "args": [
        #         "run",
        #         "my-name/my-environment:latest",
        #     ]
        # }
    }
})

See the full environment design guide and common pitfalls in environments/README.md

Leaderboards & benchmarks

All leaderboards are publicly available on hud.so/leaderboards (see docs)

Leaderboard

We highly suggest running 3-5 evaluations per dataset for the most consistent results across multiple jobs.

Using the run_dataset function with a HuggingFace dataset automatically assigns your job to that leaderboard page, and allows you to create a scorecard out of it:

Reinforcement Learning with GRPO

This is a Qwenโ€‘2.5โ€‘VLโ€‘3B agent training a policy on the 2048-basic browser environment:

RL curve

Train with the new interactive hud rl flow:

# Install CLI
uv tool install hud-python

# Option A: Run directly from a HuggingFace dataset
hud rl hud-evals/2048-basic

# Option B: Download first, modify, then train
hud get hud-evals/2048-basic
hud rl 2048-basic.json

# Optional: baseline evaluation
hud eval 2048-basic.json

Supports multiโ€‘turn RL for both:

  • Languageโ€‘only models (e.g., Qwen/Qwen2.5-7B-Instruct)
  • Visionโ€‘Language models (e.g., Qwen/Qwen2.5-VL-3B-Instruct)

By default, hud rl provisions a persistent server and trainer in the cloud, streams telemetry to hud.so, and lets you monitor/manage models at hud.so/models. Use --local to run entirely on your machines (typically 2+ GPUs: one for vLLM, the rest for training).

Any HUD MCP environment and evaluation works with our RL pipeline (including remote configurations). See the guided docs: https://docs.hud.so/train-agents/quickstart.

Pricing: Hosted vLLM and training GPU rates are listed in the Training Quickstart โ†’ Pricing. Manage billing at the HUD billing dashboard.

Architecture

%%{init: {"theme": "neutral", "themeVariables": {"fontSize": "14px"}} }%%
graph LR
    subgraph "Platform"
        Dashboard["๐Ÿ“Š hud.so"]
        API["๐Ÿ”Œ mcp.hud.so"]
    end
  
    subgraph "hud"
        Agent["๐Ÿค– Agent"]
        Task["๐Ÿ“‹ Task"]
        SDK["๐Ÿ“ฆ SDK"]
    end
  
    subgraph "Environments"
        LocalEnv["๐Ÿ–ฅ๏ธ Local Docker<br/>(Development)"]
        RemoteEnv["โ˜๏ธ Remote Docker<br/>(100s Parallel)"]
    end
  
    subgraph "otel"
        Trace["๐Ÿ“ก Traces & Metrics"]
    end
  
    Dataset["๐Ÿ“š Dataset<br/>(HuggingFace)"]
  
    AnyMCP["๐Ÿ”— Any MCP Client<br/>(Cursor, Claude, Custom)"]
  
    Agent <--> SDK
    Task --> SDK
    Dataset <-.-> Task
    SDK <-->|"MCP"| LocalEnv
    SDK <-->|"MCP"| API
    API  <-->|"MCP"| RemoteEnv
    SDK  --> Trace
    Trace --> Dashboard
    AnyMCP -->|"MCP"| API
  

CLI reference

Command Purpose Docs
hud init Create new environment with boilerplate. ๐Ÿ“–
hud dev Hot-reload development with Docker. ๐Ÿ“–
hud build Build image and generate lock file. ๐Ÿ“–
hud push Share environment to registry. ๐Ÿ“–
hud pull <target> Get environment from registry. ๐Ÿ“–
hud analyze <image> Discover tools, resources, and metadata. ๐Ÿ“–
hud debug <image> Five-phase health check of an environment. ๐Ÿ“–
hud run <image> Run MCP server locally or remotely. ๐Ÿ“–

Roadmap

  • Merging our forks in to the main mcp, mcp_use repositories
  • Helpers for building new environments (see current guide)
  • Integrations with every major agent framework
  • Evaluation environment registry
  • MCP opentelemetry standard

Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

Key areas:

Thanks to all our contributors!

Citation

@software{hud2025agentevalplatform,
  author = {HUD and Jay Ram and Lorenss Martinsons and Parth Patel and Oskars Putans and Govind Pimpale and Mayank Singamreddy and Nguyen Nhat Minh},
  title  = {HUD: An Evaluation Platform for Agents},
  date   = {2025-04},
  url    = {https://github.com/hud-evals/hud-python},
  langid = {en}
}

License: HUD is released under the MIT License โ€“ see the LICENSE file for details.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hud_python-0.4.61.tar.gz (465.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hud_python-0.4.61-py3-none-any.whl (574.2 kB view details)

Uploaded Python 3

File details

Details for the file hud_python-0.4.61.tar.gz.

File metadata

  • Download URL: hud_python-0.4.61.tar.gz
  • Upload date:
  • Size: 465.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.7

File hashes

Hashes for hud_python-0.4.61.tar.gz
Algorithm Hash digest
SHA256 fa40108b415bbb5437e6d9587024ea88ea69b62d649bb75583e94cc2f3e92f41
MD5 a5c4393f7ed334af8ca6db1420bf7428
BLAKE2b-256 af731285eeaed67d0db7d9775d5575c128e956edb266762022bc56a85cbb643f

See more details on using hashes here.

File details

Details for the file hud_python-0.4.61-py3-none-any.whl.

File metadata

File hashes

Hashes for hud_python-0.4.61-py3-none-any.whl
Algorithm Hash digest
SHA256 5c651766a7d54d9dc4a98035e03ac7b1355a7cf24585db21dd401a660ef5d4ec
MD5 b522a97d26f0554f8a35eda0514c5dc1
BLAKE2b-256 30539a9c8ac9cfe4d0d68c7fcdde842416c4db30cb73894b8760c4d03a5b6a00

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page