hyperloom-setup

name	hyperloom-setup
description	Configure Hyperloom in the current agent workspace after pip install --target . by collecting LLM settings, choosing a bare-metal or Docker run mode, writing .env, and running the setup backend on baremetal hosts only.

Hyperloom Setup

Use this skill after the user prepares a dedicated workspace, opens that directory in the agent, and installs Hyperloom into the current directory:

pip install your_package.whl --target .

The current directory is the Hyperloom workspace and install target. It is normal for this directory to contain many Python package folders; users do not need to inspect them. Do not use an existing project directory unless the user accepts that setup may create or update .env in that directory.

This skill should normally run once per workspace. It resolves a run mode into HYPERLOOM_RUN_MODE (baremetal or docker) for this session. In baremetal mode it runs the setup backend on the host; in docker mode it writes .env only. It does not start any container. Whether to generate or run a Docker container is decided later by the example (workload) skill based on HYPERLOOM_RUN_MODE.

• baremetal: the host provides ROCm, and setup can optionally install the SGLang or vLLM framework layer.
• docker: writes .env and records the run mode; the example (workload) skill starts the container and runs setup inside it.

Run Mode Resolution

Resolve the run mode in this order and skip the interactive question when a value is already present:

1. HYPERLOOM_RUN_MODE in the shell environment (baremetal or docker).
2. Otherwise, ask the user (Step 2 question 5).

HYPERLOOM_RUN_MODE is a value resolved for this session from the shell environment. Keep it for the current run; the example (workload) skill uses it to decide whether to generate a container (and which image to use). This skill does not start a container itself.

Workflow

You must run this as an interactive onboarding flow. Do not stop after listing required values. Ask the user each question, collect the answer, warn before writing .env, write .env, read it back for validation, and continue to the setup command. If setup already completed for this workspace and the user is not changing provider, model, USER_DATA_PATH, run mode, Docker target host, or bare-metal framework setup choice, do not run setup again; continue with the demo skill using the existing .env.

Step 1: Confirm Workspace

Confirm the current directory is the dedicated Hyperloom workspace selected by the user and contains a hyperloom/ Python package directory from pip install --target ..

If hyperloom/ is missing, do not search for or switch to another target directory. Tell the user to open the intended dedicated workspace in the agent and install Hyperloom into that current directory:

pip install hyperloom-inference-optimizer==1.0.0 --target .

Then stop and ask the user to rerun /hyperloom-setup from that workspace.

Step 2: Ask Configuration Questions

Use the agent's structured question UI (option cards) for every question. It requires at least two options per question, so for a free-form value (base URL, custom model id) present two options — Use default (<value>) and Custom — and only when the user picks Custom ask a plain-text follow-up for the exact value.

1. Ask the Anthropic base URL with the structured UI.

   • Present exactly these three option labels in this order:
     • Use default (https://api.anthropic.com) — this remains the recommended default.
     • Use AMD gateway (https://llm-api.amd.com/anthropic).
     • Custom.
   • If the user picks Custom, ask a plain-text follow-up for the URL.

2. Explain that secrets must be edited in .env, not pasted into chat.

   • Never ask the user to paste API keys into the conversation.
   • Create .env with placeholders for secret values.
   • Ask the user to edit .env directly and replace placeholders.
   • After the user confirms the file is edited, validate only whether secret keys are set; do not print secret values.

3. Collect non-secret values and write secret placeholders:

   Ask the base URL and model questions below with the structured UI using two options — Use default (<value>) and Custom — and only ask a plain-text follow-up for the exact value when the user picks Custom.

   • Write ANTHROPIC_API_KEY=<PLEASE_FILL_IN> unless already set to a non-placeholder value.
   • Ask ANTHROPIC_BASE_URL with exactly these option labels in this order: Use default (https://api.anthropic.com) / Use AMD gateway (https://llm-api.amd.com/anthropic) / Custom.
   • Ask CLAUDE_MODEL: options Use default (claude-opus-5) / Custom.

4. Explain USER_DATA_PATH:

   • It is the writable root for Hyperloom runtime files, dependency checkouts, logs, optimizer runs, and generated env files.
   • Offer <workspace>/session (the current workspace directory plus a session subdirectory) as the default/recommended option, using its absolute path. Each optimizer run still creates its own UTC-stamped subdirectory under it.
   • If an existing USER_DATA_PATH is visible in the current shell or terminal context, offer that exact value as one option.
   • Always offer a custom path option.
   • Do not auto-select; write only after the user explicitly chooses (they may accept the default).

Step 3: Write .env

Create or update .env in the current directory.

Before writing, explicitly tell the user:

• .env will be created or updated in the current workspace.

• If .env already exists, unrelated keys are preserved, but Hyperloom setup keys selected in this run will be updated.

• A dedicated workspace is recommended to avoid modifying an existing project's .env.

• For every value the user chose in this run (base URL, model, run mode, USER_DATA_PATH, Docker target host), write exactly what the user selected. This wins over any pre-existing value in .env or the shell environment — e.g. if the user picked the Anthropic official URL, write ANTHROPIC_BASE_URL=https://api.anthropic.com even when a different ANTHROPIC_BASE_URL already exists.

• Preserve existing keys unrelated to this setup.

• Never print secret values back to the user.

• Do not overwrite an existing non-placeholder secret key.

Write the Anthropic keys plus the common keys:

• Anthropic: ANTHROPIC_API_KEY, ANTHROPIC_BASE_URL, CLAUDE_MODEL.

Common keys:

• USER_DATA_PATH
• HYPERLOOM_RUN_MODE (baremetal or docker, the resolved run mode for this session)
• HYPERLOOM_DOCKER_TARGET_HOST (only when HYPERLOOM_RUN_MODE=docker; the host where the demo skill should run Docker)
• HYPERLOOM_SKILL_PATH — absolute path to the optimizer skill (<workspace>/hyperloom/inference_optimizer/SKILL.md for a wheel install, <workspace>/src/hyperloom/inference_optimizer/SKILL.md for a source checkout). Write it in both modes so the demo skill can resolve it even when docker mode skips the host setup backend.

AMD APIM subscription header

If the chosen base URL host is llm-api.amd.com, that gateway requires the API key to also be sent as an Ocp-Apim-Subscription-Key header. Write the custom-headers key as a reference to the same API key, so the user only fills one secret:

ANTHROPIC_CUSTOM_HEADERS="Ocp-Apim-Subscription-Key: ${ANTHROPIC_API_KEY}"

The value must be wrapped in double quotes: the setup backend and launch scripts may load .env with a shell source, so an unquoted value containing a space and a colon (Ocp-Apim-Subscription-Key: ...) is parsed as a command and fails with exit 127.

Skip this key entirely when the selected Anthropic base URL host is not llm-api.amd.com.

After writing .env, tell the user to edit the file directly and replace each <PLEASE_FILL_IN> placeholder. Wait for the user to confirm before running setup.

Then read .env back and confirm:

• non-secret values are correct;
• secret values are set or missing;
• no secret key still equals <PLEASE_FILL_IN>.

If any required secret is missing or still a placeholder, stop and ask the user to edit .env again.

Step 4: Run Setup Backend

In baremetal mode, run the backend on the host. The --install-framework value is the framework the user chose in Step 2 (none / vllm / sglang). In docker mode, skip the backend on the host (see below).

baremetal

Run the backend directly in the current directory on the host, passing the framework the user chose in Step 2.

For none:

export REPO_ROOT="$(pwd -P)"
PYTHONPATH="$REPO_ROOT" python3 -m hyperloom.inference_optimizer.setup -- --install-framework none --yes

For vllm (installs into an isolated venv; --install-framework vllm already defaults to isolated, the flag below is explicit):

export REPO_ROOT="$(pwd -P)"
PYTHONPATH="$REPO_ROOT" python3 -m hyperloom.inference_optimizer.setup -- --install-framework vllm --framework-env isolated --yes

For sglang:

export REPO_ROOT="$(pwd -P)"
PYTHONPATH="$REPO_ROOT" python3 -m hyperloom.inference_optimizer.setup -- --install-framework sglang --yes

Skipping the framework install leaves the host without one, and optimize then stops at preflight rather than failing later inside the benchmark. Install it here, or point BENCHMARK_BASE_URL at a server that already runs elsewhere. As a last resort HYPERLOOM_SKIP_FRAMEWORK_CHECK=1 drops that check.

docker

Do not run hyperloom.inference_optimizer.setup on the host. The example (workload) skill will start the container and run setup inside it.

After writing .env, tell the user:

• setup on the host is skipped in docker mode;
• the demo skill will docker run + docker exec setup inside the ROCm container;
• FRAMEWORK being unset after this skill is expected.

This skill does not start a container. HYPERLOOM_RUN_MODE is recorded so the example (workload) skill can decide whether to generate a Docker container when it runs the optimization.

Step 5: Confirm Detected Framework

In baremetal mode, after setup completes, the backend writes the detected serving framework to FRAMEWORK in .env (sglang or vllm). In docker mode, skip this until the demo skill runs setup inside the container. Read .env back and check it:

• If FRAMEWORK is set, report it. Downstream demo skills read this value.
• If HYPERLOOM_RUN_MODE is docker, an unset FRAMEWORK is expected: the container has not run yet, so the host has no importable serving framework. Tell the user the example (workload) skill will detect or provide the framework when it starts the container. Do not offer to re-run setup with --install-framework sglang or vllm.
• If HYPERLOOM_RUN_MODE is baremetal and FRAMEWORK is missing or empty, no serving framework was importable on the host (e.g. --install-framework none without SGLang/vLLM installed). Tell the user that demo skills needing a framework will not run until one is installed, and offer to re-run setup with --install-framework vllm or sglang. Do not invent a FRAMEWORK value.

Step 6: Report Result

Report:

• The .env path.
• The run mode (baremetal or docker).
• The Docker target host when HYPERLOOM_RUN_MODE=docker.
• The setup command that was run (or that host setup was skipped in docker mode).
• Whether setup completed or failed (in docker mode, report that host setup was skipped).
• The detected FRAMEWORK value (or that it is unset).
• The last relevant error lines on failure.

Do not print secret values back to the user.

Step 7: Hand Off to a Demo Skill

When setup completed in baremetal mode, or when .env is written in docker mode, ask the user whether they want to run a demo optimization now, and if so which option:

• 3h — short, no-kernel run. Best for a first end-to-end check.
• 12h — medium-length Qwen3-14B-FP8 run.
• custom advanced — user-selected model, framework, workload, budget, phase toggles, and advanced CLI flags.

If the user wants to run a custom model with a preset workload, keep using one of the fixed demo presets. Ask the user for a local model path, confirm that the directory exists and contains config.json, then export MODEL_PATH=<that path> before loading the selected demo skill. Explain that the model path is replaced, but the selected fixed demo still owns the workload preset: tensor parallelism, concurrency, input/output lengths, precision, target gain, and run budget are not retuned. If the user wants to choose those workload values explicitly, load the custom advanced demo skill instead.

If the user declines, stop here. If HYPERLOOM_RUN_MODE is baremetal and FRAMEWORK is unset, do not offer a demo; tell the user to install a serving framework first (see Step 5).

When the user picks a length, load the matching demo skill and follow it — you stop acting on this setup skill and run the demo skill's instructions instead:

The demo skills are installed under each agent's discovery dir (.agents/skills/, .claude/skills/, .cursor/skills/); load the matching one by name:

• 3h → hyperloom-qwen3-8b-3h
• 12h → hyperloom-qwen3-14b-fp8-12h
• custom advanced → hyperloom-custom-advanced

The demo skill reads the values already in .env (LLM keys/base URLs, FRAMEWORK, USER_DATA_PATH). Fixed presets do not ask the user to re-enter workload settings. The custom advanced skill reuses setup values, then asks for workload and phase choices. It resolves the optimizer skill from .env HYPERLOOM_SKILL_PATH (written by Step 3).