Compare commits

..

618 Commits

Author SHA1 Message Date
Yuge Zhang 8435586d14 Bump version to 1.0.1 (#562) 2026-08-24 16:58:17 +08:00
Yuge Zhang 65df6ab599 Rewrite the skills README around how the skill works (#552)
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-24 16:50:57 +08:00
dalongbao 6f44dcbf68 fix: alfworld benchmark graph (#554)
Co-authored-by: dalongbao <v-tinyantsui@microsoft.com>
Co-authored-by: Yuge Zhang <scottyugochang@gmail.com>
2026-08-24 11:39:59 +08:00
Yuge Zhang 2bd0875fd3 Harden release skill guidance (#555) 2026-08-24 11:37:22 +08:00
Yuge Zhang 217d8a55a3 Add complete PyPI project metadata (#556) 2026-08-24 11:23:53 +08:00
Yuge Zhang c632d8dd80 Restore Python lint checks and extend them to the verl subtree (#553)
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-22 10:08:06 +08:00
Yuge Zhang 07c4ce894d Correct the release skill's tag-trigger model and commands (#550)
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-21 20:30:00 +08:00
Yuge Zhang 4123f0c3bf Validate every skill, including .agents/skills, in CI (#551)
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-21 16:58:38 +08:00
Yuge Zhang 30e675906f Add release skill (#549) 2026-08-21 15:45:18 +08:00
Yuge Zhang 5415d850af Migrate release and test workflows for v1 (#548) 2026-08-21 10:31:28 +08:00
Dan Fiedler 8e22ca1902 Pin GitHub Actions to full-length commit SHAs (#546) 2026-08-20 12:42:33 +08:00
Zhiyuan He bd80905120 Docs/add v1 technical report links (#545)
Co-authored-by: GitHub Actions <actions@github.com>
2026-08-19 12:24:04 +08:00
dalongbao 352f1bd7c1 docs: simplify benchmark results (#540)
Co-authored-by: dalongbao <v-tinyantsui@microsoft.com>
2026-08-17 16:29:46 +08:00
Zhiyuan He 2914f3e2ef Docs/update readme stable docs link (#544)
Co-authored-by: GitHub Actions <actions@github.com>
2026-08-17 15:02:48 +08:00
Copilot 5e9c711724 Fix docs deploy dependency setup (#543) 2026-08-17 12:54:17 +08:00
Zhiyuan He 8f8b8f95fd Merge pull request #539 from microsoft/dev/v1.0.0
Upgrade to v1.0.0
2026-08-17 12:37:06 +08:00
hzy46 0eb4af11f9 docs: update architecture diagram 2026-08-17 12:35:33 +08:00
dalongbao d2c4d1f630 feat: agl-skill (#534)
Co-authored-by: dalongbao <v-tinyantsui@microsoft.com>
2026-08-14 12:47:18 +08:00
hzy46 d1d6895782 docs: update legacy branch links 2026-08-13 12:27:35 +08:00
hzy46 5361ade1e5 docs: restore security policy 2026-08-12 17:16:38 +08:00
hzy46 b2ca3a50af docs: update documentation for v1.0 2026-08-12 17:10:22 +08:00
hzy46 5b6fd360f2 Merge remote-tracking branch 'agl-lite/main' into dev/v1.0.0 2026-08-12 15:46:28 +08:00
hzy46 f033bb2cb8 chore: remove legacy implementation and documentation 2026-08-12 15:46:12 +08:00
Zhiyuan He 68cef03c03 Rename package to Agent Lightning (#50)
* Rename package to Agent Lightning

* Keep package initialization minimal
2026-08-12 14:27:23 +08:00
Zhiyuan He b81c9b8e69 docs: add documentation index (#49) 2026-08-11 18:34:41 +08:00
Zhiyuan He ea4e49993d Docs, License, Copyright (#48)
* docs: add agl-lite documentation

* docs: refine project messaging

* docs: refresh project overview and examples

* Update README.md

* docs: adopt Agent Lightning v1.0 branding

* Update README.md

* docs & license

* Tune SWE-smith turn penalty

* Reorganize example documentation

* Refine README tagline

* docs: reorganize setup and configuration guides

* docs: clarify shared gateway key

* docs: simplify configuration and async training guides
2026-08-11 18:30:09 +08:00
Ldemon df20382d21 feat: add rollout-level mean policy loss (#47)
Register a VERL policy loss that gives each rollout equal weight across its expanded training rows. Normalize advantages by rollout token count and trained batch size, and load the custom loss in Ray actor workers.

Add focused coverage for registration, normalization, PPO aggregation, and input validation.
2026-08-11 11:03:59 +08:00
Zhiyuan He 5b7b4bb7cc refactor: simplify rollout integration code (#46) 2026-08-10 14:57:58 +08:00
Zhiyuan He 4a052204fa Fix no-batch rollout replica sleep (#45) 2026-07-16 21:24:28 +08:00
Ldemon 4a610aee27 feat(async_swe_smith): online GRPO training example for SWE-smith (#34)
* example/async_swe_smith: online GRPO training example for SWE-smith

Add an end-to-end async GRPO example that trains a SWE agent on the
SWE-smith dataset via agl-lite, plus supporting infrastructure:

- examples/async_swe_smith: agent, chat template, k8s job template,
  image pre-pull, FSDP + Megatron trainers, Qwen3-30B-A3B / Qwen3.5-9B
  launch scripts, README, and a smoke test.
- agl_lite/verl/trainer.py: per-step GRPO group / zero-advantage group
  counts and a per-stage perf/mfu/actor_infer metric.
- examples/calc_x/comparison: async-vs-sync runner scripts.

Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>

* feat(verl): record per-rollout pod lifecycle timing

Capture server-authoritative running_at/finished_at while polling and
emit, per training step, a wandb Table of per-rollout submitted/running/
finished timestamps plus queue-wait/run-duration scalar aggregates. The
queue wait (running_at - submitted) exposes how long pods sit waiting
when jobs are launched in CPU-limited batches.

Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>

* fix(setup_verl): install matching CUDA 13.0 toolchain for cu130 flash-attn build

The cu130 variant builds flash-attn from source against torch's CUDA 13.0
runtime, but the system CUDA toolkit is often 12.x, so nvcc rejects the
build. Install a CUDA 13.0 pip toolchain (nvcc/crt/nvvm/cccl/runtime) pinned
to >=13.0,<13.1 and point the build at it via CUDA_HOME/PATH/LIBRARY_PATH/
LD_LIBRARY_PATH/CPATH. Pinning to 13.0.x keeps nvcc's version aligned with
torch's CUDART (13000); a mismatched minor (e.g. 13.3) trips cccl's
"CUDA compiler and CUDA toolkit headers are incompatible" check.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* smaller cpu request

* feat(async_swe_smith): add Qwen3-8B sync-rollout trainer launch script

Mirrors the async async_swe_smith_qwen3_8b run (wandb fxaj7bcw) but flips
agentlightning.async_rollout.enabled=False for synchronous rollouts, keeping
all other hyperparameters identical (TP=2, GRPO n=8, train_batch_size=32,
ppo_micro_batch_size_per_gpu=2, lr=1e-6, clip 0.2/0.28, max_model_len=32768).
rollout.mode stays async (vLLM OpenAI server mode for tool calling). Sizing
knobs are env-overridable (AGL_GPU_MEM_UTIL, AGL_ROLLOUT_TP, etc.).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* example/async_swe_smith: add Qwen3-8B async runner; enable chunked prefill

Add run_qwen3_8b_async.sh (async counterpart of run_qwen3_8b_sync.sh):
identical training hyperparameters, only agentlightning.async_rollout.
enabled=True, for the sync-vs-async speedup A/B. Also flip the example's
vLLM enable_chunked_prefill to True.

Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>

* example/async_swe_smith: lower agent pod memory limit to 2Gi

Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>

* example/async_swe_smith: expose train/async batch sizes as env-overridable knobs

Surface data.train_batch_size (32) and async_rollout.async_train_batch_size
(48) in run_qwen3_8b_async.sh via AGL_TRAIN_BATCH_SIZE / AGL_ASYNC_TRAIN_BATCH_SIZE,
passed through SIZING_OVERRIDES. Also bump default total_epochs 2 -> 4.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* example/async_swe_smith: disable chunked prefill + val-before-train; add requirements.txt

Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>

* update config

* smaller poll interval for less cpu pressure

* example/async_swe_smith: auto-create AGL_NAMESPACE before controller start

The controller does not create its target namespace; with a non-default
AGL_NAMESPACE the ConfigMap step would fail on a missing namespace. Ensure
it idempotently before launch so per-user namespace isolation works.

Co-Authored-By: Claude Opus 4 (1M context) <noreply@anthropic.com>

* example/async_swe_smith: add openai-preinstalled job template variant

Uses the :openai SWE-smith images (openai library baked in) and drops the runtime 'pip install openai', removing the per-rollout cold-start cost.

* async_swe_smith: use openai-preinstalled job template for training

Point the async trainer at job-template-openai.yaml (":openai" images
with the openai library prebuilt) so rollout pods skip the runtime
pip install openai and start the agent directly.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* example/async_swe_smith: add Qwen3-30B-A3B Megatron/R3 async runner

Conservative single-node 4x B200 defaults (n=4, gpu_mem_util=0.6,
train_batch=16, full param/optim/grad offload + recompute) sized to fit
30B-A3B; all knobs env-overridable. Set vLLM moe_backend=triton.

Co-Authored-By: Claude <noreply@anthropic.com>

* async_swe_smith: support explicit pre-split train/val datasets

Add --train-dataset-path / --val-dataset-path (default to
train_datasets.jsonl / val_datasets.jsonl) so the trainer consumes
pre-split, pre-curated datasets as-is: no FAIL_TO_PASS curation and no
train/val split. Falls back to the legacy single-file + split path when
those files are absent. Adds --max-val-instances to bound validation
eval time.

Large local datasets (subset0 / train / val .jsonl) are excluded via
.git/info/exclude rather than .gitignore, so this drops the tracked
subset0 ignore line.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* async_swe_smith: support explicit pre-split train/val datasets in megatron entrypoint

Mirror the load_split_file path from train_smith_agent.py (27ec14d) into the
Megatron+R3 entrypoint: add --train-dataset-path/--val-dataset-path/
--max-val-instances and consume the pre-split files as-is (no FAIL_TO_PASS
curation, no internal train/val split) when both exist, else fall back to the
single-file split. Also add --ci so the run script's smoke flag is a real arg
instead of leaking into the hydra config overrides.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* async_swe_smith: add rollout correction (IS/RS) knobs to megatron runner

Wire algorithm.rollout_correction.* (bypass_mode / rollout_is / rollout_rs
and thresholds) into the Qwen3-30B-A3B megatron runner as env-overridable
sizing overrides, mirroring uni-agent's train_qwen3_moe_rc.sh defaults.
loss_mode is left at the actor default (verl 0.8.0 has no gspo).

Co-Authored-By: Claude <noreply@anthropic.com>

* async_swe_smith: match fsdp rollout sizing in megatron runner

Bump default ROLLOUT_N 4->8, TRAIN_BATCH_SIZE 16->32, ASYNC_TRAIN_BATCH_SIZE
24->48 to mirror the fsdp distributed run's rollout workload, enabling an
apples-to-apples engine comparison at equal generation volume.

Co-Authored-By: Claude <noreply@anthropic.com>

* async_swe_smith: standardize wandb experiment naming

Name runs as swe_smith_{sync|async}_{model}_{backend} so FSDP and Megatron
runs are distinguishable in wandb. Mode is read from rollout.mode, model
from the basename of the model path; backend is fsdp / megatron per script.

Co-Authored-By: Claude <noreply@anthropic.com>

* async_swe_smith: add pure-rollout collection harness

Collect reward (all-0/all-1 GRPO degeneration), completion-token length, and
turn-count stats over the train/val datasets without running a VERL trainer.

- serve_vllm_qwen3_8b.sh: stand up Qwen3-8B vLLM (128K ctx, chunked prefill,
  TP=1, CUDA graph, hermes tools, return-tokens-as-token-ids) and register it
  with the server proxy via POST /api/models.
- enqueue_rollouts.py: POST each dataset row N times (GRPO group) to
  /api/rollouts with the openai job template + is_train flag.
- rollout_stats.py: poll finished rollouts, aggregate from reward/model_request/
  agent_output events, group by data_id, report train/val separately.
- job-template-openai.yaml: SMITH_MAX_TURNS=1000 so turns (not the 40-cap) bound
  self-completion.
- rollout_test.md: design doc.

Co-Authored-By: Claude <noreply@anthropic.com>

* async_swe_smith: retry reward post until it succeeds

Reward events are training signal, so a single timeout silently dropped
the sample. Retry with capped exponential backoff until the post lands.

Co-Authored-By: Claude <noreply@anthropic.com>

* async_swe_smith: full-run coverage for pure-rollout stats harness

The rollout_stats collector previously polled GET /api/rollouts?state_in=
succeeded&failed&limit=10000. That list route returns matches[:limit] in
insertion order with no offset, and each rollout is ~77KB (job_template is
embedded), so for the 164k-rollout SWE-smith run stats would silently plateau
at ~10k terminal rollouts (~6% of the run) — never seeing later completions.

Server: add an append-only completion log (_terminal_order, appended on
terminal state transitions in patch_rollout) and a cursor-paginated, lightweight
projection endpoint GET /api/rollouts/terminal?after=&limit= returning only
rollout_id/state/data_id/is_train + a next_after cursor. Because the log is
ordered by completion, an index cursor never misses out-of-order completions
and needs no full rescan of the store.

Collector: drain the cursor instead of re-listing; O(page_size) work per poll,
no 10k cap. Atomic snapshot writes (tmp + os.replace), per-rollout event-fetch
retry that skips unreadable rollouts without stalling the cursor, and a
--page-size flag. Snapshot now reports processed/total_terminal/backlog.

serve_vllm_qwen3_8b.sh: Qwen3-8B native ctx is 40960 and vLLM 0.20.2 dropped
--rope-scaling, so --max-model-len 131072 was rejected outright. Add YaRN via
--hf-overrides (factor 4.0 over original 32768) when extending beyond native
context — the documented 128K goal now actually serves.

Tests: cover the new endpoint (completion-order pagination, cursor advance,
projection fields, non-terminal exclusion); reset _terminal_order between tests.
.gitignore: ignore the generated rollout_stats.json output.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* async_swe_smith: checkout bug branch so the agent sees the injected bug

The SWE-smith image defaults /testbed to clean `main`, so the agent saw fixed
code, had nothing to fix, and evaluate() false-passed (reward 1.0 on a 0-byte
patch). Now the agent checks out the bug branch HEAD (`Remove F2P Tests`):
buggy source with the FAIL_TO_PASS tests removed, so it cannot read the tests
to reverse the fix. At evaluation time the F2P test files are restored from the
parent `Bug Patch` commit, keeping the agent's edits, so the real
FAIL_TO_PASS/PASS_TO_PASS suite runs against the fix.

Co-Authored-By: Claude <noreply@anthropic.com>

* Align SWE-smith agent loop with mini-swe-agent

Replace OpenAI tool-calling with mini-swe-agent's text/bash action space:
- one bash code block per turn (parse_action); submit via the
  COMPLETE_TASK_AND_SUBMIT_FINAL_OUTPUT marker instead of a submit tool
- swebench-style system/instance prompts adapted for /testbed
- head/tail observation elision + format-error nudges (max_format_errors)
- execute commands via 'bash -c' with pagers/progress bars silenced

Keeps AGL glue (events, eval-meta, bug-commit checkout, F2P restore,
git-diff patch capture, FAIL_TO_PASS/PASS_TO_PASS eval) and the
context-overflow / transient-error loop contracts. Adds SMITH_MAX_FORMAT_ERRORS.

* async_swe_smith: distinguish eval timeout from real failure + rollout tooling

- smith_agent: evaluate() now flags eval_timeout (pytest rc=124 / "timed out"),
  surfaced in the reward event; fix p2p_ok counting None status as PASSED (which
  let timeouts false-pass as resolved). Set temperature=1.0 explicitly; cap
  SMITH_MAX_TURNS at 100 in job-template-openai.
- rollout_stats: tolerate transient connection errors (RemoteDisconnected).
- add monitor_controller.sh (periodic health probe), trace.md (4-rollout trace
  example), reward_table.md (per-instance reward/patch snapshot).

Co-Authored-By: Claude <noreply@anthropic.com>

* async_swe_smith: add SWE-smith --f2p_only eval mode (on by default)

Mirror swesmith/harness/grading.py: when f2p_only, restrict evaluation to the
test files containing FAIL_TO_PASS. F2P is kept whole; PASS_TO_PASS is filtered
to only the P2P tests in those same files — same-file regressions still count,
but the many unrelated cross-file P2P tests (the eval-time/timeout driver) are
dropped. Resolution still needs F2P AND filtered P2P to pass. Toggled by
SMITH_F2P_ONLY (default on).

Co-Authored-By: Claude <noreply@anthropic.com>

* async_swe_smith: add rollout-collection runbook + full f2p_only result table

- plan.md: end-to-end runbook for launching a local pure-rollout collection
  batch (cold-start vLLM/server/controller, enqueue, monitor, gold-patch
  comparison), with the known pitfalls and how to run the second half.
- reward_table.md: full 367-instance agent-vs-gold patch comparison under
  official f2p_only (all-0 98.1%, eval timeouts 0/1468).

Co-Authored-By: Claude <noreply@anthropic.com>

* async_swe_smith: lightweight branch switch to avoid checkout timeouts

git checkout --force <branch> stats/rewrites the whole /testbed working tree
(thousands of files for repos like pandas), which times out under high pod
concurrency (node at 6x oversubscription) and fails jobs. Instead, diff
main..branch at the object level to get just the changed files and apply only
those: modified/added paths via checkout, deleted F2P tests via git rm. All
git calls now go through a retry helper. Measured 1234ms -> 32ms on pandas;
working-tree state is identical to the old full checkout.

Co-Authored-By: Claude <noreply@anthropic.com>

* feat(swe-smith): Qwen3.5-9B pure-rollout eval + 8B vs 9B reward table

- 4x vLLM Qwen3.5-9B (TP=1, round-robin) pure-rollout over subset0
- gen_compare_table.py / gen_reward_table_9b.py reward-table builders
- reward_table.md: 8B(all-0 98%) vs 9B(~47%), 116/230 improved
- baseline 8B table snapshot; trainer wandb table trimmed; async sizing

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* swe-smith: per-call max_tokens 16384, vLLM ctx 128k for 9B rollout

- smith_agent default AGL_MAX_TOKENS 4096->16384
- job-template-openai: AGL_MAX_TOKENS=16384 env
- vLLM restarted max_model_len 131072 (4x, registered)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix shuffling issue & zero sample issue

* async_swe_smith: align reward with official XFAIL grading + 128k train ctx

Count XFAIL as pass (F2P/P2P) to match swesmith/harness/grading.py; set
data/trajectory max lengths to 65536 = 128k. Add event-driven fail/starve
pod watcher.

Co-Authored-By: Claude <noreply@anthropic.com>

* swe-smith: reward_table 9B 321/367, add per-rollout total token length

- gen_compare_table: 9B total-len column (avg) + p50/p90/max summary
- 9B vs 8B: all-0 98%->52%, improved 147, regress 0

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* swe-smith: annotate units in reward_table (patch=bytes, total=tokens)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* async_swe_smith: tee rollout pod logs to hostPath for post-mortem

Mount host /agl-logs and tee stdout/stderr to agl-rollout-<id>.log so a
killed/evicted pod's trace survives the TTL reaper. Both templates.

Co-Authored-By: Claude <noreply@anthropic.com>

* async_swe_smith: bump pod memory to 4Gi to stop OOMKills

Long 128k-ctx trajectories were killed at 2Gi. Raise request+limit to 4Gi.

Co-Authored-By: Claude <noreply@anthropic.com>

* refactor: promote async SWE-smith example

Rename async_swe_smith to swe_smith, update startup docs/scripts, and prepare local :openai rollout images from minikube-loaded tags.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* feat: log trace merge mismatches to wandb

Record capped unmerged trajectory triplets as a wandb table and expose mismatch row metrics from the rollout adapter.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* async_swe_smith: add delete.jsonl — instances with missing bug branches

35 instances across 11 repos (mostly Go) whose images lack the
origin/<instance_id> branch, so checkout fails with "unknown revision"
and the rollout dies before turn 1. Listed for dataset filtering.

Co-Authored-By: Claude <noreply@anthropic.com>

* async_swe_smith: wait out gateway pause instead of burning a turn

On 429 'gateway paused' (async weight sync), the agent now retries in place
every 5s up to SMITH_GATEWAY_WAIT_S (default 600s) without incrementing the
turn or appending an empty assistant message. Previously the pause was
treated as a generic error, burning turns and polluting the trajectory.

Co-Authored-By: Claude <noreply@anthropic.com>

* async_swe_smith: harden fetch_eval_meta against transient server errors

RemoteDisconnected escaped the except (it is http.client.HTTPException, not
URLError) and crashed the agent; timeouts were swallowed but left instance_id
empty, wasting a full rollout until checkout failed. Catch connection-reset /
HTTP exceptions, retry 4x with backoff for the bursty transient failures, and
abort immediately when no instance_id can be fetched instead of running on.

Co-Authored-By: Claude <noreply@anthropic.com>

* async_swe_smith: force pytest serial in eval to stop OOMKills

The eval pytest command passed no -n flag, so a testbed project's own config
(e.g. scipy's `-n auto`) spawned workers = HOST core count (dozens), ignoring
the pod's cpu:1 / 4Gi cgroup. ~70 python workers @ ~112MB each exhausted the
4Gi limit and triggered cgroup OOMKill mid-rollout — verified live: OOMed pods
had 70+ python procs, memory.current pinned at 4094/4096Mi. Append `-p no:xdist`
to disable the plugin (overrides any ini `-n auto`; no-op when xdist absent).
Confirmed fixed: new pods now run 1 python proc instead of 70.

Co-Authored-By: Claude <noreply@anthropic.com>

* async_swe_smith: update reward_table.md — Qwen3.5-9B pure-rollout (620 instances)

Snapshot of the in-progress Qwen3.5-9B pure-rollout collection over
train_datasets.jsonl (is_train=false, n=4 GRPO groups), throttled to 50
in-flight. 620 instances / 2490 rollouts terminal so far; all-0 544, all-1 51,
mixed 25; 0 eval timeouts (SMITH_EVAL_TIMEOUT=3000, SMITH_MAX_TURNS=100).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* async_swe_smith: cap pytest at -n4, bump pod mem 6Gi, throttle job rate

Eval-time OOMKills traced to testbed `-n auto` reading host cores (~70 xdist
workers) and busting the cgroup. Pin -n4 (~450MB) with serial fallback when
xdist is absent. Raise pod memory to 6Gi and lower max_jobs_per_minute to 100.

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: harden SWE-smith rollout checkout

* docs: document SWE-smith Qwen3.5 sync run

* swe_smith: point hostPath logs at host dir after kubeadm migration

minikube is replaced by a kubeadm single-node cluster, so pods run directly
on host docker. hostPath /agl-logs (minikube VM path) now points at the real
host dir /home/v-zhiwenzhou/agl-logs — no minikube mount needed. Also lower
openai template pod memory to 4Gi.

Co-Authored-By: Claude <noreply@anthropic.com>

* swe_smith: update reward_table.md — Qwen3.5-9B pure-rollout (7300 instances)

Snapshot of the Qwen3.5-9B pure-rollout collection over the verified + full
train datasets (is_train=false, n=4 GRPO groups), throttled to 50 in-flight,
deduped by data_id. 7300 instances / 29174 rollouts: all-0 4510 (61.8%),
all-1 1667 (22.8%), mixed 1123 (15.4%); 50 eval timeouts
(SMITH_EVAL_TIMEOUT=3000, SMITH_MAX_TURNS=100).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* swe_smith: store reward table as SQLite db, drop markdown

Switch the reward table from reward_table.md to reward_table.db (SQLite).
Column names match the old markdown detail table exactly: instance, rollouts,
"r=0", "r=1", "分类", "best patch_size", "avg turns", "超时".

gen_reward_db.py is incremental — it caches each terminal rollout by id in a
rollout_events table and only fetches events for NEW rollouts, so a refresh
takes ~7s instead of ~10min at 30k+ rollouts. reward_table is rebuilt from
rollout_events (is_train=0, grouped by data_id).

Snapshot: 30905 rollouts / 7718 instances (all-0 4606, all-1 1893, mixed 1219).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* swe_smith: retry idempotent /proxy/pause with 5min timeout; pod mem 6Gi

/proxy/pause only sets state.paused=True (idempotent, lock-guarded), so retrying
is safe. When the server is saturated with in-flight rollouts the pause POST can
be slow to get a connection and the default 30s timeout is not enough — give it
300s and 5 retries with backoff. Also bump openai template pod memory to 6Gi
(kernel OOM traced anon-rss ~4.1GB busting the 4Gi limit).

Co-Authored-By: Claude <noreply@anthropic.com>

* swe_smith: self-documenting timestamped run logs in launcher

Redirect each role's stdout+stderr to a timestamped file
(/tmp/agl_logs/{role}_{model}_{YYYYmmdd-HHMMSS}.log) with a stable
{role}_latest.log symlink, so repeated server/trainer restarts no longer
overwrite each other's logs. A fixed name like /tmp/train_9b_async.log
silently loses the previous run's crash trace on relaunch.

Opt out with AGL_LOG_TO_FILE=0; override dir/name via AGL_LOG_DIR/AGL_LOG_FILE;
auto-skipped for --ci smoke tests.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: dedupe triplet model requests by prompt tokens

* feat: add retry logic to non-GET HTTP requests to harden the trainer

Make every non-GET request in the trainer process resilient to transient
failures so a single HTTP error can no longer crash training mid-step:

- register_model (POST /api/models): retry with backoff (idempotent upsert)
- _resume_gateway (POST /proxy/resume): retry with backoff (idempotent)
- _create_rollouts (POST /api/rollouts): pre-assign client rollout_ids and
  retry; server-side enqueue is now idempotent (existing id returns the
  existing rollout, events untouched), so retries never duplicate rollouts
- delete_model / _delete_rollout: best-effort, swallow errors
- add DELETE /rollouts/{id} (idempotent, cascades to events) and delete
  completed rollouts from the managers to keep server-side state bounded

Also switch AglLiteSyncClient's retrying GET to print over logging for
consistency with the rest of the codebase.

Co-Authored-By: Claude <noreply@anthropic.com>

* swe_smith: prevent git-history reward hacking in smith_agent

SWE-smith testbed repos ship the full git history, so the agent can recover
the injected-bug fix (and the deleted FAIL_TO_PASS tests) via
`git checkout <pre-bug-sha> -- <src>` / `git show` / `git log -p`. On the
Qwen3.5-9B run this inflated val/reward to ~0.80 (96% of resolved val rollouts
used the git hack; ~0% solved cleanly).

Agent-side mitigation:
- relocate_git(): move /testbed/.git out of the worktree after checkout (O(1)
  same-fs rename); the harness still reaches it via _git_base()
  (--git-dir/--work-tree) for restore_f2p_tests + capture_patch.
- _forbidden_action(): reject any agent command that invokes git or reads git
  metadata (.git / --git-dir / the relocated dir), returned as an observation;
  wired into run_agent_loop before _run.
- _agent_env(): strip SMITH_HIDDEN_GIT_DIR and any var leaking the path so the
  relocated dir is invisible in the pod env.
- Drop the git-based submission step from the prompt (harness captures the
  patch independently) and note that git is disabled.

Verified on 50 random val instances (base Qwen3.5-9B, isolated pods):
relocation 50/50 (O(1)), 0 leaks, 0 false-positive blocks; submission and
eval/patch-capture work via --git-dir; blocked git attempts recover to manual
edits without hindering legitimate solves.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* feat: log rollout trajectories as wandb artifacts

* feat: add rollout DELETE endpoint and auto-cleanup in rollout managers

Add DELETE /rollouts/{rollout_id} (idempotent, cascades to events) and a
retrying GET on AglLiteSyncClient. Sync manager deletes each round's
completed rollouts; async manager deletes non-carry-over groups on
completion, keeping server-side state bounded during training.

Co-Authored-By: Claude <noreply@anthropic.com>
(cherry picked from commit 149400351dc1fe16c2bd98a0a8eae34d3931da85)

* feat: add retry logic to non-GET HTTP requests to harden the trainer

Make every non-GET request in the trainer process resilient to transient
failures so a single HTTP error can no longer crash training mid-step:

- register_model (POST /api/models): retry with backoff (idempotent upsert)
- _resume_gateway (POST /proxy/resume): retry with backoff (idempotent)
- _create_rollouts (POST /api/rollouts): pre-assign client rollout_ids and
  retry; server-side enqueue is now idempotent (existing id returns the
  existing rollout, events untouched), so retries never duplicate rollouts
- delete_model / _delete_rollout: best-effort, swallow errors
- add DELETE /rollouts/{id} (idempotent, cascades to events) and delete
  completed rollouts from the managers to keep server-side state bounded

Also switch AglLiteSyncClient's retrying GET to print over logging for
consistency with the rest of the codebase.

Co-Authored-By: Claude <noreply@anthropic.com>
(cherry picked from commit 137506f293f5287ee62dcacdab358c43f9c40825)

* fix: align rollout cleanup retry merge

* swe_smith: update reward_table.db — 24836 instances (85% of verified)

Qwen3.5-9B pure-rollout over train_dataset_verified.jsonl (is_train=false, n=4,
throttled 50 in-flight, deduped by data_id). 99647 rollouts / 24836 instances:
all-0 13789 (55.5%), all-1 6575 (26.5%), mixed 4472 (18.0%).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* swe_smith: lower pod memory request to 2Gi, keep 6Gi limit

request=limit=6Gi over-reserved: the scheduler pinned ~83 pods against the
node's 510Gi allocatable while pods actually use ~1-2GB, leaving CPU at 16%
and 150Gi RAM idle. Drop request to 2Gi so more pods schedule; keep limit at
6Gi so long-trajectory pods (kernel-observed anon-rss ~4.1GB) don't OOM.

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: route rollouts deterministically by rollout_id hash for prefix caching

Replace round-robin server selection with a stable sha256(rollout_id) mod
pool-size mapping so every request from a rollout lands on the same endpoint,
maximizing prefix-cache hits. Sort the pool by endpoint to keep the mapping
independent of registration order.

Co-Authored-By: Claude <noreply@anthropic.com>

* Log compact rollout trajectory artifacts

* swe_smith: lower pod memory request to 1Gi, keep 6Gi limit

Co-Authored-By: Claude <noreply@anthropic.com>

* swe_smith: Qwen3.5-9B run defaults + tighten token caps, drop internal plan.md

- run_qwen3_8b_async.sh: default model Qwen3-8B->Qwen3.5-9B, max_model_len
  32768->65536, expose AGL_ROLLOUT_N, tie ppo_mini_batch_size to train_batch_size,
  async overrides (val_before_train=False, test_freq=-1), run-name qwen35_9b_async.
- job-template-openai.yaml: AGL_MAX_TOKENS 16384->12288, add SMITH_OBS_CHAR_CAP=6000
  to keep agent trajectories shorter under the 65536 context window.
- remove examples/swe_smith/plan.md (internal planning notes, not shipped code).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Update SWE-smith training settings

* swe_smith: final Qwen3.5-9B reward table + 5245 mixed instances

Collection complete over train_dataset_verified.jsonl (is_train=false, n=4,
throttled 50 in-flight, deduped by data_id via reward db). Final:
29976 instances / 120283 rollouts — all-0 17109 (57.1%), all-1 7622 (25.4%),
mixed 5245 (17.5%). 82.5% are degenerate (zero GRPO advantage); the 5245 mixed
instances are the trainable set.

- reward_table.db: final SQLite snapshot (30MB).
- mixed_instance_ids.txt: the 5245 mixed data_ids (instances with GRPO signal).
- enqueue_throttled.py: throttled enqueuer with --skip-from-db (dedup that
  survives a server restart — needed after the in-memory store was wiped).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* swe_smith: prune unused scripts, add log/reward analysis tooling

- Remove no-longer-used enqueue/gen/monitor/serve scripts and stale docs.
- job-template-openai: point rollout-logs hostPath at /agl-logs (minikube 9p
  mountpoint) so pod logs reach the host under the docker driver.
- Add filter.md (full->verified dataset filtering rationale), scan_abnormal_pods.sh
  (k8s abnormal-pod probe), stat_pod_logs.sh (bulk pod-log anomaly stats), and
  report_qwen35_9b.md (Qwen3.5-9B rollout report: 34% resolve, 83% ctx overflow).

Co-Authored-By: Claude <noreply@anthropic.com>

* swe_smith: remove unused pod monitoring/log scripts

Co-Authored-By: Claude <noreply@anthropic.com>

* Add SWE Verify checkpoint evaluation

* Add B200 Qwen3.5-9B vLLM pure-decode roofline benchmark

Measure single-card B200 decode performance vs theoretical roofline for
Qwen3.5-9B (hybrid GatedDeltaNet + full-attention). Includes:
- theoretical roofline (mem/compute roofs, ridge, TPOT floor)
- batch sweep + context sweep via latency-subtraction (pure decode isolation)
- reusable bench + plot scripts, CSV data, roofline.png, README + summary

Key: ~24k tok/s/card decode ceiling (21% of compute roof); batch-1 at 51%
of bandwidth roof (hybrid recurrent-state overhead); empirical ridge ~batch
32-64; context 128->64k drops 4x but <=4k near-lossless (hybrid KV advantage).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* roofline: document measured HBM BW / BF16 TFLOPS in README

Roof charts & theory keep datasheet spec (8.0 TB/s, 2250 TFLOPS) per roofline
convention. Add README section 1.4 with empirically-measured achievable ceilings
(HBM 7.11 TB/s = 89% of spec; BF16 dense 1623 TFLOPS = 72% of spec) plus two
reusable microbenchmark scripts, so real attainment can be cross-referenced
(batch-1 = 57% of measured BW roof; batch-256 = 29% of measured compute roof).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Add per-step + per-minute rollout stats collector with long-tail metrics

Instrumentation for the async-GRPO SWE-smith run (Qwen3.5-9B, 4xB200) to
quantify per-vLLM-call long tails and their effect on rollout throughput.

- collect_rollout_stats.py: 60s collector writing two tables from vLLM
  Prometheus histograms (e2e latency, response/prompt tokens).
- rollout_step_stats: per-call avg prompt/resp len, per-card out tokens +
  throughput, max response, and per-call long-tail percentiles
  (resp_tok/e2e_lat p50/p90/p99 + tail_ratio_lat_p99_p50).
- gen_window_throughput: per-~60s throughput time-series inside each gen
  window, showing tail-segment collapse.
- rollout_stats.db: 18 step rows + 177 per-minute rows.
- README documents schema + findings: per-call e2e p99/p50 ~12-18x every
  step (driven by ~21x response-token tail); within-window throughput
  collapses 88-99.7% from peak; effective throughput ~62% of peak.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* swe_smith: reward==1 long-turn penalty + val temperature 0.7; prune scratch files

- smith_agent.py: add length_penalized_reward() that penalizes ONLY solved
  (reward==1) trajectories: reward = 1 - λ·clip((n_turns-T0)/(max_turns-T0),0,1);
  run_agent_loop now returns (submitted, turns_used). Tunable via env
  SMITH_LEN_PEN_T0 (default 55) / SMITH_LEN_PEN_LAMBDA (default 0.2). Reports
  raw_value + n_turns on the reward event for monitoring.
- job-template-openai.yaml: surface SMITH_LEN_PEN_T0=55 / SMITH_LEN_PEN_LAMBDA=0.2.
- tests: cover the penalty (solved-only, within-budget, ramp-to-cap, degenerate
  span) and unpack the new run_agent_loop tuple.
- server.yaml: default_proxy.val.temperature 0 -> 0.7 (validation samples at 0.7).
- README: add `export FLA_TILELANG=0` to the run recipe.
- Remove scratch/dev files (enqueue_rollouts.py, rollout_stats.py, gen_*.py,
  monitor_controller.sh, run_qwen3_8b_async.sh, serve_vllm_qwen3_8b.sh,
  watch_failpods.sh, reward_table.db, reward_table_8b_baseline.md, rollout_test.md,
  delete.jsonl).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* swe_smith: update mixed_instance_ids.txt to 5407 (add 162 rescued from 128k rerun)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* swe_smith: block network-based reward hacking (NetworkPolicy + agent guards)

Agents were downloading upstream correct source (curl raw.githubusercontent,
pip install <target pkg>, wget, urllib) to overwrite the buggy file — ~26% of
rollouts — after git was already blocked. Two layers now cut this off:

- Network root fix: deploy Calico VXLAN (replacing flannel, which cannot enforce
  NetworkPolicy) + default-deny egress that only allows the agl-lite server IP,
  so pods have no public internet. See canal.md for the full deploy/verify/
  rollback runbook. Adds canal-policy-only.yaml, networkpolicy-egress-lockdown.yaml,
  and an app=agl-rollout label on the job template pod.
- Code backstop: extend smith_agent.py _forbidden_action to reject curl/wget/
  pip-install/urllib and test-harness file writes (conftest/pytest.ini/
  sitecustomize), and align the prompt (drop "you may install it").

Also enables fused kernels in the train configs (unrelated perf tweak).

Co-Authored-By: Claude <noreply@anthropic.com>

* swe_smith: gate long-turn penalty to training only; README -> mixed dataset

- smith_agent.py: length_penalized_reward() now takes is_train and only shapes
  reward when is_train AND solved. Validation reward stays the true, unshaped
  metric (it drives checkpoint selection). main() derives is_train from
  AGL_OPENAI_BASE_URL (/mode/train/ marker; fail-safe: never penalize val) and
  logs mode. Fixes the earlier bug where the penalty applied to val too.
- tests: pass is_train explicitly; add test_length_penalty_skips_validation
  asserting val reward is never reshaped (even a long solved rollout keeps 1.0).
- README: point the active Qwen3.5-9B recipe at train_dataset_mixed.jsonl (6343
  instances = mixed_dataset minus the 3 network-dependent repos dspy/pydantic/
  MONAI whose eval needs runtime pip install and breaks once pods are offline).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* swe_smith: add prompt-length penalty (plan B) + align train config to bh103or9

Penalize context bloat on SOLVED training rollouts: track the largest
server-reported usage.prompt_tokens per rollout (no local tokenizer) and
subtract up to 0.1 as the longest prompt grows from 50K to 64K tokens.
Gated on raw solved status so it stacks with the long-turn penalty (plan A)
and never reshapes validation reward. Tunable via SMITH_PROMPT_PEN_*.

Align train config to the bh103or9 run: model Qwen3.5-9B, gpu_mem_util 0.8,
max_num_batched_tokens 8192, ppo_max_token_len_per_gpu 16384.

Co-Authored-By: Claude <noreply@anthropic.com>

* add max_ppo_update_times

* Merge rollout-level advantage computation (cherry-pick ee78dbe)

Add optional rollout-level advantage (algorithm.enable_rollout_level_advantage)
and its module + tests, wired into AglLiteRayPPOTrainer alongside the existing
compute_advantage path. Cherry-picked from SiweiPro's ee78dbe to take only the
advantage change without the unrelated swe_verify work on that branch.

Co-Authored-By: SiweiPro <18474108006@163.com>
Co-Authored-By: Claude <noreply@anthropic.com>

* swe_smith: turn penalty T0=80, enable max_ppo_update_times=2 + bypass_mode

- Long-turn penalty now starts at 80 turns (was 55), max penalty 0.2 at the
  100-turn cap.
- Set agentlightning.max_ppo_update_times=2 to bound PPO updates per step.
- Enable rollout_correction.bypass_mode: reuse rollout log-probs as old_log_prob
  for importance sampling, skipping the old-logprob forward pass.

Co-Authored-By: Claude <noreply@anthropic.com>

* swe_smith: untrack examples/swe_smith/infra (local-only tooling)

Roofline benchmarks + rollout-stats tooling are local infra, not part of the
training example. Remove from the tree and exclude locally so they stay off origin.

Co-Authored-By: Claude <noreply@anthropic.com>

* swe_smith: untrack reward_table.db (large local-only artifact)

30MB reward cache is a local build artifact, not source. Remove from the tree
and exclude locally so it stays off origin.

Co-Authored-By: Claude <noreply@anthropic.com>

* swe_smith / swe_verify: untrack local-only files (docs, dataset curation, network policies, comparison scripts, swe_verify example)

Move these to .git/info/exclude so they stay off origin while remaining local:
- examples/swe_verify/  (7 files, plus tests/examples/test_swe_verify.py to avoid CI ImportError)
- examples/swe_smith/README.md
- examples/swe_smith/canal.md, filter.md, report_qwen35_9b.md  (internal notes)
- examples/swe_smith/canal-policy-only.yaml, networkpolicy-egress-lockdown.yaml
  (cluster-specific network policies)
- examples/swe_smith/mixed_instance_ids.txt  (local dataset curation, 5407 rows)
- examples/calc_x/comparison/  (local benchmark scripts)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4 (1M context) <noreply@anthropic.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: hzy46 <362583303@qq.com>
Co-authored-by: SiweiPro <18474108006@163.com>
2026-07-16 16:28:53 +08:00
Zhiyuan He f0a77cfad7 docs: update AgentOS package name (#532)
Deploy Documentation / deploy (push) Has been cancelled
Dashboard / Chromatic (push) Has been cancelled
CPU Test / Lint - fast (push) Has been cancelled
CPU Test / Lint - next (push) Has been cancelled
CPU Test / Lint - slow (push) Has been cancelled
CPU Test / Lint - JavaScript (push) Has been cancelled
CPU Test / Build documentation (push) Has been cancelled
CPU Test / Test (AgentOps, legacy, Python 3.10) (push) Has been cancelled
CPU Test / Test (LLM proxy, legacy, Python 3.10) (push) Has been cancelled
CPU Test / Test (Others, legacy, Python 3.10) (push) Has been cancelled
CPU Test / Test (Store, legacy, Python 3.10) (push) Has been cancelled
CPU Test / Test (Utilities, legacy, Python 3.10) (push) Has been cancelled
CPU Test / Test (Weave, legacy, Python 3.10) (push) Has been cancelled
CPU Test / Test (AgentOps, stable, Python 3.11) (push) Has been cancelled
CPU Test / Test (LLM proxy, stable, Python 3.11) (push) Has been cancelled
CPU Test / Test (Others, stable, Python 3.11) (push) Has been cancelled
CPU Test / Test (Store, stable, Python 3.11) (push) Has been cancelled
CPU Test / Test (Utilities, stable, Python 3.11) (push) Has been cancelled
CPU Test / Test (Weave, stable, Python 3.11) (push) Has been cancelled
CPU Test / Test (AgentOps, stable, Python 3.12) (push) Has been cancelled
CPU Test / Test (LLM proxy, stable, Python 3.12) (push) Has been cancelled
CPU Test / Test (Others, stable, Python 3.12) (push) Has been cancelled
CPU Test / Test (Store, stable, Python 3.12) (push) Has been cancelled
CPU Test / Test (Utilities, stable, Python 3.12) (push) Has been cancelled
CPU Test / Test (Weave, stable, Python 3.12) (push) Has been cancelled
CPU Test / Test (AgentOps, latest, Python 3.13) (push) Has been cancelled
CPU Test / Test (LLM proxy, latest, Python 3.13) (push) Has been cancelled
CPU Test / Test (Others, latest, Python 3.13) (push) Has been cancelled
CPU Test / Test (Store, latest, Python 3.13) (push) Has been cancelled
CPU Test / Test (Utilities, latest, Python 3.13) (push) Has been cancelled
CPU Test / Test (Weave, latest, Python 3.13) (push) Has been cancelled
CPU Test / Test (JavaScript) (push) Has been cancelled
2026-07-16 03:25:46 +00:00
Zhiyuan He d6df2e584d Search r1 completion api (#44)
* Add Search-R1 completion API agent

* End Search-R1 rollouts on invalid action
2026-07-16 11:03:01 +08:00
Zhiyuan He 8fd5bd8ea1 add completion api (#43) 2026-07-15 16:54:01 +08:00
Zhiyuan He ee8d8ff828 fix shuffling issue & zero sample issue (#41) 2026-06-29 15:28:40 +08:00
Ldemon aa6ab2c654 Fix empty triplets from model errors (#39) 2026-06-16 13:59:09 +08:00
Zhiyuan He 9e6ed8f8b5 Clean hooks (#38) 2026-06-10 15:30:11 +08:00
Zhiyuan He fdf8ec957d Clean legacy example & tests (#37) 2026-06-10 15:12:32 +08:00
Zhiyuan He f195883f95 Support verl==0.8.0 (#36) 2026-06-10 15:10:09 +08:00
Zhiyuan He ec5e62aadb Clean installation & documentation (#35)
* chore: simplify installation dependencies

* chore: simplify verl installation scripts

* docs: add installation guide

* docs: remove verl sync warning

* fix: use local calc-x data paths

* chore: streamline verl setup

* docs: clarify verl cuda variants
2026-06-09 20:55:33 +08:00
Zhiyuan He 7bfb0e7b15 Refactor verl part (#31) 2026-06-09 11:37:08 +08:00
Siwei Zhang 9fcb436b1a Update Search-R1 Llama 3 defaults (#32)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-05 11:48:04 +08:00
Siwei Zhang ee707b6626 feat: add search_r1 example (#30)
* feat: add search_r1 example

* Handle null rollout metadata

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-04 11:49:48 +08:00
Ldemon 0b44d5d5d3 feat(is): bypass-mode rollout importance-sampling + science_world async training (#27)
* feat(is): add bypass-mode rollout importance-sampling support

Capture chosen-token rollout logprobs end to end and feed them into VERL
bypass mode so old_log_probs = rollout_log_probs, avoiding actor recompute.

- proxy: inject logprobs=True on train-mode requests
- events: extract finite chosen-token logprobs (chat + completions schemas);
  never fail the triplet query on bad logprobs, report status/error instead
- rollout_bridge: thread response_log_probs through triplets/trace/trajectory,
  pad/truncate in lockstep with response_mask, fill masked/dropped positions
  with finite 0.0, drop rows with missing/invalid/length-mismatched logprobs
  (with metrics), emit float32 rollout_log_probs only when present
- trainer: import apply_bypass_mode; in _async_train_step, when bypass_mode is
  enabled, require finite rollout_log_probs and skip _compute_old_log_prob

* feat(science_world): enable bypass-mode rollout correction (IS)

Add algorithm.rollout_correction with bypass_mode + ppo_clip so the
science_world example trains using rollout logprobs (RS/IS off for first pass).
2026-06-03 15:25:57 +08:00
Zhiyuan He 77001e158d Merge pull request #29 from agent-lightning/zhiyuhe/fix_typo
fix typo and clean deploy folder
2026-06-03 11:54:09 +08:00
hzy46 e1d42667c8 fix typo and clean deploy folder 2026-06-03 11:52:44 +08:00
Zhiyuan He 398dabfc91 Merge pull request #28 from agent-lightning/agl-lite-llm-sandbox
fix: llm-in-sandbox-minikube
2026-06-03 11:34:36 +08:00
SiweiPro 1e63f4b89c fix: llm-in-sandbox-minikube
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-02 20:13:21 -07:00
hzy46 2955648c69 fix: polish agl lite 2026-06-02 03:35:37 +00:00
SiweiPro 8c0f2dcc77 feat: add llm-in-sandbox verl example 2026-06-02 03:35:34 +00:00
hzy46 d95c303a8b feat: refactor agl lite 2026-06-02 03:34:48 +00:00
ldemon eca8429228 fix(async_rollout): reset vLLM engine state on val→train boundary
When test_freq fires inside async_fit(), validation runs through the legacy
_rollout(is_train=False) path which ends with abort_all_requests(). Without
a subsequent update_weights() call, vLLM 0.7.1+ engines can stay paused and
the next step's resume_generation() does not recover them. Observed as the
step-32→33 deadlock: all rollout replicas hang at 20:42:17Z, training enters
a 16-hour zombie state with succeeded=82, timeout_rollouts growing by 256
per step, reward=0, grad_norm=0, and global_seqlen=32 (placeholder-only).

train→train avoids this because _async_train_step always ends with
sleep_replicas() + update_weights(global_steps), which forces a vLLM
engine state refresh while vLLM is offloaded. val→train must do the same
explicitly. Snapshot/restore of the async carry-over bridge state
(_validate_preserving_async_carry_over) was already in place; the missing
piece was the engine reset itself.

The reset must call sleep_replicas() BEFORE update_weights(): the reset
runs while vLLM is still awake holding weights + KV cache on GPU, and
FSDP's state_dict() unshard collides with vLLM's resident memory during
DTensor redistribute() — observed OOM at step 32→33 on 40 GB A100s with
GPU 0 at 39.49 GB used / 29.88 MiB free, vLLM TP worker holding 26.94 GiB,
FSDP unshard needing ~12.48 GiB. Mirror the train→train cycle pattern
(sleep_replicas() then update_weights()) so vLLM frees its weights + KV
cache before FSDP gathers params for IPC.

Tests:
- positive: drive async_fit through one train step plus a test_freq-
  triggered validation; assert sleep_replicas runs between val_rollout
  and the engine-reset update_weights(global_steps) call.
- negative: assert no spurious engine reset (neither sleep_replicas nor
  extra update_weights) fires on non-val steps — a stray reset would
  leave vLLM paused without a wake_up partner.
Verified the positive test fails on the pre-fix code with the intended
assertion message.

Co-Authored-By: Claude Opus 4 <noreply@anthropic.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-05-27 08:40:24 +00:00
ldemon b260ed4d5a feat: add local mode for async calc-x example
- add CalcXAgent adapter for local_worker

- add run.sh --local to start serve plus local controller

- document local mode and declare calculator MCP dependency

Tests: bash -n examples/async_calc_x/run.sh

Tests: uv run pytest tests/examples/test_async_calc_x_agent.py tests/controller/test_local_worker.py -q

Manual: AGL_HOST_PORT=18080 examples/async_calc_x/run.sh --local --ci-fast
2026-05-27 05:02:01 +00:00
ldemon e444cab8c7 feat(science_world): tune for 8x A100, split train/val temperature, inject AGL_IS_TRAIN
- tune .env.example, train_sw_agent.py, run.sh for 8x A100
- split train/val temperature in sw_agent.py
- expand README with the new sizing/temperature guidance
- LocalReconciler: inject AGL_IS_TRAIN=1|0 into rollout subprocess env so
  the agent can branch behavior (e.g. sampling temperature) on train vs val
2026-05-27 05:02:01 +00:00
ldemon 04eabd9fc6 fix: harden async rollout carry-over flow, unblock SW pipeline, export AGL_HOOKS
- reject carry-over saturation instead of allowing n_new=0 paths
- apply enqueue hooks through the shared async enqueue builder
- LocalReconciler: break out of reconcile loop on stop, _shutdown reaps
  finished procs before SIGKILL, _startup_cleanup carries job_name,
  cache narrowed pool_size/agent_class fields, _admit_queuing short-circuits
  on stop, register SIGTERM/SIGINT signal handlers in cli.py
- verl trainer: unblock ScienceWorld training pipeline (server/app.py and
  rollout_bridge.py wiring fixes)
- examples/science_world/run.sh: export AGL_HOOKS so trainer rollout bridge
  can locate the hooks module
2026-05-27 05:02:01 +00:00
Zhiyuan He 7789a86280 Merge pull request #20 from agent-lightning/feat/record_entropy_v2
feat: record VERL actor entropy
2026-05-25 15:55:39 +08:00
SiweiPro bc809ec535 feat: record verl actor entropy 2026-05-25 00:36:08 -07:00
Zhiyuan He 675767e197 Merge pull request #16 from agent-lightning/feat/process_pool
feat: local process pool runner + ScienceWorld example
2026-05-22 12:45:15 +08:00
Zhiyuan He 9303317969 Merge pull request #13 from agent-lightning/fix/vllm-pause-and-resume
fix: vllm pause and resume
2026-05-22 11:58:58 +08:00
Zhiyuan He 5ac5e8ae02 Merge branch 'main' into fix/vllm-pause-and-resume 2026-05-22 11:58:43 +08:00
Zhiyuan He bfbcf3c903 Merge pull request #4 from agent-lightning/feat/add-reward-metrics-in-logs
feat: add reward metrics in logs
2026-05-22 11:46:38 +08:00
Zhiyuan He 4a27e1cbe5 Merge branch 'main' into feat/add-reward-metrics-in-logs 2026-05-22 11:46:26 +08:00
Zhiyuan He 4e3e924e52 Merge pull request #5 from agent-lightning/feat/wandb_support
feat/wandb_support
2026-05-22 11:44:40 +08:00
Zhiyuan He 28376d57d7 Merge branch 'main' into feat/wandb_support 2026-05-22 11:44:23 +08:00
Zhiyuan He a6d1994646 Merge pull request #14 from agent-lightning/fix/verl_steup
fix: update verl setup dependencies
2026-05-22 11:35:41 +08:00
ldemon 97f846bf74 fix: harden client/server against httpx keep-alive race
Fixes a crash that brought down a long-running ScienceWorld GRPO RL
training job at step 92/124 (~5h 56min in) on 8xA100. Root cause was a
plain HTTP/1.1 keep-alive race between the trainer's httpx pool and the
agl-lite uvicorn server, not OOM or any GPU/CPU memory leak (verified:
GPU max_memory_allocated was a flat 20.8026 GB across all 92 steps).

Trigger
-------
The Ray-driven `_AglTaskRunner` actor uses a long-lived
`AglLiteClient` (httpx.AsyncClient) to poll `/api/rollouts/{rid}` and
post events to the server. Between bursts of traffic an idle pooled
socket can sit unused for >5s. uvicorn's default `timeout_keep_alive`
is 5s, so the server half-closes the connection. The very next request
that reuses the (now stale) socket fails at the transport layer with
`httpx.ReadError` ("Server disconnected without sending a response") or
`httpx.RemoteProtocolError` -- before the client has any HTTP-level
signal to act on.

Impact
------
Before this fix, a single transient transport error propagated
straight up the call stack:
  httpx.ReadError
  -> raises out of `_AglTaskRunner.run.remote(...)`
  -> `ray.get(...)` reraises as `RayTaskError(ReadError)`
  -> Python driver exits, atexit triggers `ray.shutdown()`
     (exit_type=INTENDED_USER_EXIT)
  -> GCS marks the job finished and force-kills *every* actor:
     8x vLLM HttpServer, 8x FSDP workers, the _AglTaskRunner actor
  -> raylet receives SIGTERM ~150ms later
  -> entire training job dies
On the 5/21 run this happened at 17:25:17.344 UTC at step 92, after
a successful POST to vLLM 50ms earlier. No checkpoint between
step_64 and step_92 was saved.

Fix (layered defense)
---------------------
1. Server side: bump `timeout_keep_alive` from the uvicorn default of
   5s to 120s in `agl_lite/cli.py::serve`. This eliminates the race
   in the common case for poll-heavy clients.

2. Client side: add `_RetryingTransport`, an
   `httpx.AsyncBaseTransport` wrapper around the default async
   transport that retries on transient transport errors
   (`ConnectError`, `ReadError`, `WriteError`, `RemoteProtocolError`,
   `PoolTimeout`) with exponential backoff (0.1, 0.2, 0.4, 0.8s; max
   4 attempts). HTTP-level errors (4xx/5xx) are *not* retried -- they
   are returned as-is so application code keeps full control.
   Wiring is centralized in `AglLiteClient.__init__`, so all ~20
   existing call sites benefit automatically; tests that inject their
   own `httpx.AsyncClient` (e.g. via `httpx.ASGITransport`) are
   unaffected because the wrapper is only installed when `client is
   None`.

Retrying POSTs is safe in this design: by definition a transport
error happens before any response headers arrive, so the server has
not produced any application-visible side effect for this request.

Tests
-----
- `tests/test_client.py::TestRetryingTransport`: 4 new tests cover
  retry-then-succeed (ReadError + RemoteProtocolError), retry on
  ConnectError, raising after exhausting attempts, and *not* retrying
  application-level 500 responses.
- Full unit suite (375 tests) passes; ruff + pyright clean on touched
  files.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-05-22 03:27:14 +00:00
ldemon 6fcbcd5913 feat: add local process pool runner + ScienceWorld example 2026-05-22 03:27:14 +00:00
SiweiPro fce6e1fde9 fix: update verl setup dependencies
Update the pinned VERL GPU stack and force flash-attn to build against the final torch ABI so the setup script installs a consistent environment.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-21 02:07:28 -07:00
SiweiPro 46d8df5ee8 fix: vllm pause and resume 2026-05-21 01:58:03 -07:00
Zhiyuan He a939ed97d9 Merge pull request #6 from agent-lightning/feat/async
feat: async rollout training pipeline
2026-05-19 14:55:18 +08:00
ldemon 1b8b0e05fc feat: async rollout training pipeline
Add async rollout path: sample_iterator with carry-over scheduling,
rollout_bridge async entry points, gateway pause/drain, client auth,
async_calc_x example, and accompanying tests.
2026-05-19 06:41:51 +00:00
SiweiPro 3abc413cb6 feat: add wandb support 2026-05-14 01:55:55 -07:00
SiweiPro d31618ceb2 feat: add reward metrics in logs 2026-05-13 23:32:23 -07:00
SiweiPro caa77f1dfe feat: add reward metrics in logs 2026-05-12 07:33:55 -07:00
SiweiPro ba8faa0fe8 fix: drop with shuffle 2026-05-12 07:30:32 -07:00
Zhiyuan He ae44285677 Merge pull request #1 from agent-lightning/feat/agl-lite-ppotrainer
feat(verl): add agl-lite PPO trainer integration
2026-05-11 14:41:46 +08:00
SiweiPro 29b2e61cf3 feat(verl): add agl-lite PPO trainer integration 2026-05-09 07:23:01 -07:00
Jeonghye Kim 0b40cb724a New example: EMPO2 (#524) 2026-04-29 14:31:44 +08:00
yuqyang d60e54fe5a fix: increase MCP read_timeout_seconds to 30s for container cold start
mcp-server-calculator takes ~12s to start inside minikube containers
(Python import overhead in constrained environment). The default 5s
read_timeout_seconds in StdioServerParams kills 117/176 agents.

Also add /root/.local/bin to PATH in Dockerfile so the pre-installed
binary is found directly.
2026-04-13 01:18:44 -07:00
yuqyang 9acaa7964a fix: use direct mcp-server-calculator binary instead of uvx
uvx re-downloads the package on every invocation even when
pre-installed via 'uv tool install'. The 5s MCP init timeout
kills 117/176 agents.

Fix:
- Dockerfile: add /root/.local/bin to PATH after uv tool install
- calc_agent.py: call mcp-server-calculator directly instead of
  'uvx mcp-server-calculator'

This eliminates the download step entirely — the binary starts
instantly from the pre-installed tool environment.
2026-04-13 01:04:49 -07:00
yuqyang bfd2f124fe refactor: use store archive API instead of custom _archive_batch
Replace the custom rollout JSONL writer with a call to
client.archive_rollouts() after each generate_sequences batch.

Benefits:
- Writes full rollout + events (not just summaries)
- Frees hot store memory (purges archived rollouts)
- Uses the existing store JSONL format (archive.jsonl)
- Path defaults to $AGL_LOG_DIR/archive.jsonl
2026-04-13 00:43:34 -07:00
yuqyang d75088d485 feat: rollout archive + pre-install MCP calculator in agent image
(a) agent_loop.py: after fetching triplets, append each rollout to
    $AGL_LOG_DIR/rollouts.jsonl with: batch number, rollout_id,
    reward, triplet count/lengths, and original input. Token IDs
    are summarized (not dumped) to keep the file readable.

(b) Dockerfile.agent: pre-install mcp-server-calculator via
    'uv tool install' at build time. Previously uvx downloaded it
    on every pod startup, hitting the 5s MCP init timeout —
    117/176 agents failed in the last run because of this.

The hermes_tool_parser JSON errors in vLLM are expected — the
untrained model sometimes generates malformed tool call JSON.
This improves with training.
2026-04-13 00:37:23 -07:00
yuqyang 2f27d835e6 chore: gitignore calc_x/logs/ 2026-04-12 23:02:01 -07:00
yuqyang 8ed1b4f46e fix: hooks.py sys.path after moving from vllm/ to calc_x root
When hooks.py was at vllm/hooks.py, parent.parent pointed to
calc_x/ (where eval_utils.py lives). After flattening, hooks.py
is directly in calc_x/, so parent is sufficient.
2026-04-12 22:46:28 -07:00
yuqyang 812896373d fix: kill stale minikube mount before starting a new one
If a previous run.sh was killed without the EXIT trap firing
(kill -9, machine crash), the minikube mount process would still
hold the destination path. Detect and kill it via pgrep before
starting a fresh mount.
2026-04-12 22:39:47 -07:00
yuqyang 298c8c611b feat: minikube mount for agent logs + training.log capture
Agent pods write to hostPath /tmp/agl-lite/logs/<attempt-id>/agent.log
inside the minikube VM. run.sh now starts 'minikube mount' to bridge
the VM path to the host filesystem at $LOG_DIR/agents/.

After a run, the log directory contains:
  logs/<timestamp>/
    server.log       # agl-lite server (JSON structlog)
    training.log     # VERL output (Ray workers, metrics, progress)
    agents/          # per-agent logs via minikube mount
      <attempt-id>/agent.log

The mount process is backgrounded and cleaned up via trap on EXIT.
2026-04-12 22:39:09 -07:00
yuqyang 5d2efe65ea refactor: flatten calc_x config files + improve logging
(a) Move examples/calc_x/vllm/{hooks,gateway-config,.env.example} up
to examples/calc_x/. The vllm/ subdirectory was unnecessary — calc_x
only has one mode (unlike math-poc which has mock + vllm).

(b) Improve logging coverage:
- run.sh: tee training output to $LOG_DIR/training.log alongside
  the existing server.log. Both logs share the same timestamped dir.
- agent_loop.py: log batch summary after each generate_sequences
  (sample count, triplet/empty split, reward distribution, elapsed).
- proxy.py: debug-level log for each proxied request (rollout_id,
  model, stream, path).
2026-04-12 22:30:53 -07:00
yuqyang 526b9c73b4 feat: E2E calc_x VERL training smoke test PASSED 🎉
Full PPO training step completed successfully:
  Ray init → FSDP load → internal vLLM → register with gateway →
  validation (24 rollouts, reward@1=0.25) →
  training (128 rollouts via K8s agent pods + MCP calculator) →
  PPO update (pg_loss=-0.005, grad_norm=0.99) →
  final validation (24 rollouts, reward@1=0.1)

Key fixes in this session:
- Fresh HTTP client per generate_sequences (stale TCP connections)
- Add uvx binary to agent Docker image (MCP tools need it)
- Handle empty triplets with EOS token (avoid VERL crash)
- Load tokenizer via AutoTokenizer (AgentLoopManager has no tokenizer)
- Call super().__init__ properly (parent has compatible signature)

Mark 5c.6, 5c.7, and Phase 5c as completed.
2026-04-10 00:35:47 -07:00
yuqyang 578053b88b fix: call super().__init__ properly, load tokenizer via AutoTokenizer
The parent AgentLoopManager.__init__ (verl 0.7.1) accepts
(config, worker_group, rollout_resource_pool, reward_loop_worker_handles)
— compatible with our signature. The tokenizer is NOT set by the
parent (only AgentLoopWorker has it). Load it ourselves via
AutoTokenizer.from_pretrained for DataProto construction.
2026-04-10 00:20:25 -07:00
yuqyang f7bf3f7848 fix: initialize AgentLoopManager fields directly, skip mismatched super().__init__
The parent AgentLoopManager.__init__ expects (config, servers,
load_balancer_handle) but create() passes (config, worker_group,
rollout_resource_pool). The parent sets self.tokenizer from
model_config in its __init__, but the positional arg mismatch
caused errors.

Fix: initialize config, rollout_config, model_config, tokenizer,
and dataset_cls directly instead of calling super().__init__().
The create() classmethod still handles server initialization via
_initialize_llm_servers.
2026-04-10 00:14:37 -07:00
yuqyang 92d8a5dfea fix: use parent tokenizer from AgentLoopManager instead of _set_tokenizer
The parent AgentLoopManager.__init__ sets self.tokenizer from
model_config. Our _set_tokenizer was never called, causing:
  AttributeError: 'NoneType' object has no attribute 'eos_token_id'

Remove _set_tokenizer, use self.tokenizer from parent directly.
2026-04-10 00:09:42 -07:00
yuqyang a42eab12d7 fix: add uvx to agent image + handle empty triplets in DataProto
Two issues that caused training step crash:

1. Dockerfile.agent: COPY /uvx from uv image alongside /uv.
   Without uvx, the MCP calculator agent fails immediately with
   'FileNotFoundError: uvx', making zero LLM calls.

2. agent_loop.py: when triplets are empty (agent failed before any
   LLM call), insert a single EOS token in the response so VERL
   doesn't treat the sequence as 'aborted'. If ALL sequences are
   aborted, compute_data_metrics crashes with:
     RuntimeError: max(): Expected reduction dim for numel() == 0
   The EOS token makes it a valid (but zero-reward) sequence.
2026-04-10 00:01:12 -07:00
yuqyang 01cd9d07e9 fix: use fresh HTTP client per generate_sequences call
The AglLiteAgentLoopManager kept a single httpx.AsyncClient across
validation and training calls. VERL has long pauses between calls
(FSDP weight sync, CUDA graph capture) that caused idle TCP
connections to go stale, resulting in:
  RuntimeError: unable to perform operation on <TCPTransport closed=True>

Fix: create a fresh AglLiteClient (via async context manager) for
each generate_sequences invocation. The client is closed cleanly
after all HTTP work is done.
2026-04-09 23:43:35 -07:00
yuqyang 1cdb2c5914 docs: update 5c.7 E2E progress — validation completed!
Full pipeline working through validation:
  Ray init → FSDP load → vLLM → generate_sequences →
  agl-lite enqueue → K8s agent pods → gateway → vLLM →
  triplets → DataProto → validation metrics reported

val-core/unknown/reward/mean@1:0.0 (agents ran but didn't solve
correctly — expected for untrained model, pipeline is functional).

Remaining: TCP transport error when starting training step after
validation. Likely stale HTTP connection to agl-lite server.
2026-04-09 23:35:49 -07:00
yuqyang 2a99432616 fix: AGL_KEY persistence in state file + image name normalization docs
(a) AGL_KEY management:
- deploy.py: write AGL_KEY to .local/agl-lite.env state file alongside
  AGL_BASE_URL and AGL_NAMESPACE. Every process can source this file.
- run.sh: auto-source .local/agl-lite.env if AGL_KEY not in env.
  After deploy, source it again for the freshly written values.

(b) Image name normalization:
- build_images.sh: document the convention explicitly — argument is the
  directory name (e.g., calc_x), underscores normalize to hyphens for
  Docker tags (calc_x → calc-x-agent:dev).
- run.sh already uses '--include-example calc_x' (directory name).
2026-04-09 23:24:34 -07:00
yuqyang 705475bc1b docs: add wandb integration as future todo item
Essential for tracking training metrics across runs. Needs:
WANDB_API_KEY propagation to Ray workers, logger config toggle,
--wandb CLI flag in train_calc_agent.py.
2026-04-09 23:18:47 -07:00
yuqyang e4754e08ee fix: E2E fixes — wandb, AGL_KEY propagation, Ray cleanup, image build
- train_calc_agent.py: default logger to console only (no wandb)
- entrypoint.py: pass AGL_KEY, AGL_BASE_URL, WANDB_MODE to Ray workers
  via runtime_env env_vars (OmegaConf resolves env vars at compose time
  in the driver, but Ray workers need them too)
- run.sh: add 'ray stop --force' cleanup before starting training;
  remove external vLLM check (VERL manages internal vLLM); use
  .venv/bin/python instead of uv run; fix image build name (calc_x)
- Note: requires python3.12-dev for triton JIT
2026-04-08 01:02:49 -07:00
yuqyang 07e075dd06 docs: update 5c.7 status — code done, blocked on VERL config tuning
All integration code is implemented:
  - AglLiteAgentLoopManager (agent_loop.py)
  - Simplified entrypoint using verl's TaskRunner
  - Deleted AgentLightningTrainer

E2E reaches FSDP model loading + vLLM server launch.
Blocked on vLLM engine core startup failure — likely GPU memory
contention in hybrid mode (FSDP + vLLM on 1 GPU). Need to tune
gpu_memory_utilization or use n_gpus_per_node > 1.
2026-04-07 10:05:32 -07:00
yuqyang 287cff5ded fix: agent_loop import path and dataset serialization for verl 0.7.1
- agent_loop.py: fix import — verl.utils.ray_utils.auto_await (not
  verl.utils.async_utils). Remove try/except guard that masked real
  import errors.
- dataset.py: add serialize_dataset=True and original_data_files=None
  to LoadedDataset so RLHFDataset.__getstate__ works during Ray
  serialization.
- entrypoint.py: pass LoadedDataset directly (not via ray.put/ray.get)

E2E progress: FSDP model loads, vLLMHttpServer starts. Blocked on
missing python3-dev headers for triton JIT compilation.
2026-04-07 10:00:38 -07:00
yuqyang 485d3eb2e1 fix: entrypoint dataset passing and LoadedDataset for verl 0.7.1
- entrypoint.py: pass LoadedDataset directly to TaskRunner (not via
  ray.put/ray.get which wraps in ObjectRef). Use train_dataset_ref
  directly instead of ray.get().
- dataset.py: rewrite LoadedDataset to skip RLHFDataset.__init__
  entirely (verl 0.7.1 requires tokenizer/config args we don't have).
  Set self.dataframe directly from the in-memory sequence.
- Remove AgentDataset (unused after trainer.py deletion).
2026-04-07 09:51:40 -07:00
yuqyang dea1a9529d refactor(verl): migrate to 0.7.1 AgentLoopManager API
Replace AgentLightningTrainer (custom RayPPOTrainer subclass) with
AglLiteAgentLoopManager — a custom AgentLoopManager that:
  - Inherits parent's vLLM server management (weight updates work)
  - Overrides _init_agent_loop_workers to skip Ray agent actors
  - generate_sequences() delegates to agl-lite HTTP API:
    register models → enqueue rollouts → poll → fetch triplets →
    build DataProto with rm_scores

Key changes:
- NEW: agl_lite/verl/agent_loop.py — AglLiteAgentLoopManager
- DELETE: agl_lite/verl/trainer.py — AgentLightningTrainer no longer needed
- REWRITE: agl_lite/verl/entrypoint.py — use verl's standard TaskRunner
  pattern, inject agent_loop_manager_class via config
- UPDATE: config.yaml — add model_endpoint, timeout_seconds fields

The integration point moves from 'override half the trainer' to
'provide a custom AgentLoopManager' — a designed extension point in
verl 0.7.1. Standard RayPPOTrainer handles the training loop.
2026-04-07 09:45:06 -07:00
yuqyang 39ecc2233a docs: add 5c.7 — VERL 0.7.1 AgentLoopManager migration plan
VERL 0.7.1 replaced the trainer-subclass pattern with a built-in
AgentLoopManager extension point. Our current AgentLightningTrainer
(which overrides _train_step, _validate, fit) is incompatible.

New plan: implement AglLiteAgentLoopManager that wraps AglLiteDaemon,
set it via rollout.agent.agent_loop_manager_class config, and use
the standard RayPPOTrainer — no trainer subclass needed.

5c.6 (smoke test) blocked on this migration.
2026-04-07 09:36:04 -07:00
yuqyang 50ba96ed73 docs: update 5c.6 status — blocked on verl 0.6.0→0.7.1 API migration 2026-04-07 09:13:32 -07:00
yuqyang 18cfc88a90 fix: version alignment for VERL stack (verl 0.7.1 + vllm 0.12.0)
- Pin verl==0.7.1 (0.6.0 only supports vllm<=0.9.1, incompatible)
- Pin vllm>=0.10.2,<=0.12.0 (verl 0.7.1 supports up to 0.12.0)
- Fix load_reward_manager: remove num_examine kwarg (dropped in 0.7.1)
- setup_verl.sh: note flash-attn must be installed after uv sync
  via 'uv pip install flash-attn --no-build-isolation'
- Use .venv/bin/python instead of 'uv run' for training scripts
  (uv run enforces lockfile, won't see pip-installed flash-attn)

Known remaining: RayPPOTrainer API changed in verl 0.7.1 —
trainer.py and entrypoint.py need further adaptation (reward_fn
kwarg, create_rl_sampler signature, etc). Filed as TODO.
2026-04-07 09:13:07 -07:00
yuqyang da8256572e fix: Ray isolation for shared machines + working_dir workaround
- entrypoint.py: pass _temp_dir from RAY_tmpdir env var to ray.init()
  for shared machines. Set working_dir=None in runtime_env to prevent
  Ray from packaging the local module into a new venv (which lacks
  heavy deps like torch/verl).
- run.sh: export RAY_GCS_SERVER_PORT=0 and RAY_tmpdir to avoid
  conflicts with other users' Ray clusters on port 6379.
- Add 'import os' to entrypoint.py.

Known issue: VERL FSDP workers still fail to find flash-attn because
it's installed outside the uv lockfile (two-phase install). Next step:
either add attn_implementation override or resolve the flash-attn
packaging issue.
2026-04-07 09:01:23 -07:00
yuqyang 811ca1d6cc fix: two-phase VERL install with CUDA auto-detect fallback
flash-attn is source-only on PyPI and requires torch at build time,
making it impossible to install via uv sync (circular build dep).
Move flash-attn out of pyproject.toml [verl] extras and install it
in a second phase via 'uv pip install --no-build-isolation' after
torch is available.

setup_verl.sh improvements:
- Auto-detect CUDA: tries exact version (e.g., cu131), falls back
  to major.0 (cu130) if exact index doesn't exist on PyTorch
- Use --index-strategy unsafe-best-match so vllm resolves from PyPI
  even when the PyTorch index is present
- Two-phase install: uv sync (torch+verl+vllm) then flash-attn
- Also sync --extra dev to keep test deps available
- Verified: CUDA 12.8 → cu128, torch=2.9.0+cu128, 4 GPUs detected
2026-04-07 08:23:05 -07:00
yuqyang 25fac86231 feat: pin VERL deps to known-good versions from reference setup
Pin versions matching .local/examples/setup.sh:
  verl==0.6.0, ray==2.49.2, transformers==4.57.1

Drop click==8.2.1 pin (conflicts with base env, only needed
transitively by verl). Drop tensordict pin (verl==0.6.0
requires >0.9.0, reference setup.sh's 0.6.2 is incompatible).

Add numpy>=1.26.0 as explicit base dependency (daemon.py imports it,
was previously only available transitively).
2026-04-07 08:04:36 -07:00
yuqyang daec1a2513 refactor: CUDA-agnostic VERL deps + auto-detect setup script
Remove hardcoded PyTorch cu130 index from pyproject.toml. VERL deps
now list packages without CUDA coupling — the CUDA variant is selected
at install time.

Align version constraints with Agent Lightning:
  - vllm>=0.10.2,!=0.11.1,!=0.11.2,!=0.12.0 (flash-attn compat)
  - transformers>=4.55.0,!=4.57.2 (bug in 4.57.2)
  - verl>=0.5.0, torch>=2.8.0, flash-attn>=2.8.3, tensordict>=0.9.1

Add scripts/setup_verl.sh:
  - Auto-detects CUDA version from nvcc (e.g., 13.1 → cu130)
  - Falls back to CPU if nvcc not found
  - Accepts manual override: setup_verl.sh cu126
  - Verifies index is reachable before installing
  - Runs verification after install (torch, vllm, verl, ray, transformers)
2026-04-07 07:51:31 -07:00
yuqyang 6876699912 feat: add [verl] optional dependency group for VERL training stack
Add optional 'verl' extras in pyproject.toml with GPU-compatible deps:
  torch (cu126 via PyTorch index), vllm, verl, ray, transformers,
  flash-attn, hydra-core, omegaconf, tensordict, datasets, codetiming,
  autogen-agentchat, autogen-ext[openai], mcp.

Configure uv to fetch torch/torchvision/torchaudio from PyTorch's
CUDA 12.6 wheel index (explicit, won't affect other packages).
No conda needed — pip GPU wheels bundle their own CUDA runtime.

Install: uv sync --extra verl
Resolves: torch=2.9.0+cu126, vllm=0.13.0, verl=0.7.1, flash-attn=2.8.3
2026-04-07 07:47:04 -07:00
yuqyang aeeb5b24f1 fix: cleanup previous deployment before re-deploying in example run scripts
Both math-poc/run.sh and calc_x/run.sh now check if the namespace
exists and run 'agl-lite deploy --cleanup' before deploying fresh.
This avoids stale Jobs/pods from prior runs causing confusing behavior.

Also add AGL_LOG_DIR setup to calc_x/run.sh (log directory with
timestamp, matching math-poc pattern). The agent container already
writes to $AGL_LOG_DIR/agent.log when set.
2026-04-07 07:31:59 -07:00
yuqyang 6107f66810 feat(calc_x): 5c.5 — run script, cleanup, README
- run.sh: E2E entrypoint — source .env.example, verify vLLM,
  build images (--include-example calc-x), agl-lite deploy,
  wait for healthz, exec train_calc_agent.py with passthrough args.
- Delete old files: calc_agent.py (replaced by agents/calc_agent.py),
  tests/ (Agent Lightning specific tests, not applicable).
- README.md: rewrite with architecture diagram, setup instructions,
  quick start, standalone usage, and file listing.
2026-04-07 04:21:12 -07:00
yuqyang 4bb3748fe5 feat(calc_x): 5c.4 — training script rewrite for agl-lite
Rewrite train_calc_agent.py to use agl-lite VERL integration:
- Load parquet dataset via HuggingFace datasets
- Build OmegaConf config: Hydra compose from agl_lite/verl/config.yaml
  (base) + verl_default_config() overrides (Calc-X specific)
- AGL_BASE_URL and AGL_KEY read from env via OmegaConf resolvers
- Call run_ppo(config, train_dataset, val_dataset) directly
- CLI: --train-file, --val-file, --model, --ci, --ci-fast
- Drop all agentlightning deps: agl.VERL, agl.Trainer, OtelTracer,
  LlmProxyTraceToTriplet, LightningStoreClient, MongoLightningStore,
  WeaveTracer, n_runners, external_store_address, mongo, weave, lora
2026-04-07 04:19:36 -07:00
yuqyang 138da36ee9 feat(calc_x): 5c.3 — hooks and deploy config
- vllm/hooks.py: CalcXHooks(RolloutHooks) —
  on_enqueue: inject AGL_TASK_INPUT (question + id JSON) and
  AGL_MODEL_NAME into pod env via pod spec copy.
  on_succeeded: extract answer from agent_output event, compare
  with ground truth using eval_utils.scalar_are_results_same
  (sympy-based numeric comparison), post reward event.
- vllm/gateway-config.yaml: inject return_token_ids for all models
- vllm/.env.example: deploy config for agl-in-host mode —
  namespace, gateway, hooks, pod spec template, model endpoint,
  vLLM params, dataset paths for VERL training.
2026-04-07 04:17:59 -07:00
yuqyang 75942cb066 feat(calc_x): 5c.2 — standalone agent container
- agents/calc_agent.py: standalone agent (no agl-lite imports).
  Reads AGL_TASK_INPUT (JSON with question/id), runs AutoGen
  AssistantAgent with MCP calculator tool (uvx mcp-server-calculator),
  extracts answer via ### ANSWER: <answer> ### regex, posts
  agent_output event to AGL_EVENT_URL. 5 min timeout per problem.
- Dockerfile.agent: python:3.12-slim + openai, autogen-agentchat,
  autogen-ext[openai], mcp, uv (for uvx MCP server).
- job-template.yaml: pod spec with agent container, CPU-only,
  imagePullPolicy: Never (minikube).
2026-04-07 04:16:35 -07:00
yuqyang fcd61966bc feat(calc_x): 5c.1 — dataset sample and eval_utils cleanup
- data/sample.jsonl: 10 rows from train.parquet for smoke testing
- eval_utils.py: remove agentlightning dependency (@reward decorator,
  async evaluate, evaluate_v0_1); keep pure functions
  (scalar_are_results_same, evaluate, float_eval, normalize_option)
- .gitignore: exclude data/ but keep sample.jsonl
- Add sympy as dev dependency (used by eval_utils for numeric comparison)
2026-04-07 04:14:54 -07:00
yuqyang fe33bfd250 docs: backlog item for multi-backend image builds (docker registry support) 2026-04-07 04:11:14 -07:00
yuqyang 8ab16e5c9e refactor: convention-driven image builds, eliminate case/switch
build_images.sh now iterates over examples using conventions:
  - examples/<name>/Dockerfile.agent → <name>-agent:dev
  - examples/<name>/build-extra.sh  → optional hook for extra images
  - 'all' auto-discovers examples with Dockerfile.agent
  - underscores normalized to hyphens in Docker tags

Move math-poc's mockai build into build-extra.sh hook.
2026-04-07 04:07:01 -07:00
yuqyang 626849b963 refactor: build_images.sh uses --include-example for extensibility
Replace --math-poc flag with --include-example <name> (repeatable).
Supports: math-poc, calc-x, and 'all'. Legacy --math-poc still works.

Update math-poc/run.sh to use new flag. Update todo to reflect
dataset decision (manual download, already in data/).
2026-04-07 04:02:03 -07:00
yuqyang 374b3a29c5 ignore data in example calc_x 2026-04-07 03:57:31 -07:00
yuqyang dd01656483 docs: detailed implementation plan for Phase 5c (calc_x VERL training)
Break down the calc_x migration into 6 ordered sub-items:
  5c.1: Dataset download script + eval_utils cleanup
  5c.2: Standalone agent container (AutoGen + MCP)
  5c.3: Hooks and deploy config (agl-in-host + vLLM)
  5c.4: Training script rewrite (run_ppo, drop agentlightning deps)
  5c.5: run.sh E2E entrypoint + old file cleanup
  5c.6: Smoke test with --ci-fast

Architecture: run.sh handles infra setup (vLLM check, Docker build,
agl-lite deploy), then exec's into train_calc_agent.py which loads
data and calls run_ppo(). For iterative dev, run train_calc_agent.py
directly with infra already up.
2026-04-07 03:17:51 -07:00
yuqyang 44e4501007 chore: remove completed todo items (gateway assemblers, settings refactor, logging) 2026-04-07 02:38:12 -07:00
yuqyang 2ebebfae9d docs: add todo item for Anthropic /v1/messages token_ids support
vLLM's Anthropic-compatible endpoint does not appear to support
return_token_ids yet. Need to verify before relying on it for
training pipelines.
2026-04-07 02:37:15 -07:00
yuqyang 1b60f07540 docs: document vLLM-specific token_ids fields in assembler docstrings
Clarify that prompt_token_ids and per-choice token_ids are vLLM
extensions (vllm#22587), not part of the standard OpenAI API.
Assemblers preserve them when present and omit them when absent —
no configuration needed.
2026-04-07 01:56:31 -07:00
yuqyang 5d40fa78cb refactor: extract streaming assemblers into gateway/assemblers/ sub-package
Move streaming response assembly out of proxy.py into a dedicated
sub-package with one module per LLM API format:

- assemblers/__init__.py: registry (select_assembler) mapping path
  suffixes to format-specific assembler functions
- assemblers/chat_completion.py: OpenAI /v1/chat/completions (moved)
- assemblers/completion.py: legacy /v1/completions (new)
- assemblers/anthropic.py: Anthropic /v1/messages (new)

proxy.py now calls select_assembler(path) instead of an inline is_chat
check. Unknown paths fall back to raw {"chunks": [...]}.

Adding a new format = one new file + one registry entry.

Tests: 19 new unit tests for assemblers (registry dispatch, each format,
edge cases). Existing proxy integration tests updated. 336 total pass.
2026-04-07 01:44:51 -07:00
yuqyang 8c0d20ac85 fix(deploy): K8s server pod missing env vars (mock mode broken)
Two issues in agl-in-k8s mode (mock):

1. deploy/agl-lite/k8s.yaml had wrong env var names:
   GATEWAY_CONFIG -> AGL_GATEWAY_CONFIG
   HOOKS -> AGL_HOOKS
   ARTIFACT_DIR removed (dead field)
   Added: AGL_POD_SPEC_TEMPLATE, AGL_LOG_DIR (from ConfigMap)

2. deploy.py didn't write AGL_POD_SPEC_TEMPLATE to the ConfigMap,
   so on_startup couldn't find the pod spec template -> copy_pod_spec()
   raised RuntimeError -> containers field empty -> K8s rejected every Job

Both mock and vllm E2E runs now pass:
  mock: 10/10 rollouts, 2 iterations
  vllm: 5/5 rollouts, 1 iteration
2026-04-07 00:40:52 -07:00
yuqyang f036ecdb2f test(gateway): realistic chunk[0] shape in token_ids test
chunk[0] can carry both role+content AND token_ids simultaneously.
Updated test_streaming_preserves_token_ids to mirror real vLLM output:
  chunk[0]: delta={role, content='Hi'}, token_ids=[100], prompt_token_ids=[...]
  chunk[1]: delta={content=' there'}, token_ids=[200, 201]
  chunk[2]: delta={content='!'}, token_ids=[300], finish_reason='stop'

Verifies token_ids from ALL chunks (including chunk[0]) are concatenated.
2026-04-06 23:40:26 -07:00
yuqyang 920194ec0e fix(gateway+events): preserve token IDs through streaming assembly
_assemble_chat_completion now carries vLLM-specific training fields:
  - prompt_token_ids: lifted from first SSE chunk to top-level dict
  - token_ids: concatenated across all chunks into each choice

_trim_model_request (triplet extraction) updated:
  - dict branch (assembled) is now the primary path for both
    streaming and non-streaming responses
  - list branch kept for backward compat (pre-assembly format)

Without this fix, the assembly commit (c25eb23) silently dropped
all token IDs from streaming responses, breaking VERL triplet
extraction — prompt_token_ids and response_token_ids would both
be empty lists.

Tests: +2 (test_streaming_preserves_token_ids,
            test_streaming_token_ids_triplet_roundtrip)
Total: 316 passing
2026-04-06 23:33:04 -07:00
yuqyang 0e48b372af docs(todo): gateway streaming assembly — multi-format support
Added [discuss] item for handling multiple LLM API streaming formats
in the gateway proxy. Currently only chat/completions is assembled;
completions and messages (Anthropic) fall back to raw chunks.

Proposal: assembler registry keyed by path suffix — one function per
format, same Callable signature, first-match dispatch. SSE parsing
stays generic; format-specific logic isolated in assembler functions.
2026-04-06 22:29:00 -07:00
yuqyang 36e7cfe22e fix(gateway): decouple SSE parsing from OpenAI format
_parse_sse_response was format-specific (assumed choices[0].delta.content).
The gateway is a general-purpose proxy and must not interpret payload structure.

Split into two functions with clear contracts:
  _parse_sse_chunks(raw)          -- generic, format-agnostic SSE parser
  _assemble_chat_completion(chunks) -- OpenAI chat completion only; explicit docstring
                                       stating it must not be called for other paths

_forward_streaming now takes 'path' and dispatches:
  path ends with 'chat/completions' -> _assemble_chat_completion -> ChatCompletion dict
  any other path                    -> {"chunks": [...]} raw list

This means:
  /v1/chat/completions streaming  -> response: {id, object, choices[message], usage}
  /v1/completions streaming       -> response: {chunks: [{choices[0].text, ...}]}
  any custom endpoint             -> response: {chunks: [...]}

Tests: added test_streaming_non_chat_path_stores_raw_chunks
2026-04-06 20:44:56 -07:00
yuqyang c25eb23cdc fix(gateway): assemble streaming response into ChatCompletion shape
_parse_sse_response previously returned a list of raw SSE delta chunks.
This was:
  - inconsistent with non-streaming (which returns a single ChatCompletion dict)
  - verbose: 294 chunks per call vs one assembled response
  - inconvenient to inspect: consumers had to manually concat delta.content

Now assembles chunks into a unified dict::

    {
      "id": "chatcmpl-...", "object": "chat.completion",
      "created": <int>, "model": "<model>",
      "choices": [{"message": {"role": "assistant", "content": "<full text>"},
                   "finish_reason": "stop"}],
      "usage": <last chunk usage or None>
    }

Streaming and non-streaming model_request events now have the same shape.
Empty stream (no data chunks) returns {} consistently.

Tests updated to assert on assembled shape.
2026-04-06 20:38:02 -07:00
yuqyang db7e7151d0 fix(deploy+rl_loop): three bugs found during real vllm run
deploy.py — server subprocess inherits caller's pipe (blocks tee forever):
  - IN_HOST Popen now uses stdout=DEVNULL, stderr=DEVNULL
  - Server logs go to resolved_log_dir/server.log via configure_logging()

deploy.py — hook env vars not passed to server subprocess:
  - AGL_POD_SPEC_TEMPLATE (and any future hook vars) from .env file were
    never in the server's environment; server on_startup couldn't find the
    pod spec template -> RuntimeError -> HTTP 500 on every enqueue
  - Fix: load env file with dotenv_values() and merge into server_env with
    precedence: env_file < os.environ < explicit overrides (AGL_KEY, AGL_LOG_DIR)

rl_loop.py — DATA_DIR undefined:
  - DATA_DIR = Path(__file__).resolve().parent / 'data' was missing
2026-04-06 20:21:07 -07:00
yuqyang cd5649b1c2 fix(tests): update test_math_hooks for new pod_spec API
Fixtures now seed hooks._pod_spec directly (bypassing on_startup/
AGL_POD_SPEC_TEMPLATE) with a minimal pod spec matching job-template.yaml.

Assertions updated:
- result.config.environment_variables["AGL_TASK_INPUT"] (old, removed field)
  -> _get_task_input() helper: finds AGL_TASK_INPUT in pod spec container env list
2026-04-04 01:03:18 -07:00
yuqyang b5a693ebc9 chore(math-poc): AGL_LOG_DIR owned by run.sh, not .env.example
run.sh exports AGL_LOG_DIR=$LOG_DIR (the timestamped run directory)
so all components write to the same per-run folder:
  logs/<timestamp>-<mode>/server.log   (structlog JSON, IN_HOST only)
  logs/<timestamp>-<mode>/rl_loop.log  (plain text, via rl_loop.py)
  logs/<timestamp>-<mode>/archive.jsonl (rollout archive)

Remove tee from rl_loop.py invocation — rl_loop.py now writes the file
itself; tee would double-write to the same path.

Remove AGL_LOG_DIR=logs/ from mock/.env.example and vllm/.env.example —
run.sh sets it dynamically; a fixed path would accumulate across runs.
2026-04-04 01:00:06 -07:00
yuqyang c1e6c95863 feat(math-poc): update logging to use AGL_LOG_DIR
rl_loop.py:
- log() tees to both stdout and AGL_LOG_DIR/rl_loop.log (append mode)
- _setup_log_file() called at start of main()
- log startup banner includes log dir path
- archive_rollouts: no backend when AGL_LOG_DIR set (server defaults to
  AGL_LOG_DIR/archive.jsonl); explicit local path only as fallback

agents/qa_agent.py:
- _setup_logging(): stdlib logging to stdout + AGL_LOG_DIR/agent.log
  mkdir -p handled by logging setup; called at module level
- all print() -> log.info() / log.warning() / log.error()
2026-04-04 00:53:38 -07:00
yuqyang 4c2de5614d feat(7b): per-pod log volume via PodPatcher
job-template.yaml.j2:
- AGL_LOG_DIR=/agl/logs/$(AGL_ATTEMPT_ID) added after AGL_ATTEMPT_ID
  (ordering invariant: K8s resolves $(VAR) in declaration order)
- volume_mounts: agl-logs -> /agl/logs (injected into all containers)
- volumes: agl-logs hostPath /tmp/agl-lite/logs, type: DirectoryOrCreate

job_builder.py:
- PodPatcher: add volume_mounts field
- _apply_patcher: inject volume_mounts into all containers (patcher first,
  container's own mounts win on name conflict)
- ordering invariant documented with load-bearing comment

tests: 3 new tests
- test_parsed_from_template: AGL_LOG_DIR present, AGL_ATTEMPT_ID before it,
  volume_mounts and volumes present
- test_volume_mounts_injected_into_all_containers
- test_container_volume_mount_wins_over_patcher
- test_env_ordering_invariant: patcher env before container env
2026-04-04 00:48:02 -07:00
yuqyang a58eb1189a feat(7a): structured logging — dual output, AGL_LOG_DIR, default archive
New module: agl_lite/logging_config.py
- configure_logging(log_dir, log_level, component)
- stdout: structlog ConsoleRenderer (human-friendly, colored)
- file:   structlog JSONRenderer (JSON Lines) at log_dir/<component>.log
- ProcessorFormatter bridge so stdlib logging (uvicorn etc.) also routes through
- shared processors: merge_contextvars, add_log_level, add_logger_name, TimeStamper

cli.py serve:
- add --log-dir (envvar AGL_LOG_DIR) and --log-level (envvar AGL_LOG_LEVEL)
- call configure_logging() before uvicorn.run()

ServerSettings: add log_dir field; passed to InMemoryStore

store/memory.py:
- stdlib logging -> structlog
- __init__: add log_dir param, store as self._log_dir
- archive_rollouts: default backend to log_dir/archive.jsonl when unset

deploy.py:
- DeploySettings: add log_dir field (AGL_LOG_DIR)
- resolve log_dir via (repo_root / cfg.log_dir).resolve() — handles relative + absolute
- fallback: local_state_dir when log_dir not set
- set AGL_LOG_DIR in subprocess env; remove stdout/stderr redirect
- error message references resolved_log_dir/server.log

env examples:
- deploy/agl-lite.env.example: add AGL_LOG_DIR + AGL_LOG_LEVEL comments
- math-poc mock + vllm .env.example: add AGL_LOG_DIR=logs/
2026-04-04 00:24:41 -07:00
yuqyang fd557ce49d docs(todo): revise 7a — AGL_LOG_DIR replaces AGL_LOG_FILE, dual output design
- AGL_LOG_DIR: unified dir for logs + archive across all processes
- stdout: ConsoleRenderer (human-friendly); file: JSONRenderer (JSONL)
- deploy.py resolves relative/absolute paths via pathlib
- default archive location: AGL_LOG_DIR/archive.jsonl
- AGL_LOG_LEVEL for verbosity control
2026-04-04 00:19:32 -07:00
yuqyang 634f438bca docs(todo): mark settings refactor completed; refresh 7a logging design 2026-04-03 23:43:38 -07:00
yuqyang 9fc5ec9c31 refactor: BaseSettings -> BaseModel; CLI owns env var mapping via typer envvar=
ServerSettings, ControllerSettings are now plain BaseModel — no ambient
env reads, no env_prefix, no pydantic-settings dependency.

cli.py is the sole boundary that maps AGL_* env vars to settings fields,
using typer.Option(default, envvar='AGL_*'):
- CLI arg wins if passed
- env var is fallback (read at call time by typer)
- --help shows env var name, not value
- type conversion (int) handled by typer
- required fields (base_url, namespace, job_manifest_template) use
  typer.Option(..., envvar=) — typer fails cleanly if neither arg nor
  env var is provided

DeploySettings stays BaseSettings (explicit _env_file, not ambient).

controller: all settings now explicit options in cli.py with envvar=;
previously only --job-manifest-template was explicit.

rename: ServerSettings.agl_key -> key (server/config.py, app.py, tests)
2026-04-03 23:33:27 -07:00
yuqyang 6143e04e4a docs: use typer.Option(envvar=) pattern for settings refactor
- typer reads env at call time (not import time)
- --help shows env var name, not value (no key leakage)
- type conversion handled by typer
- required fields: typer.Option(..., envvar=) fails cleanly
- no os.environ anywhere in cli.py
2026-04-03 10:01:54 -07:00
yuqyang 3a01068d1f docs: add 'CLI owns env mapping' principle to AGENTS.md and todo
Settings refactor: BaseSettings -> BaseModel, cli.py is the sole
boundary that reads os.environ. Captured as [ready] todo item.
2026-04-03 09:03:28 -07:00
yuqyang 2bfda1cf89 docs(todo): revise 7a logging design (server-only, structlog, --log-file CLI arg) 2026-04-03 08:53:12 -07:00
yuqyang 23ff6c8553 refactor: remove artifact event feature
No production consumers — only test_artifacts.py was exercising it.
SWE-bench uses a plain K8s hostPath volume named 'artifacts', unrelated.

Removed:
- InMemoryStore._persist_artifact, artifact_dir param
- Special 'artifact' branch in add_event
- ServerSettings.artifact_dir
- DeploySettings.artifact_dir
- --artifact-dir CLI option
- artifact_dir passthrough in deploy.py (IN_HOST cmd + ConfigMap env)
- tests/store/test_artifacts.py (7 tests)

todo: replace SWE-bench artifact follow-up with resources_id cleanup note
2026-04-03 08:29:54 -07:00
yuqyang 3ebd587eb9 docs(todo): add logging persistence plan (7a server/controller, 7b agent pod volume) 2026-04-03 08:17:27 -07:00
yuqyang d6518d29dd chore(math-poc): merge deploy.env + .env.example into single .env.example per mode
DeploySettings has extra='ignore', so deploy vars and experiment vars can
coexist in one file. run.sh now sources and passes the same .env.example
to both 'source' and '--env-file'. Removes deploy.env from both modes.
2026-04-03 07:26:56 -07:00
yuqyang c5447e39da chore(todo): collapse completed items, add config hygiene decisions to frozen table 2026-04-03 07:23:40 -07:00
yuqyang 4111c9261a chore: remove stale deploy.yaml files, fix .env.example header comments 2026-04-03 07:22:54 -07:00
yuqyang c4721693fa fix(math-poc): update for new API (pod_spec, .env deploy, no resources)
Hooks (mock + vllm):
- Replace RolloutConfig(image='') + .environment_variables[...] with
  copy_pod_spec() + get_container() + container env injection
- Add AGL_POD_SPEC_TEMPLATE docstring (loaded by base on_startup)

Deploy config:
- mock/deploy.yaml + vllm/deploy.yaml → mock/deploy.env + vllm/deploy.env
  (flat AGL_* key=value format matching DeploySettings)
- Add AGL_POD_SPEC_TEMPLATE=examples/math-poc/job-template.yaml

run.sh:
- --config → --env-file
- deploy.yaml → deploy.env; parse AGL_NAMESPACE with grep instead of python yaml
- AGL_K8S_NAMESPACE → AGL_NAMESPACE

rl_loop.py:
- Remove dead resources pattern: add_resources() + resources_id on enqueue
  (controller no longer fetches resources; pod spec set by hook)
- Remove yaml import (was only used for job template loading)
- Fix NameError: enqueued_ids → rollout_ids
- Fix NameError: import ArchiveBackend from agl_lite.schemas.api
- Remove resources_id from EnqueueRolloutRequest
- Drop resources_id from run_iteration() signature
- Update module docstring
2026-04-01 09:18:55 -07:00
yuqyang 668a44d513 fix: rename Jinja2 template variable lite_url -> base_url
Consistent with the ControllerSettings.base_url rename (AGL_LITE_URL ->
AGL_BASE_URL). Updates job_builder._template_context, job-template.yaml.j2,
and docs/concepts/task-lifecycle.md.
2026-04-01 09:12:57 -07:00
yuqyang 7cb50273ce fix: hardcode agl-lite-keys secret name, remove AGL_SECRET_NAME entirely
SECRET_NAME = 'agl-lite-keys' was already a hardcoded constant in deploy.py
with no way to configure it differently. The name was simply propagated as
AGL_SECRET_NAME through ConfigMap -> pod env -> ControllerSettings ->
job_builder -> Jinja2 template for no reason.

Changes:
- job-template.yaml.j2: replace {{ secret_name }} with agl-lite-keys
- job_builder.py: remove secret_name from _template_context
- ControllerSettings: remove secret_name field
- deploy.py: remove AGL_SECRET_NAME from agl-lite-config ConfigMap
- k8s.yaml: remove AGL_SECRET_NAME env var (was read from ConfigMap)
- tests: remove secret_name from all ControllerSettings fixtures; update
  assertion to expect hardcoded 'agl-lite-keys'
2026-04-01 09:09:31 -07:00
yuqyang add6bf50f4 fix: remove redundant CLI threading of base_url/namespace/secret_name in controller
These values are already in the pod env via agl-lite-config ConfigMap.
ControllerSettings (env_prefix=AGL_) reads them directly — no CLI option needed.

Changes:
- cli.py controller: only --job-manifest-template remains; all others read from env
- ControllerSettings constructor: only job_manifest_template passed explicitly
- AGL_K8S_NAMESPACE renamed to AGL_NAMESPACE everywhere (deploy.py, k8s.yaml)
  — fixes latent bug: ControllerSettings.namespace expected AGL_NAMESPACE but
    the ConfigMap key was AGL_K8S_NAMESPACE, so pydantic-settings silently
    failed to populate it from env
- deploy/controller/k8s.yaml: remove --agl-base-url, --namespace, --secret-name
  from command; env vars remain mounted from ConfigMap for pydantic-settings
2026-04-01 09:04:33 -07:00
yuqyang 103bf4e87a fix: remove all defaults from CLI options and settings classes
CLI (cli.py):
- serve: host, port now required (...)
- serve: gateway_config, hooks, artifact_dir → Optional[str] = None (genuinely optional)
- serve: remove manual os.environ fallback — settings already reads env vars
- controller: agl_base_url, namespace, secret_name now required (...)

ServerSettings (server/config.py):
- Remove host, port — they are uvicorn/CLI concerns, never read by create_app()
- gateway_config, hooks, artifact_dir → str | None = None

ControllerSettings (controller/config.py):
- base_url, namespace, secret_name: required (no default); fail loudly if missing

InMemoryStore:
- artifact_dir: str | None = None (consistent with ServerSettings)

Tests: pass all required fields explicitly
2026-04-01 08:57:18 -07:00
yuqyang 8a4f5e852f fix: rename ControllerSettings.lite_url → base_url (AGL_BASE_URL)
Previously the field was named lite_url, which pydantic-settings mapped to
AGL_LITE_URL. The pod injects AGL_BASE_URL, so the env var was silently
ignored — the CLI passed the value explicitly, masking the mismatch.

Renaming to base_url makes pydantic-settings correctly bind AGL_BASE_URL,
consistent with the rest of the codebase.
2026-04-01 08:51:54 -07:00
yuqyang 49e80825a0 fix: anchor job_manifest_template to repo_root in deploy.py
Relative default path only resolved correctly if CWD was repo root.
Using repo_root / cfg.job_manifest_template is consistent with all other
static paths and handles absolute user-supplied paths correctly (pathlib
discards the left operand when the right is absolute).
2026-04-01 08:46:08 -07:00
yuqyang ef298efb1a fix: move job_manifest_template default into DeploySettings
Default belongs in the settings class, not buried in the function body.
deploy_command() now just uses Path(cfg.job_manifest_template) directly.
2026-04-01 08:42:32 -07:00
yuqyang 79e357bde4 fix: remove default from --job-manifest-template cli option
The controller always runs in a pod; the CLI arg is always explicitly provided
by k8s.yaml. No default belongs in ControllerSettings or the CLI.
The deploy/controller/job-template.yaml.j2 default lives only in deploy.py
(deploy-time concern), which already has it.
2026-04-01 08:38:20 -07:00
yuqyang d3e15b4d6a fix: move AGL_JOB_MANIFEST_TEMPLATE default to cli.py, not ControllerSettings
ControllerSettings.job_manifest_template is required (no default) because the
controller always runs in a pod where the value is always supplied explicitly via
--job-manifest-template /etc/agl/job-template.yaml.j2 (see deploy/controller/k8s.yaml).
A host-side default in ControllerSettings was misleading and could mask
misconfiguration at pod startup.

The cli.py default (deploy/controller/job-template.yaml.j2) is for local dev only.
2026-04-01 08:36:49 -07:00
yuqyang ff5411eecd feat: base on_startup auto-loads AGL_POD_SPEC_TEMPLATE; AGL_JOB_MANIFEST_TEMPLATE default
ControllerSettings.job_manifest_template:
- Now has a default of "deploy/controller/job-template.yaml.j2"
- cli.py --job-manifest-template option no longer required (same default)

DeploySettings:
- Add pod_spec_template: str | None = None (AGL_POD_SPEC_TEMPLATE)
  User pod spec template — plain YAML pod spec fragment loaded by the base
  RolloutHooks.on_startup into self._pod_spec at server startup

RolloutHooks.on_startup (base):
- Reads AGL_POD_SPEC_TEMPLATE from env; if set, yaml.safe_load into self._pod_spec
- No-op when env var is absent (no FileNotFoundError, no KeyError)
- Docstring explains the two distinct files: AGL_JOB_MANIFEST_TEMPLATE (Jinja2
  scaffold used by controller) vs AGL_POD_SPEC_TEMPLATE (plain YAML used by hooks)
- Subclasses that only need per-sample customisation no longer need on_startup

examples/swe_bench/hooks.py:
- Remove on_startup override — base handles file loading now
- Remove SWE_POD_SPEC_TEMPLATE; use AGL_POD_SPEC_TEMPLATE instead

deploy/agl-lite.env.example:
- Expand controller section: document AGL_JOB_MANIFEST_TEMPLATE with its default,
  and AGL_POD_SPEC_TEMPLATE with description and example path
2026-04-01 08:31:22 -07:00
yuqyang 530a0d9dd6 chore(todo): mark job construction refactor [completed] 2026-04-01 08:16:21 -07:00
yuqyang cf5019a241 refactor: simplify job construction — RolloutConfig.pod_spec + hook on_startup
RolloutConfig:
- Remove image, command, environment_variables, mount, overrides, Mount class
- Add pod_spec: dict | None — full pod spec fragment assembled by on_enqueue hook
- Keep timeout and max_retries (Job-level execution policy)

RolloutHooks base class:
- Add on_startup(self, store) lifecycle method — called once at server startup
- Add copy_pod_spec() — deep copies self._pod_spec with nil-guard
- Add get_container(pod_spec, name) staticmethod — finds container by name
- Add _pod_spec convention and module-level docstring with usage pattern

server/app.py:
- Call hooks.on_startup(store) in create_app() after store is initialised

job_builder.py:
- Remove user_pod_spec param — reads rollout.config.pod_spec instead
- Remove _ensure_agent_container, _get_agent_container helpers
- Remove all named-field merge logic (image, command, env vars, mounts, overrides)
- build_job_spec(rollout, settings, manifest_template) — three steps only:
    1. render template → scaffold + patcher
    2. merge config.pod_spec into scaffold
    3. inject patcher env into all containers
    4. set backoffLimit / activeDeadlineSeconds

reconciler.py:
- Remove _resources_cache and _get_job_template — controller no longer
  fetches resources; pod spec arrives pre-assembled in rollout.config.pod_spec
- build_job_spec call simplified (no job_template arg)

examples/swe_bench/hooks.py:
- Rewrite using on_startup + copy_pod_spec + get_container pattern
- Load pod spec template from SWE_POD_SPEC_TEMPLATE env var at startup
- Set per-instance image and env vars directly in pod_spec.containers[0]
- Hoist activeDeadlineSeconds → config.timeout

tests: updated throughout (315 passing)
2026-04-01 08:16:05 -07:00
yuqyang 220fb45bc9 chore(todo): mark deploy .env conversion [completed] 2026-04-01 05:06:35 -07:00
yuqyang 35338f0d67 refactor: convert deploy config from YAML to .env format
- DeployConfig(BaseModel) -> DeploySettings(BaseSettings) with env_prefix='AGL_'
  and env_ignore_empty=True; loaded via pydantic-settings _env_file kwarg
- ServerRuntimeConfig wrapper removed; gateway_config, hooks, artifact_dir
  promoted to top-level AGL_GATEWAY_CONFIG, AGL_HOOKS, AGL_ARTIFACT_DIR
- Field renames to avoid double AGL_ prefix:
    agl_host_port -> host_port (AGL_HOST_PORT)
    agl_host_ip_bind -> host_ip_bind (AGL_HOST_IP_BIND)
    agl_base_url_k8s_accessible -> base_url_k8s_accessible (AGL_BASE_URL_K8S_ACCESSIBLE)
- CLI: --config -> --env-file on both deploy_entrypoint and deploy_command
- deploy/agl-lite.yaml.example -> deploy/agl-lite.env.example (.env format)
- .env file serves as single project config; extra vars (hook config, model
  endpoints, experiment params) are silently ignored by DeploySettings and
  consumed by other components via os.environ
- deploy/README.md, docs/deploy.md updated throughout
2026-04-01 05:06:22 -07:00
yuqyang 827e4fdc56 chore(todo): mark both refactor items [ready] 2026-04-01 05:01:48 -07:00
yuqyang ebfa78a8b3 docs(todo): clarify .env as single project config — extra vars ignored by DeploySettings 2026-04-01 05:00:40 -07:00
yuqyang 48d4a0b086 docs(todo): add two discuss items — job construction refactor and deploy .env conversion 2026-04-01 04:59:00 -07:00
yuqyang fa8b230543 docs: add coding preference — avoid abusing default values in system code 2026-04-01 04:11:33 -07:00
yuqyang 465a0233c8 fix: remove poll_interval/max_queue_time from CLI args — read from env vars
These are infra tuning values that live in deploy/controller/k8s.yaml as
AGL_POLL_INTERVAL and AGL_MAX_QUEUE_TIME. Passing them as explicit CLI
kwargs to ControllerSettings() overrides env vars (pydantic-settings init
priority), making the k8s.yaml entries silently dead.

Now ControllerSettings reads AGL_POLL_INTERVAL and AGL_MAX_QUEUE_TIME
directly from the pod environment via env_prefix='AGL_'.
2026-04-01 04:08:18 -07:00
yuqyang 41855545b7 feat: wire job_manifest_template through deploy — ConfigMap mount
deploy.py:
- Create ConfigMap agl-controller-job-template from the template file
  (cfg.job_manifest_template if set, else repo's packaged default
  deploy/controller/job-template.yaml.j2)

deploy/controller/k8s.yaml:
- Add --job-manifest-template /etc/agl/job-template.yaml.j2 to controller command
- Mount the ConfigMap at /etc/agl (readOnly)

The controller now always receives an explicit template path — no default
fallback anywhere in Python code.
2026-04-01 04:03:03 -07:00
yuqyang 56f84be193 chore: remove deploy/.env.example, update deploy config docs
- Remove deploy/.env.example (and untracked deploy/.env) — replaced by
  YAML-driven agl-lite deploy --config
- deploy/agl-lite.yaml.example: remove controller: block (poll_interval
  and max_queue_time now live in deploy/controller/k8s.yaml directly);
  add commented job_manifest_template field
- deploy/README.md: rewrite around YAML config workflow, remove .env
  references, update directory structure listing
- docs/deploy.md: remove controller.poll_interval_seconds and
  controller.max_queue_time_seconds from config table and example;
  add job_manifest_template row
2026-04-01 03:29:08 -07:00
yuqyang 584aa39d86 chore: manual doc edits to task-lifecycle.md, pin click<8.3.0 for mkdocs compat 2026-04-01 03:17:28 -07:00
yuqyang 317cbda491 docs: add task-lifecycle.md to mkdocs.yml nav 2026-04-01 01:33:14 -07:00
yuqyang 17ff78d832 docs: add task-lifecycle.md — end-to-end walkthrough from dataset row to trajectory
Covers all six stages with a Mermaid sequence diagram:
  1. Enqueue — input/resources_id/config split, on_enqueue hook
  2. Job construction — three-layer merge table (manifest_template /
     user_pod_spec / rollout.config) with merge precedence rules
  3. Pod startup — PodPatcher env injection, OPENAI_BASE_URL encoding
  4. Execution & capture — agent calls LLM, gateway captures transparently
  5. Completion — controller detects Job Complete, on_succeeded hook, reward
  6. Reading the trajectory — GET /api/events, triplet extraction for RL

index.md: add Task Lifecycle as first entry in 'What to read next' table,
add forward reference in 'How the pieces connect' section
2026-04-01 01:32:23 -07:00
yuqyang 6766e2f78c refactor: rename pod_spec param to user_pod_spec in build_job_spec
Eliminates name shadowing cleanly:
- user_pod_spec: input fragment from resources (user-provided, per-dataset)
- pod_spec: the working pod spec dict extracted from the rendered scaffold
  (the central mutable object throughout the function)
2026-04-01 01:14:07 -07:00
yuqyang f8159ba872 refactor: remove all default template paths — manifest path always explicit
- Remove _DEFAULT_MANIFEST_TEMPLATE_PATH and _load_manifest_template from
  reconciler.py; reconciler reads Path(settings.job_manifest_template).read_text()
  directly — no fallback, fails loudly if not provided
- ControllerSettings.job_manifest_template: str (required, no None default)
- cli.py: add --job-manifest-template required option to 'agl-lite controller'
- job_builder.py: rename local pod_spec variable to scaffold_pod_spec to
  eliminate shadowing of the pod_spec parameter
- tests: fixture reads deploy/controller/job-template.yaml.j2 directly;
  both settings fixtures supply job_manifest_template
2026-04-01 00:31:15 -07:00
yuqyang f074c1cd33 refactor: remove ControllerConfig, move poll/queue settings to k8s.yaml
- Remove ControllerConfig class from deploy.py
- Remove controller: ControllerConfig field from DeployConfig
- Promote job_manifest_template to top-level field on DeployConfig
- Drop AGL_POLL_INTERVAL and AGL_MAX_QUEUE_TIME from ConfigMap creation
  in deploy.py (they were the only reason ControllerConfig existed at
  deploy time)
- Hardcode AGL_POLL_INTERVAL=10 and AGL_MAX_QUEUE_TIME=3600 directly in
  deploy/controller/k8s.yaml as static value: entries — operator tunes
  them by editing the K8s manifest, not the deploy config schema
2026-04-01 00:13:36 -07:00
yuqyang 3482dfde10 feat: Jinja2 job manifest template + PodPatcher for controller
job_builder: Jinja2 template + PodPatcher [ongoing]

Refactor job_builder to move the hardcoded Job manifest structure and
controller env vars into a Jinja2 template with a PodPatcher schema for
per-container env/volume injection.

Design:
- deploy/controller/job-template.yaml.j2: two YAML documents separated by ---
  - Doc 0: Job manifest scaffold (apiVersion, kind, metadata, spec shell with
    restartPolicy: Never, empty containers/volumes)
  - Doc 1: PodPatcher — controller env vars (with Jinja2 variables) + volumes

- PodPatcher(BaseModel) in job_builder.py: validates doc 1 (env, volumes)

- build_job_spec() now takes manifest_template: str (Jinja2 template string).
  Merge order (later wins):
    1. Jinja2 manifest template (Job scaffold + PodPatcher defaults)
    2. job_template pod spec fragment from resources (containers, volumes, pod fields)
    3. rollout.config named fields -> agent container (image, command, env, mounts)
    4. rollout.config.overrides (name-matched container merge)
  PodPatcher env injected into ALL containers; container's own env wins on conflict.
  rollout.config.environment_variables further override patcher env on agent.

- load_manifest_template(path) helper: loads template string from path or packaged default
- ControllerSettings.job_manifest_template: path to custom template (None = packaged default)
- ControllerConfig.job_manifest_template: same for deploy config
- Reconciler loads template once at __init__ via load_manifest_template()
- jinja2 added to controller optional dependencies
- 45 tests updated and 8 new tests added (PodPatcher, merge helpers, env conflict)
2026-03-31 23:40:19 -07:00
yuqyang 17dffd7e1d feat(examples): add rollout archive operation at the end of each iteration 2026-03-31 18:59:28 -07:00
yuqyang 87ff4ba4e2 test: align math-poc with new deploy schema and separate experiment config 2026-03-31 18:38:12 -07:00
yuqyang 672a710662 update docs to clearly tell user's requirement 2026-03-30 21:35:40 -07:00
yuqyang d3b3fa43c0 small updates 2026-03-30 21:27:50 -07:00
yuqyang 081b093e6c refactor: align deploy flow and config with mode-based schema 2026-03-30 21:21:09 -07:00
yuqyang a2a28b4fc9 refactor: adopt AGL_BASE_URL naming and add deploy guide
- migrate deploy flow and configs from AGL_LITE_URL to AGL_BASE_URL naming
- update deploy schema fields to agl_base_url_* and local_state_dir semantics
- align controller/deploy/example wiring with base-url naming
- add docs/deploy.md with mode-specific host vs pod URL behavior
2026-03-30 09:24:17 -07:00
yuqyang ac0f5f5615 refactor: switch deploy config to typed YAML schema
- add DeployConfig pydantic schema in agl_lite/deploy.py
  with mode-aware validation and URL checks
- make AGL_KEY env-only (required at runtime)
- make deploy command config-driven: agl-lite deploy --config <yaml>
- remove deprecated CLI flags from deploy entrypoint
  (--controller-only, --no-serve, mode overrides)
- add deploy/agl-lite.yaml.example with self-explanatory fields
- keep scripts/deploy.sh as thin wrapper to Python deploy command

Validation:
- agl-lite deploy --help works
- py_compile succeeds
- 317 tests passed
2026-03-30 08:49:28 -07:00
yuqyang e037ddbba2 feat: add Python deploy entrypoint with --config support
Add  command as Python replacement for shell deploy logic:
- new module: agl_lite/deploy.py
- supports modes: --agl-in-k8s / --agl-in-host / --agl-external
- supports custom config path: --config <env-file>
- supports host launch controls: --agl-host-bind / --agl-host-port
- supports cleanup mode
- computes pod-facing and host-facing URLs, writes .local/agl-lite.env
- keeps backward-compatible aliases: --controller-only / --no-serve

Wire command into CLI (agl_lite/cli.py).
Convert scripts/deploy.sh into a thin wrapper that calls .

317 tests pass.
2026-03-30 08:21:49 -07:00
yuqyang 805f70eca8 refactor: split pod-facing vs host-facing agl-lite URLs in deploy.sh
- Introduce explicit URL roles:
  - AGL_LITE_URL_POD: used by controller/agent pods (written to configmap as AGL_LITE_URL)
  - AGL_LITE_URL: host-facing output for algorithms/debugging (written to .local/agl-lite.env)
- Add explicit external input variable:
  - AGL_LITE_URL_EXTERNAL for --agl-external mode (legacy AGL_LITE_URL still accepted)
- Keep backward compatibility for host mode input:
  - AGL_LITE_URL_POD or legacy AGL_LITE_URL
- Compute and print both URLs per mode; write to .local/agl-lite.env
- Keep host-service launch behavior unchanged in --agl-in-host mode
- Update header docs/table to reflect the new URL contract
2026-03-30 05:05:44 -07:00
yuqyang ae53bfe125 fix: make in-k8s serve honor hooks/gateway config and restore math-poc mock e2e
Follow-up fixes after deploy mode refactor:
- cli.serve now falls back to env vars (GATEWAY_CONFIG/HOOKS/ARTIFACT_DIR)
  when CLI args are empty, so K8s env-injected settings are respected
- deploy/agl-lite/k8s.yaml injects GATEWAY_CONFIG/HOOKS/ARTIFACT_DIR from configmap
- deploy.sh configmap generation supports runtime overrides safely (no set -e pipefail trap)
- include examples/ in agl-lite image (.dockerignore) so hooks/config files exist in pod
- math-poc/run.sh updates:
  - sync mode env to deploy/.env
  - pass relative gateway config path for in-pod access
  - use explicit --agl-in-k8s/--agl-in-host
  - use dedicated local port-forward port (default 18080)
  - auto-derive mock MODEL_ENDPOINT when unset

Validation:
- unit/integration tests: 317 passed
- E2E run: examples/math-poc/run.sh mock passed
  (10/10 rollouts succeeded, 10 reward events, 60% deterministic accuracy).
2026-03-30 03:48:01 -07:00
yuqyang 254fa161c4 refactor: refine deploy.sh modes with explicit external/host behavior
- Add explicit --agl-external mode (controller in K8s, server unmanaged)
- Add --agl-host-bind and --agl-host-port flags for host launch control
- Keep backward compatibility aliases: --controller-only/--no-serve => --agl-in-host
- Tighten URL validation:
  - non-minikube host mode requires explicit pod-reachable AGL_LITE_URL
  - external mode requires explicit non-localhost AGL_LITE_URL
- Avoid localhost default for remote clusters in host mode
- Generalize minikube DNS patch trigger for non-k8s modes using host.minikube.internal
- Improve final mode-specific output messages

Result: clearer deployment semantics across in-k8s / in-host / external setups.
2026-03-30 03:00:15 -07:00
yuqyang 3e28829410 feat: add explicit deploy modes --agl-in-k8s/--agl-in-host and auto-launch host service
- scripts/deploy.sh now uses explicit modes:
  - --agl-in-k8s (default): server + controller in K8s
  - --agl-in-host: controller in K8s + agl-lite server launched on host
- Keep backward-compatible aliases: --controller-only and --no-serve => --agl-in-host
- In host mode, deploy.sh now launches agl-lite serve automatically (nohup),
  writes PID/log under .local/, health-checks readiness, and stops prior managed instance
- cleanup mode now also stops managed host server PID if present
- Update example scripts/docs to prefer --agl-in-host flag

Result: after deploy.sh, agl-lite service is runnable in both modes.
2026-03-30 02:06:35 -07:00
yuqyang 462f23fe26 feat: add calc_x migration baseline and prioritize it for training parity
- Copy non-legacy calc_x files from original Agent Lightning into examples/calc_x/
  (calc_agent.py, eval_utils.py, train_calc_agent.py, README, tests)
- Mark calc_x migration as next primary Phase 5c action in dev/todo.md
- Update calc_x README header to indicate migration WIP and legacy files ignored

This establishes an apple-to-apple starting point for adapting calc_x to agl-lite
VERL training flow.
2026-03-30 01:54:42 -07:00
yuqyang ad26645c6d refactor: split math-verl training example from math-poc pipeline example
Create a dedicated training example at examples/math-verl/:
- train.py (moved from examples/math-poc/train_verl.py)
- run.sh (starts agl-lite serve on host, then runs training)
- .env.example (training-specific defaults)
- README.md (scope + usage)

Clarify boundaries:
- examples/math-poc/ is now explicitly data pipeline verification only
- VERL training integration lives in examples/math-verl/

Update todo references to new training path.
317 tests pass.
2026-03-30 00:57:13 -07:00
yuqyang cff633f309 refactor: make math-poc VERL training path vllm-only
- Remove mock/vllm mode switch from train_verl.py
- Always use examples/math-poc/vllm/job-template.yaml
- Update README training command and note that training is vLLM-only

No behavior change for vLLM path; mock mode is explicitly unsupported for training.
317 tests pass.
2026-03-29 22:41:00 -07:00
yuqyang 29033ea20c feat: add math-poc VERL training entry script and wire resources_id
- Add examples/math-poc/train_verl.py as first Phase 5c training entry
  - builds small VERL config
  - loads/splits GSM8K sample dataset
  - runs preflight checks (healthz/auth/resources)
  - optional smoke rollout check (completion + triplet extraction)
  - calls agl_lite.verl.entrypoint.run_ppo(...)
- Update math-poc README with training smoke-run command
- Wire resources_id through VERL path:
  - trainer passes config.agentlightning.resources_id into train_information
  - daemon enqueues rollouts with resources_id
- Update todo: mark training script item done; keep remaining preflight assertions open

317 tests pass.
2026-03-29 20:34:43 -07:00
yuqyang a85b4d7993 refactor: delete async_server.py, update __init__.py
async_server.py: Removed. The PatchedvLLMServer monkey-patched vLLM to
return token IDs — agl-lite gateway handles this via param injection
(return_token_ids: true in gateway-config.yaml).

__init__.py: Only export daemon (guarded imports). trainer/dataset/entrypoint
require torch/verl/ray and must be imported directly.

317 tests pass.
2026-03-29 20:11:20 -07:00
yuqyang 88d90755c2 refactor: adapt entrypoint.py + config.yaml — remove agentlightning deps
entrypoint.py:
- Drop imports: TraceAdapter, LLMProxy, LightningStore, Dataset
- Drop params from run_ppo() and TaskRunner: store, llm_proxy, adapter, daemon_cls
- Read agl_lite_url/agl_key from config.agentlightning (user-facing namespace)
- Pass agl_lite_url/agl_key to trainer constructor
- Hydra config_path: pkg://agl_lite/verl

config.yaml:
- Replace port with agl_lite_url + agl_key (env var defaults via OmegaConf)
- Remove custom_async_server block (gateway handles token ID injection)
- Keep agentlightning namespace (user-facing)

248 → 220 lines. 317 tests pass.
2026-03-29 20:10:35 -07:00
yuqyang 79c026d2ca refactor: adapt dataset.py — replace agentlightning.types.Dataset with Sequence
The original Dataset was just a Protocol with __getitem__ + __len__.
Replace with typing.Sequence[Any] — no behavioral change.
2026-03-29 20:08:42 -07:00
yuqyang ab6ca6a574 refactor: adapt trainer.py — use AglLiteDaemon internally
Remove agentlightning dependencies from trainer.py internals:
- Drop imports: TraceAdapter, TraceToTripletBase, LLMProxy, LightningStore
- Drop constructor params: store, llm_proxy, adapter, daemon_cls
- Add constructor params: agl_lite_url, agl_key
- Create AglLiteDaemon directly in fit() instead of daemon_cls factory
- Remove adapter isinstance check (gateway handles event→triplet)
- Remove v0/v1 mode selection (always HTTP)

Keep user-facing names unchanged:
- Class remains AgentLightningTrainer
- Config namespace remains agentlightning.*

Training logic (_train_step, _validate, _compute_reference_log_prob) unchanged.
549 → 530 lines. 317 tests pass.
2026-03-29 20:05:54 -07:00
yuqyang 3700d9c3a1 refactor: adapt daemon.py — replace AgentModeDaemon with AglLiteDaemon
Replace Agent Lightning's AgentModeDaemon (1155 lines) with AglLiteDaemon
(945 lines) that talks to agl-lite over HTTP via AglLiteClient.

Removed:
- All v0 legacy code (AgentLightningServer, Flask proxy server)
- All v1 store/proxy/adapter code (LightningStore, LLMProxy, TracerTraceToTriplet)
- agentlightning imports (6 import lines)
- _find_available_port(), _start_proxy_server_v0(), _update_proxy_server_v1()

Added:
- AglLiteClient for HTTP calls (register_models, enqueue_rollouts, get_events, get_rollout)
- Local Pydantic types (Triplet, Task, RolloutLegacy) replacing agentlightning.types
- Optional torch/verl imports (graceful degradation when not installed)

Kept unchanged:
- get_train_data_batch() (328 lines of tensor construction)
- Multimodal/mrope support
- Utility functions (padding, ids_startswith, _to_native)
- Validation and metrics (get_test_metrics, _validate_data)

Fix test: left_pad_truncate keeps last N tokens (Agent Lightning behavior).
All 317 tests pass.
2026-03-29 19:06:08 -07:00
yuqyang 7dd323d0b3 update for documents 2026-03-28 00:04:06 -07:00
yuqyang fe72b2019d chore: copy verl module from agent-lightning verbatim
Copy all files from agentlightning/verl/ into agl_lite/verl/ as-is:
- daemon.py (AgentModeDaemon, 1155 lines)
- trainer.py (AgentLightningTrainer, 549 lines)
- dataset.py (AgentDataset + LoadedDataset, 44 lines)
- entrypoint.py (run_ppo + TaskRunner, 248 lines)
- async_server.py (PatchedvLLMServer, 46 lines)
- config.yaml (Hydra defaults)
- __init__.py, __main__.py

Our previous AglLiteDaemon backed up to ~/tmp/agl_lite_daemon.py.
Next step: adapt to use agl-lite HTTP API, removing agentlightning deps.
2026-03-27 23:59:47 -07:00
yuqyang d2888593e0 run.sh: remove unnecessary pip-cache setup from mount section
Pip cache is in-VM only, DirectoryOrCreate handles creation.
2026-03-27 07:59:16 -07:00
yuqyang a5c3cf7aba swe_bench: minikube mount for host-accessible artifacts
hostPath in minikube (docker driver) is inside the VM, not the host.
run.sh now starts 'minikube mount' to bridge artifacts dir to host:
  host: ./artifacts/ (or AGL_ARTIFACT_DIR)
  VM:   /data/agl-artifacts

Also ensures pip-cache dir exists in VM for persistence.
Mount process cleaned up on exit.
2026-03-27 07:57:23 -07:00
yuqyang c3e9e476fe swe_bench: add pip cache hostPath volume for faster container startup
Mount /data/pip-cache → /root/.cache/pip so pip install swebench
only downloads on first run. Subsequent containers reuse cached
wheels from the shared hostPath (single-node minikube assumption).
2026-03-27 07:33:15 -07:00
yuqyang 06cba884c4 add AGL_ATTEMPT_ID env var (logical alias for AGL_POD_UID)
AGL_POD_UID is an infra concept (K8s pod UID), AGL_ATTEMPT_ID is
the agl-lite logical concept. Same value, cleaner abstraction for
container scripts.
2026-03-27 07:27:36 -07:00
yuqyang 80255e4548 swe_bench: move all event posting to grade.py, pure bash entrypoint
grade.py now takes output_dir and artifact_path as arguments:
  1. Reads patch.diff from output_dir, posts agent_output event
  2. Reads test_output.txt from output_dir, grades, posts reward event

entrypoint.sh is now pure bash (zero inline Python):
  Phase 1: install + run agent
  Phase 2: git diff → OUTPUT_DIR/patch.diff
  Phase 3: eval_script → OUTPUT_DIR/test_output.txt
  Phase 4: python3 grade.py OUTPUT_DIR artifact_path
  Phase 5: cp OUTPUT_DIR → ARTIFACT_DIR

Clean separation: bash owns files, Python owns events.
2026-03-27 07:24:14 -07:00
yuqyang deabe53444 swe_bench: remove patch_size from grade.py and reward event
patch_size is agent output metadata, already reported in the
agent_output event. Doesn't belong in the grading/reward path.
2026-03-27 07:17:44 -07:00
yuqyang 73617f82ba swe_bench: reorganize output flow, grade.py takes path argument
Output flow redesigned:
- All outputs written to local /tmp/agl_output/ first (patch.diff,
  test_output.txt)
- grade.py receives test_output path as CLI argument (no hardcoded path)
- grade.py is pure grading + reward posting (no file copying)
- Shell handles all file operations: archive to
  ARTIFACT_ROOT/rollout_id/attempt_id at the end
- agent_output event includes artifact_path (relative to ARTIFACT_ROOT)
  for downstream consumers to locate archived files
- Patch written to file instead of shell variable (avoids large string
  in memory)
2026-03-27 07:14:57 -07:00
yuqyang 1f33e3c245 swe_bench: install swebench explicitly in entrypoint via python3 -m pip
Move swebench installation from grade.py auto-install to entrypoint.sh.
Use 'python3 -m pip' for robustness — ensures pip matches the Python
that runs grade.py, regardless of conda env or pip/pip3 aliasing.
2026-03-27 05:04:15 -07:00
yuqyang be511e7be0 swe_bench: extract grading into grade.py, mounted via ConfigMap
Move inline Python grading + reward posting + archival from
entrypoint.sh into agents/grade.py. Cleaner, testable, maintainable.

entrypoint.sh phases 4/5/6 replaced with single line:
  python3 /agl/agents/grade.py "$PATCH_SIZE"

grade.py handles:
  - swebench get_eval_report() via SimpleNamespace test_spec
  - auto-install swebench if not present
  - POST reward event via urllib (no curl dependency)
  - archive test log to hostPath volume

Mounted alongside other agent scripts via ConfigMap.
2026-03-27 04:55:01 -07:00
yuqyang 94b709af23 todo: mark completed SWE-bench refactoring items 2026-03-27 04:40:11 -07:00
yuqyang 313a537b31 swe_bench: move grading into container, hostPath for artifacts
Architecture change:
- Container does agent → eval → grade (via official get_eval_report) →
  post small reward event (~200B) → archive test log to hostPath
- on_succeeded hook simplified to fallback-only: posts zero reward if
  container didn't post one. No file I/O, no grading logic.
- Artifact event posting removed from entrypoint (no large HTTP payloads)
- hostPath volume added to job-template.yaml for test log archival
- AGL_ROLLOUT_ID injected by controller for artifact path
- AGL_EVAL_META extended with repo/version for container grading
- Grading uses SimpleNamespace as minimal test_spec (avoids make_test_spec
  in container — only needs instance_id, repo, version, FAIL_TO_PASS,
  PASS_TO_PASS)

Files changed:
- examples/swe_bench/agents/entrypoint.sh: 6 phases (agent → patch →
  eval → grade → reward → archive)
- examples/swe_bench/hooks.py: on_succeeded simplified, removed
  _extract_patch/_find_artifact, added _has_reward_event
- examples/swe_bench/job-template.yaml: hostPath volume for artifacts
- examples/swe_bench/rl_loop.py: updated docstring
- agl_lite/controller/job_builder.py: inject AGL_ROLLOUT_ID
- tests/test_swebench_hooks.py: 12 tests rewritten for new architecture

317 tests passing.
2026-03-27 04:40:01 -07:00
yuqyang c89247e6ed todo: update SWE-bench design — grading in container, hostPath for artifacts
Key changes:
- (B) Container now does agent + eval + grading (not just agent + eval)
- (C) on_succeeded hook simplified — no file I/O, no grading logic
- (D) Artifacts written to hostPath volume for debugging, not through HTTP API
- Artifact event type in store no longer needed
- swebench package installed in container, not server
- Added E2E status section with verified items and remaining work
2026-03-27 04:31:11 -07:00
yuqyang bbcb514caf fix: pipe large artifact payload to curl via stdin
Test output can be 300KB+, exceeding shell argument length limits.
Use python to build JSON payload and pipe to curl --data-binary @-
instead of passing as -d argument.

Also update default model to Qwen3-4B-Thinking-2507, add
--tensor-parallel flag to start_vllm.sh.
2026-03-27 00:52:04 -07:00
yuqyang 349ae38c64 start_vllm.sh: enable tool use by default (hermes parser) 2026-03-26 23:13:27 -07:00
yuqyang a803cc64f0 start_vllm.sh: make max-model-len optional (use model default) 2026-03-26 23:12:19 -07:00
yuqyang b78d8a6bc2 start_vllm.sh: add --tool-call-parser flag for tool use support
Claude Code sends tool_choice: 'auto' which vLLM rejects unless
started with --enable-auto-tool-choice --tool-call-parser <parser>.

Usage:
  scripts/start_vllm.sh --tool-call-parser hermes  # Qwen2.5
  AGL_VLLM_TOOL_CALL_PARSER=hermes scripts/start_vllm.sh  # via env
2026-03-26 23:09:43 -07:00
yuqyang e3099b42fa todo: mark SWE-bench as [ongoing] 2026-03-26 23:05:38 -07:00
yuqyang 5248d7fe86 swe_bench run.sh: add cleanup step before each run
Kills old agl-lite server processes and deletes the namespace
(with all K8s resources) before starting fresh. Ensures clean
state — no stale secrets, old rollouts, or lingering pods.
2026-03-26 22:58:23 -07:00
yuqyang 3fc35e6ea3 revert: remove blanket controller restart from deploy.sh
deploy.sh should be idempotent and minimal. E2E test scripts
handle cleanup (namespace delete) before each run instead.
2026-03-26 22:58:05 -07:00
yuqyang b8fdd094d8 Revert "deploy.sh: use config hash annotation instead of blanket restart"
This reverts commit fc1b15aaf7.
2026-03-26 22:57:52 -07:00
yuqyang fc1b15aaf7 deploy.sh: use config hash annotation instead of blanket restart
Annotate controller deployment with sha256 of AGL_KEY + AGL_LITE_URL.
K8s triggers rolling update only when the hash changes (secret or
config actually changed). No unnecessary restarts on first deploy
or idempotent redeploys.
2026-03-26 22:55:45 -07:00
yuqyang 66093a4968 fix: add auth header to event POSTs, note vLLM tool-choice requirement
- entrypoint.sh: add Authorization header to curl POST for agent_output
  and artifact events (was getting 401 Unauthorized)
- vLLM requires --enable-auto-tool-choice and --tool-call-parser for
  Claude Code's tool use requests
2026-03-26 22:49:22 -07:00
yuqyang b71252ef98 fix: ANTHROPIC_BASE_URL without /v1, restart controller on redeploy
- ANTHROPIC_BASE_URL set to gateway_base (no /v1 suffix) — Anthropic SDK
  appends /v1/messages itself. Fixes double /v1 path issue.
- deploy.sh: restart controller deployment after apply to pick up
  secret/configmap changes.
- 317 tests passing.
2026-03-26 22:44:46 -07:00
yuqyang eee55e2d0c fix: add swebench/ Docker Hub prefix to SWE-bench image names 2026-03-26 20:13:36 -07:00
yuqyang 4479cb036e chore: default artifact dir to ./artifacts (project-local, gitignored) 2026-03-26 19:57:22 -07:00
yuqyang 9a5f046448 gitignore: add artifacts/ 2026-03-26 19:56:49 -07:00
yuqyang 392e09efbc swe_bench: default model to Qwen2.5-Coder-3B-Instruct for quick testing 2026-03-26 19:44:35 -07:00
yuqyang 74d4c3576c swe_bench: check vLLM model availability in run.sh
- Verify model server is reachable at AGL_MODEL_ENDPOINT
- Check AGL_MODEL_NAME is in the served models list (warn if not)
- Fix default agent from mini_swe_agent → claude_code
- Clean up env var exports
2026-03-26 19:36:51 -07:00
yuqyang b89d105599 feat: env var substitution in gateway config (${VAR_NAME})
Gateway config now supports ${VAR_NAME} syntax — resolved from environment
at load time via os.path.expandvars(). Useful for model name routing:

  routes:
    - model_in: "*"
      model_out: "${AGL_MODEL_NAME}"

SWE-bench gateway config updated to use this — Claude Code's model names
(e.g., claude-sonnet-4-20250514) get rewritten to the actual backend model.

2 gateway config tests added (317 total passing).
2026-03-26 19:33:02 -07:00
yuqyang e7aa70bacf refactor: remove mini_swe_agent, use claude_code only
Removed mini_swe_agent (will add other agents later).
Updated claude_code based on Agent Lightning's claude_code_controller.py:
- Prompt structure: heredoc approach for shell safety
- SWEBENCH_USER_PROMPT with 5-step instructions (reproduce, locate, fix, verify, cleanup)
- SWEBENCH_EXTRA_SYSTEM_PROMPT for expert context
- Claude CLI flags: --dangerously-skip-permissions, --output-format json, --verbose
- IS_SANDBOX=1, ANTHROPIC_AUTH_TOKEN setup
- Hook handler (handle_hook.sh) for capturing tool use events
- Claude settings.json with PreToolUse/PostToolUse/Stop hooks

Default agent changed from mini_swe_agent → claude_code.
315 tests passing.
2026-03-26 08:33:01 -07:00
yuqyang 307d5e6056 todo: mark SWE-bench example [completed] 2026-03-26 08:02:02 -07:00
yuqyang 7b6f7b690a feat: SWE-bench example — hooks, agents, rl_loop, deploy config
Complete examples/swe_bench/ implementation:

Hooks (hooks.py):
- on_enqueue: set per-instance Docker image, generate eval_script via
  make_test_spec(), inject env vars (AGL_TASK_INPUT, AGL_EVAL_SCRIPT, AGL_EVAL_META)
- on_succeeded: read test_output artifact from disk, grade via official
  get_eval_report(), post reward event (resolved/not resolved)
- on_failed: post zero reward event

Agent scripts:
- entrypoint.sh: shared entrypoint (agent → eval → post artifacts)
- mini_swe_agent: lightweight Python agent with OpenAI tool_use
- claude_code: Claude Code CLI wrapper

Infrastructure:
- rl_loop.py: task-agnostic algorithm (same pattern as math-poc)
- job-template.yaml: generic pod spec, image overridden by hook
- Dockerfile.server: agl-lite + swebench package
- run.sh: one-command E2E runner
- .env.example, gateway-config.yaml, README.md

Tests: 12 SWE-bench hook tests (mocked swebench), 315 total passing.
2026-03-26 08:01:56 -07:00
yuqyang 4e7e02853c feat: artifact event type — large files written to disk
Artifact events (event_type='artifact') are handled specially by the store:
- Content is written to disk at <artifact_dir>/<rollout_id>/<filename>
- Event data replaced with lightweight reference (path, filename, size)
- Hooks can read artifacts from disk (fits sync constraint)

New: --artifact-dir CLI flag and ServerSettings.artifact_dir
Default: /tmp/agl-artifacts

7 artifact tests added (303 total passing).

Needed for SWE-bench: container posts test_output.txt as artifact,
on_succeeded hook reads from disk and grades via get_eval_report().
2026-03-26 07:53:05 -07:00
yuqyang 2e9ac2a4be todo: resolve Q3 — ConfigMap for agent scripts 2026-03-26 07:50:46 -07:00
yuqyang cfa09ae395 todo: mark SWE-bench example [ready], resolve open questions 2 and 5 2026-03-26 07:45:10 -07:00
yuqyang 9b3163a4df deploy.sh: only patch CoreDNS when AGL_LITE_URL uses host.minikube.internal 2026-03-26 07:31:35 -07:00
yuqyang 58dc0cea12 update SWE-bench proposal + deploy.sh improvements
SWE-bench proposal (dev/todo.md):
- Grading in on_succeeded hook (not container): uses official get_eval_report()
- Artifact events for large files (test logs): store writes to disk, hook reads
- Container only runs agent + eval_script, posts raw artifacts
- Server on compute backend (--controller-only) as default deployment

deploy.sh:
- Rename --no-serve → --controller-only (clearer intent, --no-serve kept as alias)
- Auto-set AGL_LITE_URL for in-cluster mode (http://agl-lite.<ns>.svc:8080)
- Auto-patch CoreDNS on minikube for host.minikube.internal resolution
- Descriptive header comments for both deployment modes

Cleanup:
- Remove hostAliases hack from math-poc vllm/job-template.yaml
- Update deploy/.env.example with mode documentation
2026-03-26 07:29:20 -07:00
yuqyang bac897a316 todo: rewrite SWE-bench proposal for hooks architecture
Updated to reflect the implemented hooks mechanism:
- on_enqueue hook: set per-instance image, generate eval_script via
  make_test_spec(), inject env vars (AGL_EVAL_SCRIPT, AGL_EVAL_META)
- Grade inside container (not in hook): entrypoint runs agent → eval →
  grade.py → posts reward event. No shared volume needed.
- Algorithm is task-agnostic: sends raw dataset rows, reads reward events
- Removed stale 'Files to Create' for agl_lite/ core (already done)
- Reconciled container-vs-hook grading (decided: container)
- Trimmed open questions from 5+1 to 5 (resolved: grading location)
2026-03-26 01:35:54 -07:00
yuqyang 6606e926ea remove legacy code 2026-03-26 00:35:14 -07:00
yuqyang 6aea2f6ce7 cleanup: remove legacy math-poc files, rename v2 to final
Removed (replaced by mode subfolders):
  mock_rl_loop.py, rl_loop.py (old), run.sh (old)
  .env.mockai.example, .env.vllm.example
  gateway-config.yaml, job-template.yaml, k8s-mockai.yaml
  reference_output.log, reference_output_vllm.log

Renamed:
  rl_loop_v2.py → rl_loop.py
  run_v2.sh → run.sh

Final structure:
  examples/math-poc/
  ├── rl_loop.py        (unified, task-agnostic)
  ├── run.sh            (run.sh [mock|vllm])
  ├── Dockerfile.agent
  ├── README.md
  ├── agents/
  ├── data/
  ├── mock/             (hooks, .env, gateway-config, job-template, k8s-mockai)
  └── vllm/             (hooks, .env, gateway-config, job-template)
2026-03-26 00:30:26 -07:00
yuqyang abc6f44526 todo: confirm and remove Store Hooks + Math-poc restructuring
Both items verified via E2E. Added to Completed list.
Removed confirmed sections from todo (328 lines).
2026-03-26 00:29:39 -07:00
yuqyang e09180e8f9 fix: vllm hooks inject AGL_MODEL_NAME, job-template adds hostAliases
Two fixes found during E2E testing:
- vllm hooks.py: inject AGL_MODEL_NAME from server env into agent config
  (agent defaults to 'mock-llm' without it)
- vllm job-template.yaml: add hostAliases for host.minikube.internal
  (K8s pods can't resolve it via DNS, unlike minikube ssh)

E2E verified: 3/3 rollouts succeeded, hooks computed rewards correctly,
unified rl_loop_v2.py works end-to-end with vLLM mode.
2026-03-26 00:24:59 -07:00
yuqyang c351368305 fix: math-poc hooks respect job-template defaults, read ground_truth from input
(a) Hooks no longer override image -- it comes from job-template.
    Hook only sets config.environment_variables.AGL_TASK_INPUT.
(b) rl_loop_v2.py docstring documents algorithm contract:
    algorithm only sets input, resources_id, metadata per rollout.
(c) on_succeeded reads ground_truth from rollout.input directly,
    no copy to metadata needed.

296 tests passing, 7 math hook tests passing.
2026-03-25 23:55:32 -07:00
yuqyang b899c2f1b7 todo: mark math-poc restructuring as completed 2026-03-25 23:01:30 -07:00
yuqyang 6e875a1dc1 examples: math-poc restructured with hooks and mode subfolders
New structure:
  examples/math-poc/
  ├── rl_loop_v2.py          # unified, task-agnostic (~200 lines)
  ├── run_v2.sh              # run.sh [mock|vllm] (default: vllm)
  ├── mock/
  │   ├── hooks.py           # MathMockHooks: boxed embedding, exact match
  │   ├── .env.example
  │   ├── gateway-config.yaml
  │   ├── job-template.yaml
  │   └── k8s-mockai.yaml
  └── vllm/
      ├── hooks.py           # MathVllmHooks: plain questions, numeric reward
      ├── .env.example
      ├── gateway-config.yaml
      └── job-template.yaml

Hook responsibilities:
  on_enqueue: set image, AGL_TASK_INPUT, AGL_MODEL_NAME, stash ground_truth
  on_succeeded: extract answer from events, compute reward, post reward event

rl_loop_v2.py is fully task-agnostic: sends raw JSONL rows as input,
hooks do all transformation and grading. ~200 lines vs ~950 combined before.

7 new tests for mock + vllm hooks. 296 + 7 = 303 tests passing.
2026-03-25 23:01:23 -07:00
yuqyang b9bd98b850 todo: add math-poc restructuring with hooks [ongoing] 2026-03-25 22:56:50 -07:00
yuqyang 9dc3b80115 schemas: remove data field from RolloutMetadata
input already holds the raw dataset content. extra='allow' lets hooks
stash grading context (e.g., ground_truth) directly as extra fields
on metadata. No need for a reserved data dict.

RolloutMetadata is now minimal:
  batch_idx, sample_idx_in_batch, trial_idx_in_group + extra fields

296 tests passing.
2026-03-25 22:55:58 -07:00
yuqyang ec76bb7fd4 schemas: typed RolloutMetadata with algorithm control indexes
RolloutMetadata replaces dict[str, Any] with typed fields:
  - batch_idx, sample_idx_in_batch, trial_idx_in_group (algorithm tracking)
  - data: dict (raw dataset content for hooks to use in grading)
  - extra='allow' for task-specific extensions

Three fields now have clear consumers:
  input    → algorithm data (raw dataset row, read by hooks)
  config   → K8s controller (image, env vars, mounts)
  metadata → algorithm indexes + hook grading context (metadata.data)

296 tests passing.
2026-03-25 22:52:35 -07:00
yuqyang bd723cc86b refactor: remove AGL_TASK_INPUT auto-injection from job_builder
The controller no longer reads rollout.input — it only applies config.
Task input to the agent is now explicitly set by hooks via
config.environment_variables['AGL_TASK_INPUT'].

This cleanly separates:
  input    → algorithm data (raw dataset row, read by hooks)
  config   → K8s execution (env vars, image, mounts — set by hooks)
  metadata → algorithm control indexes (batch_idx, etc.)

Without hooks, agents get task from baked-in Docker image or from
config.environment_variables set directly by the caller.

296 tests passing.
2026-03-25 22:50:18 -07:00
yuqyang c690432db6 todo: mark Store Hooks as completed 2026-03-25 22:19:31 -07:00
yuqyang 163606fc99 feat: implement Store Hooks — rollout lifecycle hooks in server
RolloutHooks base class with 3 hook points:
- on_enqueue: pre-processor, transforms request before persist
- on_succeeded: post-transition, fires atomically after SUCCEEDED
- on_failed: post-transition, fires after TERMINAL_FAILED

Store integration (memory.py):
- __init__ accepts optional hooks parameter
- enqueue_rollouts: calls on_enqueue before creating each rollout
- update_rollout: calls on_succeeded/on_failed after status transition
- Hook errors are logged but don't crash the transition (except on_enqueue
  which prevents rollout creation — the request is invalid)

Infrastructure:
- agl_lite/hooks.py: RolloutHooks ABC + load_hooks() dynamic loader
- ServerSettings.hooks: path to hooks module
- CLI: agl-lite serve --hooks path/to/hooks.py
- create_app: loads hooks at startup, passes to InMemoryStore

12 new tests covering:
- on_enqueue: transforms request, passthrough without hooks, error prevents creation
- on_succeeded: reward posted atomically, wrong answer, hook error resilience
- on_failed: zero reward posted
- load_hooks: file loading, missing file, no subclass, multiple subclasses

296 tests passing (284 existing + 12 new).
2026-03-25 22:19:25 -07:00
yuqyang 6dfa1ce93b schemas: add metadata field to Rollout and EnqueueRolloutRequest
Hook-facing context (e.g., original dataset row, ground_truth, grading info).
Not sent to container — only accessible to store hooks for task-specific logic
like reward computation.

Three fields now have clear consumers:
  input    → agent (AGL_TASK_INPUT env var)
  config   → K8s controller (image, command, resources)
  metadata → hooks (dataset context, grading info)

284 tests passing.
2026-03-25 22:14:25 -07:00
yuqyang b8bdbb97b5 todo: finalize Store Hooks design — hooks as sync pre-processors in server
Replace TaskController (separate process) with RolloutHooks (in-server):
- on_enqueue: pre-processor, transforms request BEFORE persist
- on_succeeded: post-transition, runs inside update_rollout() atomically

Key insight: single-threaded sync store means hooks are atomic — no reader
can see intermediate state. No flags (reward_pending) or intermediate states
needed. Reward is in the store before update_rollout() returns.

User workflow: write hooks.py → build custom Docker image → done.
SWEBenchHooks: on_enqueue maps instance→image+eval_script,
  on_succeeded reads volume + calls official get_eval_report().

Updated SWE-bench file layout: add hooks.py, Dockerfile.server,
remove grade.py (grading now in server-side hook).
2026-03-25 20:54:51 -07:00
yuqyang 6212bc25f3 todo: Task Controller architecture — task-agnostic algorithm layer [discuss]
Key insight: separate task-specific logic (dataset parsing, image selection,
eval_script generation, official grading) from task-agnostic logic (model
registration, rollout polling, triplet→tensor construction).

TaskController interface:
  - prepare_rollouts(data, is_train) → List[EnqueueRolloutRequest]
  - compute_rewards(rollout_ids, volume_path) → Dict[str, float]

Volume-based grading: container writes test_output.txt + patch.diff to shared
volume. Algorithm-side TaskController reads files and calls official grading
tools (e.g., swebench get_eval_report). No grade.py needed in container.

Examples: SWEBenchController (~100 lines), MathController (~30 lines).
Daemon becomes task-agnostic (~300 lines). New task = new controller only.
2026-03-25 20:18:55 -07:00
yuqyang 2ce355d1ef todo: SWE-bench — single-container design (agent + eval in one rollout)
Key insight: eval_script only resets TEST files (from test_patch), not source
files. Agent's code modifications are untouched. So evaluation can run in the
same container right after the agent finishes.

- eval_script pre-generated by algorithm via make_test_spec() (~2KB bash)
- Passed to container via AGL_EVAL_SCRIPT env var
- entrypoint.sh: install agent → run agent → git diff → eval_script → grade → post reward
- grade.py: minimal log parser (~30 lines), no swebench package needed in container
- Eliminates second rollout, patch-passing, and Docker-on-host requirement
- Simplified file layout (no evaluation/ dir, no eval-job-template)
2026-03-25 19:01:09 -07:00
yuqyang 67089804a4 todo: update SWE-bench design — resolve (A)(B)(C)(D)(E) per discussion
(A) Use RolloutConfig.image (first-class field) instead of overrides
(D) Evaluation runs inside K8s as a second rollout, not on algorithm host
    - eval_script generated from swebench.harness.make_test_spec (pure Python)
    - evaluator job: apply patch + run eval_script + parse log + post reward
    - no Docker SDK needed on algorithm host
(C) ConfigMap for agent scripts + CLAUDE.md, mounted via existing Mount schema
(1) Naive image pull for now, IfNotPresent; Epoch AI trimmed images as fallback
(2) Volume mount via ConfigMap confirmed; open question on large files deferred
2026-03-25 00:50:36 -07:00
yuqyang 17bd0d5def todo: add SWE-bench example design [discuss]
Add examples/swe_bench design item covering:
- Per-instance SWE-bench Docker images via rollout overrides
- Pluggable coding agents (claude_code, mini_swe_agent) with install/run scripts
- Mountable config files (CLAUDE.md) via ConfigMap
- Reward function: separate evaluation container applies patch + runs golden tests
- Algorithm script structure following math-poc pattern with vLLM backend
- File layout and open questions for discussion
2026-03-25 00:11:57 -07:00
yuqyang ed3dd4a00d slides update 2026-03-22 22:36:34 -07:00
yuqyang 1966c8714c small changes 2026-03-22 08:48:37 -07:00
yuqyang 77392d321d docs: slides — add subtitle to Three Design Choices, split job-template into two pages 2026-03-22 08:41:07 -07:00
yuqyang e6859a0da1 docs: add job-template slide to Part 4 (store + controller)
Shows merge flow: job_template (raw pod spec) + controller injection +
rollout.config overrides → K8s Job. Two examples: simple math-poc
and multi-container coding tasks with scorer sidecar.
2026-03-22 08:36:37 -07:00
yuqyang a41979a06a docs: slides v3 — no animations, agent_output event, deployment demo, restructured
Changes:
- Remove all v-clicks/animations (technical discussion)
- Add agent_output as third reserved event type
- Move agent contract slide into gateway section
- Add deployment section with math-poc vLLM example
- Remove 'How You Can Help' page
- Use markdown image syntax for architecture diagram
- Add 7-item agenda matching new structure
2026-03-22 08:08:48 -07:00
yuqyang ee35412ed9 docs: rewrite refactor review slides — positive framing, no AL criticism
Restructured around three design choices (from README):
1. Self-owned gateway (replaces LiteLLM dep)
2. Gateway-level data capture (replaces OTEL dep)
3. K8s-native runner (store simplification as consequence)

Technical deep dives on gateway and store+controller.
Architecture diagram referenced from docs/images/.
No before/after comparisons with Agent Lightning.
2026-03-22 07:52:23 -07:00
yuqyang 16756d9569 docs: add refactor review slides for Agent Lightning developers
Slidev deck covering:
1. Why agl-lite (dependency problem, what we actually need)
2. Four key simplifications (LiteLLM, OTEL, Store, execution)
3. Architecture (high-level, data flow, weight updates)
4. VERL integration (AglLiteDaemon, triplet format, trainer code)
5. Developer guide (what lives where, agent contract, gateway config)
6. Status and next steps

21 content slides + 6 section dividers. ~25 min presentation.
2026-03-22 07:20:43 -07:00
yuqyang 51787311ce docs: update todo — Phase 5a+5b complete, 5c (full training loop) next 2026-03-22 07:05:45 -07:00
yuqyang 167e1ae9f6 feat: AglLiteDaemon — VERL trainer bridge via AglLiteClient
Phase 5a+5b: agl-lite side of VERL integration.

Server-side (5a):
- format=triplet on GET /api/events trims model_request to
  prompt_token_ids + response_token_ids, reward to scalar value
- AglLiteClient.get_events() accepts format param

Daemon (5b) — agl_lite/verl/daemon.py (851 lines):
  NEW (187 lines): store interaction via AglLiteClient
    - _async_set_up: register_models + enqueue_rollouts
    - _async_validate_data: get_events(format=triplet) → Triplet/RolloutLegacy
    - _async_run_until_finished: poll get_rollout for succeeded status
    - No proxy server, no adapter, no LightningStore
  COPIED (510 lines): from agent-lightning AgentModeDaemon
    - get_train_data_batch: triplets → padded tensors → DataProto
    - Multimodal (mrope, image handling)
    - Utilities (padding, token matching)
    - Validation/metrics

Tests: 9 new (5 utility, 4 daemon with real agl-lite server via ASGI transport)
Total: 284 tests passing
2026-03-22 07:04:34 -07:00
yuqyang 7901c3b39a feat: triplet format on GET /api/events?format=triplet
Adds format=triplet query param that trims events for RL training:
- model_request: extracts prompt_token_ids + response_token_ids from
  streaming (list of SSE chunks) or non-streaming (dict) responses,
  strips full request/response bodies
- reward: keeps only scalar value, strips message
- other event types: pass through unchanged

No new endpoint — same auth, filtering, pagination. Raw events still
available without the flag.

4 new tests (streaming, non-streaming, no token_ids, full-event baseline).
275 total tests passing.
2026-03-22 06:55:44 -07:00
yuqyang 805d1454c7 docs: fix Phase 5b framing — agent-lightning depends on agl-lite HTTP, not vice versa
Corrected dependency direction: agl-lite is a standalone HTTP service with no
VERL/torch knowledge. The daemon subclass (Option A) lives in agent-lightning
repo, talks to agl-lite over HTTP. Recommended Option A (~150 lines) over
Option B (~650 lines with copied tensor math).
2026-03-22 06:36:20 -07:00
yuqyang 7255d65220 docs: Phase 5 design — triplet API + VERL integration options A/B
Detailed daemon breakdown (1154 lines: 30% replace, 63% reuse, 6% simplify).
Phase 5a: triplet API in agl-lite (events→triplets server-side).
Phase 5b: two options for VERL-side — daemon subclass vs standalone interface.
Phase 5c: full training loop E2E.
2026-03-22 06:21:46 -07:00
yuqyang 9fa477335c docs: update todo — Phase 4b with colocated topology, gateway injection, new decisions 2026-03-22 05:17:31 -07:00
yuqyang f6215e2eb5 refactor: colocate agl-lite with algorithm on host in vLLM mode
Topology change for vLLM mode:
  Before: agl-lite in minikube pod, port-forward to host, gateway→vLLM
          crosses minikube↔host network boundary
  After:  agl-lite on host (process), gateway→vLLM is localhost,
          no port-forward needed, only controller+agents in minikube

Changes:
- deploy.sh: --no-serve flag skips agl-lite Deployment (controller-only)
- run.sh: vLLM mode starts 'agl-lite serve' as host process with gateway
  config, waits for healthz; mock mode unchanged (all in K8s + port-forward)
- .env.vllm.example: AGL_LITE_URL=host.minikube.internal:8080 (K8s→host),
  AGL_MODEL_ENDPOINT=localhost:8010 (gateway→vLLM, both on host)
- README: updated architecture diagram showing colocated topology
- Both modes E2E verified: mock 10/10, vLLM 4/5 (80%) all checks pass
- 271 unit tests passing
2026-03-22 05:08:22 -07:00
yuqyang f6119deac9 feat: gateway param injection — return_token_ids for RL training
- gateway-config.yaml: wildcard route adds return_token_ids=true to all requests
- run.sh: in vLLM mode, creates ConfigMap from gateway config and patches
  agl-lite deployment with volume mount + --gateway-config flag
- proxy: event captures prepared body (with injected params), not original
  — RL algorithm sees exactly what was sent to model server
- rl_loop.py: logs prompt_token_ids + response token_ids from events,
  2 new structural checks (return_token_ids in request, token_ids in response)
- Verified: 102 prompt tokens + 253 response tokens captured per rollout
- Updated reference_output_vllm.log with token_ids
- 271 unit tests passing
2026-03-22 03:40:57 -07:00
yuqyang 46f7214e7e docs: update todo — Phase 4b complete, performance baseline to backlog 2026-03-22 03:23:34 -07:00
yuqyang 45fb153b65 feat: vLLM E2E verified — reference log + both modes documented
- reference_output_vllm.log: Qwen2.5-1.5B-Instruct, 5/5 correct (100%)
  Real math reasoning with \boxed{} parsing, 288 SSE chunks per response
- README: verify section for both modes, files table updated
- vLLM E2E: all 7 checks pass (rollouts, events, version, structural, accuracy)

Two reference logs:
  reference_output.log      — mock mode (deterministic, avg reward 0.60)
  reference_output_vllm.log — vLLM mode (real inference, 5/5 = 100%)
2026-03-22 03:20:07 -07:00
yuqyang be5fa1a333 feat: rl_loop.py for real vLLM inference + updated docs
- rl_loop.py: real algorithm for GSM8K with vLLM
  - Plain questions as input (no \boxed{} embedding trick)
  - Numeric reward: normalize_number() handles 18/18.0/$18/18,000
  - Structural checks on model_request events (streaming)
  - Sanity check: at least some correct answers expected
  - Logs first model_request with actual LLM reasoning
- Agent: --model defaults to AGL_MODEL_NAME env var (no hardcoded model)
- job-template: command is just 'python /app/qa_agent.py' (model from env)
- mock_rl_loop: passes AGL_MODEL_NAME via environment_variables in config
- README: rewritten with both architectures, vLLM Docker setup, start_vllm.sh
  usage, environment details, file index
- Mock mode E2E verified: still passes all checks
2026-03-22 03:12:01 -07:00
yuqyang 2d1f094ad8 feat: vLLM setup — Docker-based, convenience script, verified E2E path
- scripts/start_vllm.sh: start/stop vLLM in Docker container
  --model, --port, --gpu, --gpu-mem, --max-model-len, --stop
  Waits for health check, prints connection info for host + minikube
- .env.vllm.example: updated with Docker settings (port 8010, GPU 0,
  gpu-memory-utilization 0.2), start_vllm.sh usage in header
- Verified: vLLM 0.18.0 (vllm/vllm-openai:latest Docker image)
  - Qwen2.5-1.5B-Instruct serving on GPU 0 (shared machine, 12GB free)
  - Real math reasoning with \boxed{} format works
  - Reachable from minikube via host.minikube.internal:8010
- pip install approach failed (triton/gcc compilation issue with CUDA 13);
  Docker image works reliably
2026-03-22 02:51:47 -07:00
yuqyang dba4531fa3 refactor: two self-contained .env examples, mode-aware run.sh
- .env.mockai.example: complete config for mock mode (CPU-only minikube)
- .env.vllm.example: complete config for vLLM mode (host GPU)
- User copies one to deploy/.env — single config file, everything in one place
- run.sh: reads AGL_MODEL_MODE, skips mockai deploy in vllm mode,
  runs mock_rl_loop.py or rl_loop.py accordingly, checks vLLM reachable
- mock_rl_loop.py: reads BATCH_SIZE/NUM_ITERATIONS/MODEL_NAME/MODEL_ENDPOINT
  from env (sourced from .env via run.sh)
- README: updated quick start to show the two-file workflow
- Removed old examples/math-poc/.env.example (replaced by mode-specific files)
- E2E verified: mock mode still passes all checks
2026-03-21 23:50:49 -07:00
yuqyang 972d646771 docs: math-poc .env.example + README with architecture diagrams
- .env.example: PoC-specific config (MODE, MODEL_NAME, VLLM_PORT, etc.)
- README: mock vs vLLM architecture diagrams, event flow table,
  quick start for both modes, environment details table, file index
- Separates infra config (deploy/.env) from PoC config (examples/math-poc/.env)
2026-03-21 23:31:33 -07:00
yuqyang 017ef879d7 docs: clean todo — Phase 4a complete, 4a.7 to backlog, ready for 4b 2026-03-21 23:19:09 -07:00
yuqyang f965fd9083 feat: verify model_request events in E2E — streaming mode, full structure
- Agent now uses stream=True (OpenAI SDK streaming)
- mock_rl_loop: prints first model_request event in full detail:
  server (model, version, endpoint), request (model, stream, messages),
  response (SSE chunk count, first chunk, assembled content)
- 10 structural assertions per model_request event:
  has request/response/server, has model, ≥2 messages, stream=True,
  has version, response is list (SSE), response non-empty
- All 10 rollouts × 10 checks = 100 assertions pass
- reference_output.log updated with streaming sample + redacted IDs
2026-03-21 23:14:52 -07:00
yuqyang 54065e7621 feat: embed \boxed{} in task input for deterministic reward testing
- build_tasks: alternating pattern (even=correct, odd=wrong)
- Correct tasks: embed \boxed{ground_truth} → reward=1.0
- Wrong tasks: embed \boxed{WRONG} → reward=0.0
- Assert agent_answer matches embedded boxed value exactly
- Assert reward matches expected (1.0 or 0.0)
- Log tags: ✓/✗ per task and per result
- Expected avg reward: 0.60 (3/5 correct per batch of 5)
- All 7 checks pass including new 'Answer assertions' check
- Updated reference_output.log with new format
2026-03-21 23:02:59 -07:00
yuqyang ea75bc4921 feat: add logging to run.sh + reference output log
- run.sh: tee all phases to logs/<timestamp>/ directory
- Cleanup collects K8s logs: agl-lite, controller, mockai, agent pods, pods/jobs
- reference_output.log: redacted (rollout IDs → <rollout-id>) for user comparison
- logs/ dir gitignored, reference_output.log explicitly un-ignored
2026-03-21 22:45:15 -07:00
yuqyang 2ba3aa4d03 feat: Math PoC E2E working — 10/10 rollouts, all events, version tracking
Fixes from live testing:
- build_images.sh: -f flag relative to build context for Dockerfile.agent
- run.sh: export AGL_KEY so child processes see it
- controller k8s.yaml: pass --agl-lite-url, --namespace, --secret-name as args
  (CLI defaults override env vars with Typer)
- mock_rl_loop.py: deterministic task selection (sequential, no randomness),
  detailed reproducible logs (no timestamps, tempo order)

E2E results:
- 2 iterations, 5 rollouts each, all 10 succeeded
- 10 model_request (gateway auto), 10 agent_output (agent), 10 reward (algorithm)
- Version 1 in iter 1, version 2 in iter 2 (weight update verified)
- Reward 0.00 (expected — mockai echo mode echoes question, no \boxed{})

271 unit tests passing.
2026-03-21 21:35:24 -07:00
yuqyang 7969c1d3e5 refactor: image + command in job-template.yaml, not per-rollout
- job-template.yaml now includes image, command, imagePullPolicy
- RolloutConfig.image changed from required to optional (str | None)
- job_builder: only set image/command if RolloutConfig provides them
- mock_rl_loop.py: config={} — all agent config comes from template
- Simpler: template = complete pod environment, rollout = just task input
2026-03-21 21:11:19 -07:00
yuqyang 49d97afb98 refactor: agent takes model as CLI arg, task input as plain string
qa_agent.py:
- Model via --model arg (set in RolloutConfig.command), not in task input
- System prompt as separate message (avoids \boxed{} escaping in f-strings)
- Task input is a plain text question string (json.loads → str)

mock_rl_loop.py:
- AGENT_COMMAND includes --model flag
- Task input is plain string (the question), not a dict
- Matching by rollout.input string for ground truth lookup

Schema changes:
- rollout.input: dict → Any (supports string, dict, or any JSON-serializable)
- EnqueueRolloutRequest.input: dict → Any

271 tests passing.
2026-03-21 21:08:33 -07:00
yuqyang 9684a190dc feat: redesign agent + algorithm event flow
qa_agent.py rewritten:
- Prompt template: math assistant with \boxed{answer} format
- Task input: dict with 'question' field (plain text problem)
- Parses \boxed{answer} from LLM response
- Posts agent_output event to AGL_EVENT_URL with extracted answer
- Uses httpx (bundled with openai SDK) for event posting

mock_rl_loop.py rewritten:
- Passes plain questions as task input (no embedded answers)
- Retrieves agent_output events to get parsed answers
- Compares to ground truth, posts reward events
- Verifies all three event types: model_request, agent_output, reward

Reserved event types:
- model_request: auto-captured by gateway
- agent_output: reported by agent (parsed result)
- reward: reported by algorithm (ground truth comparison)

271 tests passing.
2026-03-21 21:00:27 -07:00
yuqyang 6c4d8a017d refactor: move agents into examples/math-poc/agents/ (PoC-specific, not shared) 2026-03-21 20:47:52 -07:00
yuqyang 9f14cfcca6 feat: Math PoC — mock RL loop with mockai on minikube
examples/math-poc/:
- mock_rl_loop.py: 2-iteration RL loop (register resources/models, enqueue
  batches, poll, retrieve events, compute rewards, weight update v1→v2)
- job-template.yaml: K8s pod spec for agent jobs (imagePullPolicy: Never)
- Dockerfile.agent: python:3.12-slim + openai SDK + qa_agent.py
- k8s-mockai.yaml: mockai Deployment + Service (echo mode)
- data/gsm8k_sample.jsonl: 30 GSM8K problems
- run.sh: one-command E2E (build images → deploy infra → deploy mockai →
  port-forward → run algorithm → cleanup)
- README.md: explanation + quick start

Dataset design: algorithm embeds correct/wrong answers in prompts,
mockai echoes back, reward function parses and compares to ground truth.

job_builder.py: updated to accept direct pod spec format (no spec: wrapper).

271 tests passing.
2026-03-21 20:18:21 -07:00
yuqyang e52af54a60 docs: clean todo — condense completed 4a.1-4a.4b into summary 2026-03-21 19:57:46 -07:00
yuqyang 80723d8e72 refactor: job_defaults → job_template (raw K8s pod spec)
Breaking changes:
- Removed JobDefaults typed schema and K8sResources from resources.py
- Reserved key in resources changed from 'job_defaults' to 'job_template'
- job_template is an opaque raw dict — any valid K8s pod spec field works
- No validation at store level; K8s validates when controller submits Job

RolloutConfig changes:
- Added 'overrides: dict[str, Any]' field for per-rollout K8s overrides
- Named fields (image, command, env_vars) target 'agent' container
- overrides.containers enables name-matched merge into other containers

job_builder.py rewritten:
- Starts from job_template as base pod spec (deep copy, not mutate)
- Applies rollout.config.overrides (name-matched container merge)
- Injects named fields into 'agent' container (finds or creates it)
- Injects controller env vars (gateway URLs, keys, task input)
- Wraps in Job metadata (name, namespace, labels, backoffLimit, ttl)

reconciler.py updated:
- _get_job_defaults → _get_job_template (returns raw dict)
- Error classification: invalid spec (422) → terminal_failed,
  transient errors → stay queuing and retry

Tests rewritten:
- test_job_builder.py: 35 tests covering template passthrough, multi-container,
  name-matched overrides, env injection, mounts, deep merge
- test_resources.py: simplified (opaque dict, no schema validation)
- test_reconciler.py: updated caching tests for job_template

271 tests passing.
2026-03-21 09:09:43 -07:00
yuqyang 5b60310abc docs: architecture + todo — job_template design, error handling, use cases
Architecture doc updated:
- job_defaults → job_template (raw K8s pod spec, no typed schema)
- Merge order: template → overrides (name-matched containers) → named fields → controller
- Three use cases documented: simple, multi-container sidecar, per-task multi-image
- Error handling: invalid spec → terminal_failed, resource shortage → stay queuing
- RolloutConfig gains overrides field (targets other containers via name match)

Todo 4a.4b updated with error handling requirements.
2026-03-21 09:01:36 -07:00
yuqyang 495de26769 docs: add 4a.4b — refactor job_defaults → job_template (raw K8s spec)
Blocking issue for 4a.5: current JobDefaults schema is ad-hoc typed
fields + overrides escape hatch. Replace with raw K8s pod spec dict
loaded from YAML file. No schema validation at store level.

Key changes planned:
- Remove JobDefaults typed schema
- job_template = raw dict (any valid K8s field)
- overrides moves to RolloutConfig (per-rollout escape hatch)
- deploy/job-template.example.yaml for infra team
- Simplified merge: template → overrides → named fields → controller
2026-03-21 08:24:55 -07:00
yuqyang e507e1eee3 feat: qa_agent.py — minimal example agent for E2E testing
examples/agents/python/qa_agent.py:
- Reads AGL_TASK_INPUT (JSON with prompt), calls LLM via openai SDK, prints result
- openai SDK reads OPENAI_BASE_URL + OPENAI_API_KEY from env (set by controller)
- max_retries=5 for 503 handling during weight updates
- CRASH_ON_FIRST=1 support: marker file at /tmp so only first attempt crashes
  (for K8s Job retry testing)
- Does NOT import agl-lite — proves language-agnostic contract
- ~50 lines, zero agl-lite dependencies
2026-03-21 08:02:21 -07:00
yuqyang b93d74c433 chore: ignore .env in all subdirs for both git and docker 2026-03-21 07:56:43 -07:00
yuqyang 16a1dd6b27 revert: back to bash + .env, remove Python deploy and YAML config
deploy/.env.example: flat KEY=VALUE, all config in one file.
  AGL_KEY commented out as placeholder — user sets via env var or uncomments.
scripts/deploy.sh: ~80 lines bash, reads .env, creates ConfigMap via
  --from-env-file (excluding AGL_KEY), Secret via --from-literal.
Removed: scripts/deploy.py, deploy/config.example.yaml, volume mounts.
K8s manifests simplified — no config file mounts, just env vars from
  ConfigMap (configMapKeyRef) and Secret (secretKeyRef).
271 tests passing.
2026-03-21 07:54:42 -07:00
yuqyang b5624a5123 chore: add --cleanup as alias for --teardown in deploy.py 2026-03-21 07:41:47 -07:00
yuqyang c36ac5afd9 refactor: deploy.py replaces deploy.sh, remove .env file
- deploy/config.yaml is the single config source (k8s, controller, serve sections)
- AGL_KEY is env var only — never on disk, no .env file
- deploy.py (Python): reads YAML, flattens k8s + controller sections into
  ConfigMap literal keys, includes full YAML as file key for volume mount
- Removed deploy/.env.example and scripts/deploy.sh
- Smoke tested: deploy + teardown both work on minikube
- 271 tests passing
2026-03-21 07:34:14 -07:00
yuqyang 7795f6c38b fix: config.yaml stays YAML, deploy.sh replaces deploy.py
- config.example.yaml: proper YAML (not flat env vars)
- deploy.sh: --from-file for YAML + --from-literal for extracted values
  (AGL_LITE_URL, AGL_SECRET_NAME parsed from YAML, AGL_K8S_NAMESPACE from .env)
- AGL_K8S_NAMESPACE lives only in .env — single source of truth
- deploy.sh supports --teardown flag
- Smoke tested: deploy + teardown both work on minikube
2026-03-21 06:59:27 -07:00
yuqyang ca8ab4cae3 feat: Phase 4a.3 — deploy structure, Dockerfile, K8s manifests, build script
deploy/agl-lite/:
- Dockerfile (python:3.12-slim + uv + pip install .[controller])
- k8s.yaml (Deployment + Service, env from Secret, config from ConfigMap)

deploy/controller/:
- k8s.yaml (reuses agl-lite:dev image, different command)
- rbac.yaml (ServiceAccount + Role + RoleBinding)

deploy/:
- .env.example (AGL_KEY + AGL_K8S_NAMESPACE)
- config.example.yaml (AGL_LITE_URL, controller settings)
- README.md (manual deploy instructions)

scripts/build_images.sh — unified image builder (minikube image build)
.dockerignore — excludes .venv, .git, tests, docs, dev, examples, etc.

Smoke tested: deployed to minikube, both pods Running,
healthz OK, agl-client queries working via port-forward.

271 tests passing.
2026-03-21 06:39:57 -07:00
yuqyang 05f350747e feat: agl-client CLI — separate entrypoint for API consumers
agl_lite/client_cli.py:
- Typer app with subcommand groups: rollouts, events, models, resources, health
- rollouts: list (with status/id filters), get, cancel
- events: list (by rollout_id, optional attempt_id/event_type filters)
- models: list, register, delete, delete-all
- resources: get, latest, add (JSON string or @filepath)
- health: check /healthz endpoint
- Reads AGL_LITE_URL and AGL_KEY from env vars
- JSON output for all queries (pipe-friendly)

pyproject.toml: agl-client = agl_lite.client_cli:app

tests/test_client_cli.py:
- 7 integration tests against real FastAPI server (subprocess)
- Tests: health, models CRUD, resources add+latest, rollouts list, events validation

271 tests total (264 + 7 new). All passing.
2026-03-21 06:36:01 -07:00
yuqyang fa450dce8e docs: rename client CLI to separate entrypoint agl-client
agl-lite = infra operator (serve, controller)
agl-client = API consumer (rollouts, events, models, resources)
2026-03-21 06:32:55 -07:00
yuqyang 372eb1de6b docs: update architecture + todo for list-based gateway routes with wildcards
- Architecture doc: added wildcard rules (model_in: *, model_out: *),
  priority ordering note, updated frozen decisions
- Todo: updated Gateway config frozen decision to reflect list-based format
2026-03-21 06:28:54 -07:00
yuqyang c49a999782 refactor: gateway config — list-based routes with wildcard support
Breaking change to gateway YAML format:
  Old: dict-based {model_in: {model: model_out, params: ...}}
  New: list-based [{model_in: ..., model_out: ..., params: ...}]

New features:
- Priority ordering: first match wins (list order)
- Wildcard model_in: '*' matches any unmatched model
- Wildcard model_out: '*' means passthrough (keep original name)
- Combines: '*' → '*' with params = global param adjustment

Files changed:
- agl_lite/gateway/config.py — RouteConfig gains model_in, GatewayConfig.routes is list
- agl_lite/gateway/router.py — resolve() iterates list, checks exact then wildcard
- agl_lite/server/app.py — log num_routes instead of route keys
- tests/gateway/test_config.py — rewritten for new format + wildcard tests
- tests/gateway/test_router.py — added wildcard resolve tests
- tests/gateway/test_proxy.py — updated YAML fixture

264 tests passing.
2026-03-21 06:16:47 -07:00
yuqyang 0b6985d1b0 docs: dataset design — embed answers in prompt, echo mode + real reward parsing
No mockai modification needed. Algorithm embeds correct/wrong answers
in prompt, mockai echoes back, reward function extracts and compares.
Mix of reward 1.0/0.0, fully verifiable end-to-end.
2026-03-21 05:48:40 -07:00
yuqyang 11cd7928e6 docs: Phase 4a — all-in-K8s topology, Python deploy scripts
Decisions #17-18:
- All-in-K8s for Phase 4a (serve, controller, mockai in cluster)
- Only algorithm script on host via port-forward
- Python for orchestration (deploy.py, run.py), bash for image builds
- Scripts in scripts/, invoked from repo root
2026-03-21 05:16:38 -07:00
yuqyang 9e0d9f168d update installing manual 2026-03-21 05:06:11 -07:00
yuqyang 7563176679 docs: split config into .env (secrets+bootstrap) and config.yaml (structured)
.env: AGL_KEY + AGL_K8S_NAMESPACE (bootstrap, used by setup script)
config.yaml: serve host/port, agl_lite_url, controller settings (mounted as ConfigMap volume)
CLI gets --config flag. Precedence: config file → env vars → CLI args.
2026-03-21 03:22:05 -07:00
yuqyang 630a7d6b2a docs: resolve namespace (option C) and secret handling (.env → K8s, no disk)
Decision #14 updated: AGL_KEY via --from-literal (never on disk),
  ConfigMap via pipe to --from-env-file=/dev/stdin.
Decision #16 added: manifests omit namespace, setup applies with -n.
2026-03-21 02:55:04 -07:00
yuqyang ba6cc3ad64 docs: Phase 4a — .env → ConfigMap/Secret pattern, no deploy/common/
Decisions added:
- #14: .env.example as single config source. Setup script creates K8s
  Secret (AGL_KEY) + ConfigMap (AGL_LITE_URL, etc.) from .env.
  Manifests use valueFrom — no hardcoded values.
- #15: Dockerfile uses uv for installs. .dockerignore excludes
  .venv, .git, tests, docs, dev, examples, node_modules, tmp, .local.
- Removed deploy/common/ — setup script handles namespace + secret + configmap.
- Removed gateway-config.yaml from deploy (passthrough for PoC, discuss later).
2026-03-21 02:47:49 -07:00
yuqyang 3ce443d865 refactor: organize tests by environment — unit vs e2e/cpu vs e2e/gpu
- Move kr8s adapter tests to tests/e2e/cpu/
- Default pytest run excludes e2e (--ignore=tests/e2e)
- Explicit: uv run pytest tests/e2e/cpu -v  (needs K8s cluster)
- Future:   uv run pytest tests/e2e/gpu -v  (needs K8s + GPU)
- No distinction between minikube/real K8s — split by capability required

Test categories:
  tests/         — 254 unit tests, all mocked, ~5s, every commit
  tests/e2e/cpu/ — 9 integration tests, needs K8s cluster, ~30s
  tests/e2e/gpu/ — placeholder for Phase 4b (needs GPU + vLLM)
2026-03-20 21:47:53 -07:00
yuqyang 472cf4ce2c feat: Kr8s adapter — real K8s client implementing K8sClient protocol
agl_lite/controller/kr8s_adapter.py:
- Kr8sClient wrapping kr8s async API (create/delete/get/list jobs+pods, watch)
- Kr8sJobWatcher async iterator yielding (event_type, raw_dict) tuples
- Idempotent delete (ignores NotFoundError)
- Lazy API init (connects on first use)

tests/controller/test_kr8s_adapter.py:
- 9 integration tests against real minikube (agl-test namespace)
- Tests: create+get, not-found, delete, idempotent delete, list jobs,
  list pods, watch events, job complete, job fail

263 tests total (254 existing + 9 new). All passing.
2026-03-20 21:44:20 -07:00
yuqyang 7efbda7dfa docs: Phase 4a — GSM8K dataset, unified build script, agent image convention, ordering discussion
Decisions added:
- #11: GSM8K 30-problem subset for math-poc dataset
- #12: Image = environment, config.command = task selector
- #13: Dockerfile.agent build context = examples/
- #5 updated: unified scripts/build_images.sh (bash, minikube)
- 4a.6 updated: build_images.sh + .dockerignore
2026-03-20 21:36:57 -07:00
yuqyang bf793c7ae0 docs: move agent Dockerfile to PoC (examples/math-poc/Dockerfile.agent)
Agent source in examples/agents/python/ is pure code — reusable templates.
Each PoC owns its Dockerfile since it may include data, tools, extra deps.
2026-03-20 21:18:31 -07:00
yuqyang 56eb814780 docs: agents + mockai stay in examples/, deploy/ is infra only
- deploy/ = agl-lite service, controller, common K8s resources
- examples/agents/python/ = agent source + Dockerfile (task-specific)
- examples/math-poc/ = full PoC scenario (mock_rl_loop + k8s-mockai + run.sh)
- scripts/ = shared infra setup/teardown, PoC orchestration in its own run.sh
2026-03-20 21:16:04 -07:00
yuqyang 43112c6535 docs: Phase 4a — per-module deploy layout, mock RL loop, algorithm stays Python
Decisions added:
- deploy/ organized by module (agl-lite, controller, mockai, agents, common)
- Algorithm script in Python on host (no Docker), uses AglLiteClient
- Mock RL loop: 2 iterations with weight update (deregister → 503 → re-register v2)
- Controller reuses agl-lite image (no separate Dockerfile)
- Version tracking verified in events across iterations
2026-03-20 21:06:54 -07:00
yuqyang 72d71712ad docs: condense completed phases 0-3 in todo.md to brief summary 2026-03-20 20:36:00 -07:00
yuqyang fc97f79f5d docs: update Phase 4a — decisions table, detailed task breakdown
Decisions: use mockai (~/mockai), client CLI, examples/ folder structure,
minikube image build, namespace nuke-and-recreate, separate deployments.

Tasks: kr8s adapter, client CLI, mockai deployment, example agents
(qa_agent + react_agent), algorithm script, K8s manifests, E2E tests.
2026-03-20 20:33:36 -07:00
yuqyang d2a0b57705 docs: split Phase 4 into 4a (mock, CPU) and 4b (real vLLM, GPU)
Phase 4a: E2E validation with mock OpenAI server inside minikube.
  - Mock server (configurable: normal, 503, crash)
  - Example agent + algorithm script
  - Minikube setup + kr8s adapter
  - Full lifecycle tests (batch rollouts, cancel, retry, weight update)

Phase 4b: E2E with real vLLM on 4x A6000 GPUs.
  - vLLM deployment, real inference, weight update protocol
  - Performance baseline (gateway overhead)
  - Prerequisite for Phase 5 (VERL integration)
2026-03-20 20:00:30 -07:00
Yuqing Yang 80f7014b54 add install minikube script 2026-03-20 11:11:44 +00:00
Yuqing 6711ac0cb0 add a minikube install for testing and user experience 2026-03-20 16:10:29 +08:00
Yuqing a4d03e7f65 refactor: single AGL_KEY in Secret for all auth env vars
K8s Secret stores only AGL_KEY. Job builder references it for all three:
  AGL_KEY → AGL_KEY (event posts, direct API)
  OPENAI_API_KEY → AGL_KEY (OpenAI SDK sends as Authorization: Bearer)
  ANTHROPIC_API_KEY → AGL_KEY (Anthropic SDK sends as x-api-key)

One secret, one value, three env vars. Gateway accepts both header formats.
2026-03-20 15:23:21 +08:00
Yuqing 697f4abebd fix: inject AGL_KEY into agent pods for gateway auth
Without AGL_KEY, agent event posts and LLM proxy requests get 401'd.
Sourced from same K8s Secret as OPENAI_API_KEY/ANTHROPIC_API_KEY.
2026-03-20 15:13:32 +08:00
Yuqing bbb230b35b docs: Phase 3 marked complete in todo.md (254 tests) 2026-03-20 14:58:01 +08:00
Yuqing 2dde63e6a6 feat: Phase 3 — Python client, K8s controller (job builder + reconciler + CLI)
Phase 3.0: AglLiteClient (agl_lite/client.py)
- Typed async HTTP client wrapping all agl-lite API endpoints
- Shared by controller and algorithm — no schema duplication
- 15 tests against real FastAPI app via httpx ASGITransport

Phase 3.1: ControllerSettings (agl_lite/controller/config.py)
- pydantic-settings with AGL_ env prefix
- namespace, poll_interval, max_queue_time, secret_name, etc.

Phase 3.2: Job spec builder (agl_lite/controller/job_builder.py)
- Pure function: (rollout, job_defaults, settings) → K8s Job manifest dict
- Env var injection: OPENAI_BASE_URL/KEY, ANTHROPIC_BASE_URL/KEY,
  AGL_TASK_INPUT, AGL_EVENT_URL, AGL_POD_UID (Downward API)
- timeout → activeDeadlineSeconds, max_retries → backoffLimit
- Mounts (hostPath, PVC, ConfigMap), overrides escape hatch
- 31 unit tests

Phase 3.3: Reconciler (agl_lite/controller/reconciler.py)
- K8sClient protocol for testability (mock in tests, kr8s in prod)
- Two concurrent loops: periodic_reconcile + watch_jobs
- Job creation failure → stay queuing, retry next cycle
- Max queue time → terminal_failed
- Crash recovery: orphaned running rollouts detected
- Cancel: queuing (no Job) and running (delete Job)
- Resources cache: persistent dict, no invalidation (immutable)
- 19 tests with fully mocked K8s + API clients

Phase 3.4: CLI (agl_lite/cli.py)
- agl-lite controller --agl-lite-url --namespace --secret-name
- Reads AGL_KEY from env, defers kr8s adapter to Phase 4

254 tests passing.
2026-03-20 14:57:34 +08:00
Yuqing 5ed39ef77d docs: update controller design + todo for Phase 3
- 1_k8s_controller.md: added failure handling (1.2), resources cache (1.3),
  module structure (2.1 client, 2.2 controller)
- todo.md: Phase 3 restructured into 3.0-3.5 (client, config, job builder,
  reconciler, CLI, tests)
2026-03-20 14:50:56 +08:00
Yuqing 02d489f682 docs: Phase 2 fully complete — all items checked off 2026-03-20 14:23:18 +08:00
Yuqing a36ccefeeb test: streaming proxy tests — SSE tee+buffer+capture verified
3 new tests:
- test_streaming_forward_and_capture: full flow (3 SSE chunks → tee to
  client → buffer → parse → model_request event with 3-item response list)
- test_streaming_route_rewrite: model_in → model_out works for stream=true
- test_streaming_empty_response: edge case (only [DONE], no data chunks)

189 tests passing.
2026-03-20 14:23:07 +08:00
Yuqing 37744274dc feat: warn when no gateway config loaded (passthrough mode) 2026-03-20 14:20:41 +08:00
Yuqing bf7b7df6ab docs: mark Phase 2 complete (except streaming test) 2026-03-20 14:17:09 +08:00
Yuqing 8b22b9152a feat: Phase 2.4-2.5 — gateway module (config, router, proxy)
Gateway module (agl_lite/gateway/):
- config.py: YAML route config (model_in → model_out + params.add/drop)
- router.py: GatewayRouter class — resolve route (exact match, passthrough),
  round-robin server selection, param adjustment (add/drop/rewrite model)
- proxy.py: HTTP forwarding via httpx (non-streaming + streaming with
  tee+buffer), model_request event capture (request + response + server meta)

Gateway routes wired in server/routes/gateway.py:
- LLM proxy: POST/GET /rollout/{rid}/attempt/{aid}/v1/{path}
- Event ingestion: POST /rollout/{rid}/attempt/{aid}/events

App lifespan creates GatewayRouter + shared httpx.AsyncClient.
Added pyyaml + pytest-httpx dependencies.
186 tests passing.
2026-03-20 14:16:46 +08:00
Yuqing 3ea8d246bc docs: sync todo.md — mark 2.1-2.3, 2.6 complete, update decisions 2026-03-20 14:00:30 +08:00
Yuqing 7f1de15c1b docs: clarify event routes — read-only API, writes via gateway 2026-03-20 13:59:17 +08:00
Yuqing 2b83bcaadd feat: warn when AGL_KEY not set (auth disabled) 2026-03-20 13:50:15 +08:00
Yuqing f7ffc45f4f refactor: batch store interface — enqueue_rollouts, register_models
Store owns batch semantics:
- enqueue_rollout → enqueue_rollouts(list[...]) → list[Rollout]
- register_model → register_models(list[...]) → list[ModelServer]
- Removed add_events (no batch event use case)

HTTP routes are now one-liners delegating to store.
156 tests passing.
2026-03-20 13:49:24 +08:00
Yuqing 3f4616aeb8 feat: Phase 2.1-2.3 — FastAPI app, auth, store API routes
Server layer:
- app.py: FastAPI lifespan, mounts all routes, wires store
- auth.py: AGL_KEY validation (Bearer + x-api-key), disabled when empty
- config.py: ServerSettings from env vars
- cli.py: 'agl-lite serve' entrypoint via typer + uvicorn

Store API routes (all async def, thin wrappers):
- rollouts: POST (batch), GET (query), GET/{rid} (detail+attempts), PATCH, POST/cancel
- events: GET with smart attempt resolution
- models: POST (batch register), GET (list), DELETE/{model}, DELETE (all)
- resources: POST, GET/latest, GET/{id}
- archive: POST /rollouts/archive

Gateway routes (stub):
- POST /rollout/{rid}/attempt/{aid}/events — agent event ingestion (working)
- POST /rollout/{rid}/attempt/{aid}/v1/{path} — LLM proxy (501 placeholder)

157 tests passing (124 store/schema + 33 server).
2026-03-20 11:56:33 +08:00
Yuqing dd4495a62d chore: mark #11 streaming deferred to impl 2026-03-20 11:52:41 +08:00
Yuqing ab3d6f5d8c docs: gateway as peer module to store, update project layout and todo
Gateway logic extracted to agl_lite/gateway/ (config, router, proxy)
peering with agl_lite/store/. Server is thin HTTP wrapper over both.

- dev_guidelines.md: updated project layout, removed ForbiddenError
- todo.md: Phase 2 tasks restructured (2.4 gateway module, 2.5 gateway
  routes, 2.7 integration tests), resolved open question #10
- Event ingestion: gateway-side POST /rollout/{rid}/attempt/{aid}/events
2026-03-20 11:51:03 +08:00
Yuqing 2d31b235d6 docs: model routing redesign — model_in→model_out, per-route params, online RL
Architecture doc updated:
- Gateway routing: model_in → model_out mapping via static YAML config
- Parameter adjustment is per-route (add/drop fields)
- model_request event includes server metadata (model, endpoint, version)
- Weight update protocol covers sync RL and online RL (rolling update)
- Store interface updated to new model methods

todo.md: resolved open questions #9 (gateway config) and #12b (batch-only APIs).
124 tests passing.
2026-03-20 11:16:43 +08:00
Yuqing 28699ca231 redesign model server: model as grouping key, nested store, batch-only API
ModelServer gets 'model' field — grouping key for gateway routing.
Store: Dict[model, Dict[endpoint, ModelServer]] (nested dict).
API body: flat list of {model, endpoint, version, token?} (easy validation).

New store methods:
- register_model(model, endpoint, version, token) — upsert by (model, endpoint)
- get_model_pool(model) — all servers for a model
- remove_model_servers(model, endpoints?) — remove specific or all
- remove_all_models() — clear everything

Supports online RL rolling updates: individual servers can have
different versions within the same model pool.

DELETE /api/models/{model} accepts optional body with endpoints list.
Empty pool auto-deleted.

Also:
- EnqueueBatchRequest simplified (no shared config — client-side sugar)
- RegisterModelRequest gets 'model' field
- Added DeleteModelServersRequest schema
- 124 tests passing
2026-03-20 11:14:53 +08:00
Yuqing aef7277702 simplify auth: single AGL_KEY, add optional token on ModelServer
MVP auth: one shared key (AGL_KEY) for all components. No roles,
no path-based permissions. 401 if key doesn't match, pass if it does.

ModelServer gets optional 'token' field — gateway forwards it as
Authorization: Bearer when proxying to model servers that need auth.
Unauthenticated model servers (cluster-internal vLLM) leave it null.

Updated: architecture doc, get_started.md, todo.md frozen decisions.
2026-03-19 23:52:58 +08:00
Yuqing 90e3004919 chore: todo.md — Phase 2 decisions and open questions tables 2026-03-19 23:39:23 +08:00
Yuqing bc7db177b5 chore: sync todo.md — update test counts, remove stale optimistic locking refs 2026-03-19 23:22:55 +08:00
Yuqing 95d2bc188f refactor: PATCH semantics for update_rollout — drop expected_version
UpdateRolloutRequest → PatchRolloutRequest:
- All fields optional (true partial update)
- Uses model_dump(exclude_unset=True) to apply only sent fields
- Absent field = untouched, explicit null = clear field
- No expected_version — no GET-before-PATCH round trip needed

Controller can now just send:
  PATCH /api/rollouts/{rid} {"status": "succeeded", "succeeded_attempt_id": "pod-uid"}

State transition validation still enforced server-side.
Version field kept on Rollout (informational, bumped internally).

Updated architecture doc, controller pseudocode, todo.md.
New tests: empty_patch_is_noop, update_without_status, explicit_null_clears_field.
114 tests passing, ruff clean.
2026-03-19 23:21:44 +08:00
Yuqing 894e17b58f chore: clean up todo.md — mark Phase 0+1 completed, remove done items 2026-03-19 22:47:13 +08:00
Yuqing 1429ebec36 refactor: store methods accept request objects, not decomposed args
enqueue_rollout(req: EnqueueRolloutRequest) instead of (input, config, resources_id)
update_rollout(rollout_id, req: UpdateRolloutRequest) instead of (rollout_id, status, expected_version, ...)

Eliminates pointless field-by-field unpacking between HTTP layer and store.
Tests updated with _enqueue/_update helpers. 110 tests passing.
2026-03-19 22:20:16 +08:00
Yuqing 1d5ce35a1f refactor: drop model_id — use endpoint as natural key
ModelServer keyed by endpoint URL, not auto-generated UUID.
Algorithm registers/removes servers by the URL it already knows.

Changes:
- ModelServer schema: removed model_id field
- Store: models dict keyed by endpoint, upsert on re-register
- API: DELETE /api/models?endpoint=<url> replaces DELETE /api/models/{model_id}
- POST /api/models has upsert semantics (same endpoint → update version)
- Updated architecture doc, todo.md, tests
- New test: test_upsert_same_endpoint
- 109 tests passing, ruff clean
2026-03-19 22:07:15 +08:00
Yuqing e8ee4f19f7 feat: Phase 1 — In-Memory Store implementation
InMemoryStore (agl_lite/store/memory.py):
- All methods are plain def (synchronous) — no async, no locks
- Data: dict[rid, Rollout], dict[rid, dict[aid, list[Event]]],
  dict[res_id, ResourcesUpdate], dict[model_id, ModelServer]

Rollout operations:
- enqueue_rollout: creates in QUEUING with UUID
- update_rollout: state transition validation + optimistic locking
- cancel_rollout: sets cancel_requested flag, idempotent, rejects terminal
- query_rollouts: filter by ids, status_in, cancel_requested, pagination
- get_rollout, rollout_exists: lookup helpers

Event operations:
- add_event/add_events: append to nested dict (rid → aid → list)
- query_events: smart attempt_id resolution (succeeded → latest → empty)
- list_attempts: attempt IDs ordered by first event timestamp

Resource operations:
- add_resources: immutable snapshots with JobDefaults validation
- get_resources, get_latest_resources

Model server operations:
- register_model/register_models, list_models, remove_model, remove_all_models

Archive:
- archive_rollouts: validate terminal, write JSONL (append), purge from store
- JSONL format: one line per rollout with events + resources

Tests: 108 passing (36 schema + 72 store), ruff clean.
2026-03-19 21:48:41 +08:00
Yuqing dfb7a6691a docs: restore kr8s async, clarify sync scope is in-memory store only 2026-03-19 21:36:23 +08:00
Yuqing 358f6af60e docs: add concurrency model to dev_guidelines.md
- Store methods are plain def (sync) — no async, no I/O
- Route handlers must be async def — never sync def (thread pool breaks safety)
- Single worker, single event loop, plain dict/list with no locks
- Document why this works for performance (I/O-bound hot path)
- Update kr8s description, testing section for sync store
2026-03-19 21:24:51 +08:00
Yuqing 0b47b57a73 docs: mark Phase 0 completed items in todo.md 2026-03-19 20:47:23 +08:00
Yuqing eed4853804 docs: sync architecture, controller, and todo with schema changes
- Remove event_id from Event schema in architecture doc (events
  identified by position, not ID)
- Remove standalone GET /api/attempts/{rid} endpoint — fold attempt
  listing into GET /api/rollouts/{rid} response
- Update Store API: list_attempts returns List[str] from nested dict
- Document nested dict storage: rid → aid → list[Event]
- Add overrides escape hatch to JobDefaults description and merge diagram
- Update todo.md: event storage is per-(rid, aid), no event_id,
  JobDefaults has overrides field
- Fix 1_k8s_controller.md: reference rollouts endpoint for attempt lookup
- Update endpoint count from ~19 to ~18
2026-03-19 20:17:59 +08:00
Yuqing 191c3459c3 refactor: schema refinements from review
(a) Removed event_id from Event — events identified by position in
    ordered list, not by separate ID. No API references events by ID.
(b) JobDefaults: extra='forbid' → added 'overrides: dict' escape hatch.
    Known fields validated, unknown K8s fields (labels, annotations,
    dnsPolicy, etc.) go into overrides and are merged raw by controller.
(c) Removed AttemptInfo — the /api/attempts endpoint is a debugging
    convenience, not needed for MVP. Smart attempt_id resolution
    handles the common case.
2026-03-19 20:07:15 +08:00
Yuqing 808694991f feat: Phase 0 — project skeleton and frozen schemas
Project setup:
- pyproject.toml (uv, hatchling, fastapi, pydantic v2, httpx, etc.)
- Package layout: agl_lite/{schemas,store,server,controller}
- Dev tooling: ruff, pyright, pytest-asyncio
- uv.lock committed for reproducibility

Frozen schemas (agl_lite/schemas/):
- rollout.py: Rollout, RolloutStatus, RolloutConfig, Mount,
  VALID_TRANSITIONS, TERMINAL_STATUSES
- event.py: Event, ModelRequestData, RewardData, AttemptInfo
- resources.py: ResourcesUpdate, JobDefaults (extra=forbid),
  K8sResources — validates job_defaults at POST time
- model_server.py: ModelServer
- errors.py: NotFoundError, ConflictError, InvalidTransitionError
- api.py: all request/response body models

Tests: 36 passing, ruff clean, all schemas validated.
2026-03-19 20:01:48 +08:00
Yuqing dfc8a1346b docs: add dev guidelines, rename refactor/ → design/
- docs/dev_guidelines.md: tooling (uv, ruff, pyright, pytest, structlog),
  project layout, code conventions, git conventions, testing strategy
- docs/refactor/ → docs/design/ — these are design docs, not refactoring notes
- Updated all cross-references in dev/issues/README.md and dev/todo.md
2026-03-19 19:55:11 +08:00
Yuqing 9622589746 docs: multi-SDK support — OpenAI + Anthropic env vars and auth
Gateway proxies both /v1/chat/completions (OpenAI) and /v1/messages
(Anthropic/Claude). Controller injects both SDK env var pairs:
- OPENAI_BASE_URL + OPENAI_API_KEY (Authorization: Bearer)
- ANTHROPIC_BASE_URL + ANTHROPIC_API_KEY (x-api-key header)

Both point to same gateway URL, same agent key. Gateway auth
checks both header formats. Agent uses whichever SDK it wants —
zero modification needed.
2026-03-19 17:06:59 +08:00
Yuqing dcf3c7c9d0 docs: clarify archive append semantics and secret injection mechanism
(a) Archive: user-specified .jsonl path, append if exists, create if not.
    Multiple archive calls build one growing file per training run.
(b) Agent auth: OPENAI_API_KEY (env var name) + secretKeyRef (injection
    mechanism) — same thing, not conflicting. Controller only writes
    the reference, K8s resolves the actual value at pod creation.
2026-03-19 17:00:28 +08:00
Yuqing ae6e2f3672 docs: rewrite implementation plan (aligned with final architecture)
Replaces the stale phase-based TODO with implementation-ready plan:
- Phase 0: Schemas + project skeleton (freeze contracts)
- Phase 1: In-memory store (all operations, tested without HTTP)
- Phase 2: HTTP API + gateway + auth (agl-lite serve)
- Phase 3: K8s controller (reconcile, Job rendering)
- Phase 4: E2E validation on minikube
- Phase 5: VERL integration
- Phase 6: Polish

Includes pre-implementation decisions table (frozen, not revisitable).
Key decisions: typed JobDefaults, secretKeyRef injection, JSONL archive,
round-robin routing, single namespace, activeDeadlineSeconds for timeout.
2026-03-19 16:50:49 +08:00
Yuqing 0cedac72d7 docs: agent contract is 4 env vars, algorithm key always used
- Agent contract: OPENAI_BASE_URL, OPENAI_API_KEY, AGL_TASK_INPUT,
  AGL_EVENT_URL (was 3, now 4 with auth key)
- Algorithm key: always used by algorithm for auth. Optionally stored
  in K8s Secret — algorithm may run outside cluster and get key from
  its own config.
- Added Authorization headers to all algorithm Python examples in
  get_started.md
2026-03-19 14:50:22 +08:00
Yuqing 9d42a6b8b0 docs: add getting started guide (setup flow, 7 steps)
Steps 1-4: one-time infra (K8s, RBAC, Secrets, agl-lite, controller)
Steps 5-7: per-experiment (resources, model servers, rollouts)

Includes YAML manifests, Python examples, and what-happens-next flow.
Algorithm key omitted for MVP — trusted network assumption.
2026-03-19 14:47:48 +08:00
Yuqing a748ed74ba docs: API key authentication and role-based access
Resolves issue 011 (cross-boundary auth and transport security).

MVP: 3 API keys (agent, controller, algorithm) in K8s Secret.
- Agent key via OPENAI_API_KEY env var — OpenAI SDKs send it as
  Authorization header automatically. Zero agent modification.
- Controller key for rollout status updates.
- Algorithm key for full access.

Role-based access enforced per endpoint. agl-lite Service has zero
K8s dependency — pure HTTP server, keys from Secret mount or env vars.
Only the K8s Controller needs K8s API access (Jobs, Secrets, ConfigMaps).

Production path: per-rollout JWTs, mTLS, TLS at ingress.
2026-03-19 14:40:11 +08:00
Yuqing d1a1864a90 docs: fix stale link for issue 010 2026-03-19 14:33:21 +08:00
Yuqing 93cdde60d7 docs: validate rollout_id on hot path, implies in-process store
Reversed the 'no validation' decision from issue 009. With in-process
store, rollout_id validation is a dict lookup (~100ns) — free compared
to LLM inference (seconds). Benefits:
- 404 rejects orphan requests early (no wasted GPU inference)
- 404 rejects orphan events early (no garbage in store)
- Zero cost: synchronous, no await, no race conditions

This reinforces the unified service design: gateway + store must be
in the same process for the validation to be free. A separate store
would turn a 100ns dict lookup into a 1-50ms network round-trip.
2026-03-19 14:30:21 +08:00
Yuqing 83c053794a docs: no validation on event ingestion (hot path fast)
Resolves issue 009. Event writes are fire-and-forget — no rollout_id
or attempt_id existence check. Orphan events are harmless (never
queried) and cleaned by archive or periodic GC.
2026-03-19 14:24:16 +08:00
Yuqing ddaa7f8d9a docs: fix naming to resources_id (matches original Agent Lightning) 2026-03-19 14:20:43 +08:00
Yuqing 4900f4b924 docs: revert to singular resource_id (one snapshot bundles all)
Original Agent Lightning uses NamedResources = Dict[str, Resource] —
one snapshot packs everything (LLMs, prompts, config) into a single
bundle with one ID. Our resource_ids: List[str] was over-engineered.

Back to: resource_id: Optional[str] — one snapshot containing
job_defaults + prompts + eval config + whatever else. Simple,
matches the original pattern.
2026-03-19 14:19:19 +08:00
Yuqing 94f01bd6ab docs: fix resource caching description — deduplication, not caching
Resources are immutable snapshots with unique IDs. Controller
deduplicates fetches within a reconcile cycle (batch shares same
resource_ids → each fetched once). No invalidation needed — IDs
are immutable. New job defaults = new snapshot = new ID.
2026-03-19 14:17:08 +08:00
Yuqing 8b47960b14 docs: rollout config refinements (a-d)
(a) resources_id → resource_ids: List[str] — rollout can depend on
    multiple resource snapshots (job_defaults, prompts, eval config)
(b) job_defaults is a reserved resource key — documented in a table.
    All other keys are user-defined and opaque to agl-lite.
(c) Removed 'mode' field from RolloutConfig — just use
    environment_variables: {MODE: 'train'} if the agent needs it
(d) env → environment_variables — avoids confusion with RL
    'environment' concept
2026-03-19 14:13:48 +08:00
Yuqing 73672f1bc2 docs: job defaults via Store resources (not config file)
Controller reads job_defaults from the rollout's resources_id snapshot,
not from a static config file. This means:
- No kubectl needed — algorithm/setup script POSTs to /api/resources
- Controller stays task-agnostic (no baked-in config)
- Immutable snapshots: same resources_id always returns same defaults
- Cache-friendly: entire batch shares one resources_id → one fetch
- Restored resources_id field on Rollout record

Workflow:
1. POST /api/resources {job_defaults: {resources, node_selector, ...}}
2. POST /api/rollouts {resources_id: ..., config: {image, command, ...}}
3. Controller merges: resources.job_defaults ← rollout.config → Job spec
2026-03-19 13:59:45 +08:00
Yuqing bdd92de828 docs: two-layer rollout config (infra defaults + algorithm overrides)
Resolves issue 007 (rollout config schema).

Algorithm-facing RolloutConfig (5 fields, no K8s knowledge needed):
- image, command, env, mount (describe the container)
- timeout, max_retries, mode (execution policy, optional)

Infra-level job_defaults.yaml (loaded by controller at startup):
- resources, node_selector, tolerations, service_account, etc.
- Set by DevOps, algorithm never sees these

Controller merges both layers into K8s Job spec.
Algorithm overrides take precedence where specified.

Batch enqueue supports shared config:
POST /api/rollouts {config: {...}, rollouts: [{input: ...}, ...]}

Also: removed resources_id from Rollout (resources endpoint is
separate; config.mount handles data dependencies).
2026-03-19 13:39:52 +08:00
Yuqing e1bbe5e3ba docs: task input delivery via AGL_TASK_INPUT env var
Resolves issue 002 (task input delivery to agent).

Controller injects AGL_TASK_INPUT env var with JSON-serialized
rollout.input into the Job template. Agent reads it like any env var.

Three env vars define the full agent contract:
- OPENAI_BASE_URL: LLM calls (changes per attempt, includes rid+aid)
- AGL_TASK_INPUT: task payload (same across retries)
- AGL_EVENT_URL: optional event posting (rewards, custom events)

Zero agent modification needed. Every language reads env vars.
Size limit ~1MB (K8s Pod spec / etcd). Fine for text prompts.
2026-03-19 11:53:25 +08:00
Yuqing d43d3b4b38 docs: mark case A (colocated) as MVP deployment, case B as future 2026-03-19 10:44:21 +08:00
Yuqing 62d401b7ad docs: bulk data transfer analysis, close batch query issue
Resolves issue 004 (batch trajectory query for training).

No batch endpoint needed:
- Concurrent GET /api/events via asyncio.gather() is fast enough
- One fewer endpoint to implement, test, document
- Partial failure handled naturally per-request

Data transfer analysis for two deployment cases:
- Colocated (case A): loopback, not a bottleneck even at 2.5GB.
  Shared memory unnecessary — breaks API boundary for marginal gain.
  Msgpack/protobuf available if serialization matters.
- Remote (case B): gzip (5-10x compression) + archive-to-shared-storage
  pattern. Archive feature serves dual purpose: data lifecycle + bulk
  export. No new API needed.
2026-03-19 10:43:19 +08:00
Yuqing 46c46356b0 docs: add method column to path layout table for bird-eye view
Also expanded to show /api/models/{model_id} and /api/resources/{id}
as separate rows for completeness. 12 path patterns, 19 method+path
combinations across 6 domains.
2026-03-19 10:30:28 +08:00
Yuqing 9a4326d7cb docs: algorithm-driven data lifecycle (archive and purge)
Resolves issue 008 (data retention and eviction).

POST /api/rollouts/archive:
- Algorithm decides when to drop consumed data (not the system)
- Critical path: query trajectories → train → archive batch
- Optional backend for persistence (JSONL for MVP, pluggable)
- No backend = just discard from hot store
- Rejects non-terminal rollouts (400)
- One JSONL line per rollout: {rollout, events} — self-contained

Replaces original's automatic byte-threshold eviction which risked
deleting unconsumed data. Explicit > implicit for data lifecycle.
2026-03-19 10:24:38 +08:00
Yuqing 7fbca400e5 docs: gateway parameter adjustment (add_params, drop_params)
Static config loaded at gateway startup, not changeable at runtime.
Normalizes requests for backends that don't support all OpenAI params
(vLLM, TGI) and enforces training-time sampling parameters.

Event records both original request and adjusted params diff,
so trajectory captures agent intent and actual model input.

Also added 'status' field to model_request event payload
(ok, client_disconnected, stream_error) for streaming edge cases.
2026-03-19 10:09:27 +08:00
Yuqing 1a5ef5c1dd docs: drop wait_for_rollouts, add batch ID support to GET /api/rollouts
wait_for_rollouts was server-side long-poll that just hid a polling loop.
Replaced by client-side polling with GET /api/rollouts?ids=r1,r2,r3.
Simpler: no asyncio.Condition per rollout, no connection timeout
handling, no notification machinery.

GET /api/rollouts now accepts 'ids' param for batch fetch.
POST /api/rollouts also supports batch (single object or array).
Endpoint count: 19 → 18.
2026-03-19 09:53:02 +08:00
Yuqing e0216ffec4 docs: drop explicit sequence field, add concurrency analysis
Event ordering:
- Removed 'sequence' field from Event schema. Ordering is an emergent
  property of the storage backend: list index (in-memory), ROWID
  (SQLite), SERIAL (PostgreSQL).
- Single-threaded asyncio event loop guarantees temporal insertion
  order. No locks needed on the hot path.
- API returns events in insertion order; consumers use array position.

Concurrency analysis (resolves issue 005):
- Hot path is I/O-bound (seconds waiting for LLM inference).
- Event store naturally partitioned by (rollout_id, attempt_id) —
  different agents never contend on the same data.
- No locks needed: model server registry is read-heavy/write-rare,
  event writes are per-partition, rollout updates use optimistic locking.
- Single Python async instance handles 5,000+ concurrent connections
  comfortably. Most RL setups use 64-512 agents.
- Bottleneck is LLM inference servers, never the gateway.
- Scaling path: stateless instances + DB-assigned ordering (future).

Also resolved issue 006 (concurrent calls note + adapter relabeling).
2026-03-19 00:07:53 +08:00
Yuqing b11caf61a6 docs: streaming proxy design and concurrent request semantics
Resolves issue 001 (streaming) and 006 (concurrent calls + adapter).

Streaming proxy (tee approach):
- Gateway tees SSE stream: chunks forwarded to agent immediately,
  buffered in memory for event capture
- Event written at stream completion with full assembled response
- Edge cases: client disconnect (capture continues), backend error
  (partial event with status field), memory bounded (~50MB for 100
  concurrent streams)
- Replaces original StreamConversionMiddleware which forced stream=false
  to backend (lost real streaming, was an OTEL workaround)

Concurrent request semantics:
- sequence assigned at event write time (stream completion)
- Concurrent requests get arbitrary sequence order — this is storage
  ordering, not causal ordering
- timestamp provides approximate causal information

Adapter relabeled as example (episode-level reward). Users implement
their own for per-step, discounted, advantage-based, etc.
2026-03-18 23:44:13 +08:00
Yuqing 1339372556 docs: batch model server registration, 503 always-on rationale
POST /api/models accepts single object or array for batch registration.
503 is always returned when no servers available — no on/off switch
needed. Sync RL never hits the window; async RL benefits from retry.
Aborting agents is what cancel_rollout is for.
2026-03-18 23:37:35 +08:00
Yuqing e3b3f650e0 docs: first-class model server management and async RL support
Resolves issue 003 (LLM backend routing and resource mapping).

Model server registry (/api/models):
- CRUD API for inference servers with version tracking (training step)
- ModelServer record: {model_id, endpoint, version, created_at}
- Gateway routes to registered servers; returns 503 when none available

Weight update protocol:
- DELETE /api/models → gateway returns 503 + Retry-After
- OpenAI SDKs auto-retry on 503 — agent pod stays alive, no K8s retry
- POST /api/models with new version → routing resumes
- Emergent from CRUD, no special 'update mode' API

Async RL support:
- model_version recorded per model_request event
- Enables importance sampling, off-policy correction, data filtering
- Turn-level async RL: single trajectory spans multiple policy versions

Also updated:
- model_request event payload (added model_version field)
- Resources narrowed to prompts/config (model endpoints in /api/models)
- Component description, path layout, comparison tables
2026-03-18 23:22:23 +08:00
Yuqing 790f122ee7 docs: fix line breaks in 1_k8s_controller.md, remove resolved issue file 2026-03-18 23:00:23 +08:00
Yuqing 2fb2fa96d2 docs: resolve issue 010 — find_succeeded_pod_uid
Created docs/refactor/1_k8s_controller.md for controller implementation
details. Pod UID resolved via label query in watch callback, GC race
mitigated by ttlSecondsAfterFinished.
2026-03-18 22:56:28 +08:00
Yuqing 56a8ff1114 docs: add issue 011 — cross-boundary authentication and transport security
Covers: TLS for cross-boundary traffic, role-based access (agent,
controller, algorithm), API key for MVP, scoped JWT tokens for
production, threat model by deployment scenario.
2026-03-18 20:06:50 +08:00
Yuqing c8e8a8acea docs: log 10 architecture review issues in dev/issues/
Critical review of 0_architecture.md from the perspective of a senior
system architect with RL system and LLM infrastructure expertise.

🔴 Architectural gaps:
  001 - Streaming LLM response handling (tee stream approach)
  002 - Task input delivery to agent (env var vs API fetch)
  003 - LLM backend routing and resource mapping
  004 - Batch trajectory query for training (N+1 problem)

🟡 Important design issues:
  005 - Gateway scaling and sequence counters
  006 - Concurrent LLM calls and adapter design
  007 - Rollout config schema
  008 - Data retention and eviction

🟢 Minor/deferrable:
  009 - Event ingestion validation
  010 - find_succeeded_pod_uid implementation

Each issue includes: problem statement, analysis of options,
recommendation, and list of doc sections to update.
2026-03-18 20:03:54 +08:00
Yuqing 087a8fdd65 docs: smart attempt_id default for event queries
GET /api/events attempt_id resolution when omitted:
1. succeeded_attempt_id if rollout succeeded
2. Most recently created attempt (MAX of MIN(timestamp) from events)
3. Empty result if no events exist

Attempts are derived from the events table via GROUP BY — no separate
attempt storage. list_attempts returns {attempt_id, first_seen,
last_seen, event_count} ordered by first_seen.
2026-03-18 19:41:23 +08:00
Yuqing c6137b73a1 docs: merge /api/trajectories into /api/events query params
Trajectory is just GET /api/events?rollout_id={rid}&attempt_id={aid}.
No need for a separate endpoint. Updated path layout, Store API
pseudocode, and comparison tables.
2026-03-18 19:26:46 +08:00
Yuqing 21c071bb7e docs: unify Gateway+Store into single service, add API comparison
Section 3.1/3.2: Gateway and Store merged into 'agl-lite Service' —
one HTTP endpoint, one deployment. Agent pods, K8s controller, and
Algorithm all talk to the same service URL.

Section 3.3: Updated env var examples to use AGL_LITE_URL as single
base, with OPENAI_BASE_URL and AGL_EVENT_URL derived from it.

Section 3.4 (rewritten as 'Unified API Spec'):
- Path layout table showing all ~15 endpoints
- LLM proxy paths: /rollout/{rid}/attempt/{aid}/v1/... and /events
- Store paths: /api/rollouts, /api/events, /api/trajectories,
  /api/attempts, /api/resources with full method/path/description tables

Section 3.5: Updated K8s resource table for unified service.

Section 4 (new): API Change Summary
- 4.1: Original Agent Lightning API surface (25+ methods, 6 domains,
  separate LLM Proxy with 5 middleware/exporters)
- 4.2: agl-lite API surface (~15 endpoints, 4 domains, one service)
- 4.3: What's removed and why (18 items with rationale)
- 4.4: What's new (7 items with rationale)
2026-03-18 17:52:52 +08:00
Yuqing 8ed4cd3c7a docs: comprehensive K8s controller design with cancel support
Section 3.3:
- Added Rollout record with RolloutStatus enum (queuing, running,
  succeeded, terminal_failed, cancelled)
- cancel_requested as separate flag (user intent) vs status (controller action)
- Full state machine diagram with valid transitions table
- Store-enforced invariants (final states, no backwards transitions)

Section 3.3 Store API:
- update_rollout with expected_version for optimistic locking
- cancel_rollout sets cancel_requested flag
- query_rollouts supports cancel_requested filter
- wait_for_rollouts with long-polling semantics
- Removed dequeue_rollout (controller polls Store directly)

Section 3.5 (rewritten as 'K8s Controller'):
- Deterministic Job naming (agl-rollout-{rollout_id}) for idempotency
- Job template with ttlSecondsAfterFinished for auto-cleanup
- Controller main loop: watch + poll + periodic full reconcile
- Full reconcile logic in Python pseudocode:
  - handle_cancel: checks Job Complete (success wins), Job Failed
    (mark cancelled), Job active (delete with Foreground propagation,
    wait for cleanup before marking cancelled)
  - handle_queuing: create Job, handle AlreadyExists, handle creation failure
  - handle_running: sync Job conditions to Store status
- All updates use optimistic locking with ConflictError retry
- Comprehensive edge cases: controller crash recovery, leader election
  race, Store unavailable, Job creation race, external Job deletion,
  cancel+success race, cancel+failure race, cancel during termination,
  node partition, stale queries, controller downtime
2026-03-18 17:42:47 +08:00
Yuqing 14c1f9d5a2 docs: event-based trajectory model — two reserved types, rest is open
Trajectory is now a sequence of Event objects. Only two event types have
well-known structure that agl-lite understands:
- model_request: auto-captured by Gateway (request + response + latency)
- reward: scalar value + optional message, reported by runner/environment

All other event types (tool_result, observation, action, custom, etc.)
are opaque dicts with a 'type' field — stored and delivered as-is.
Users define their own types and consume them in their own algorithms.

Updated sections: 2.1, 2.2, 3.3 (Event/Trajectory model, Store API),
3.4 (Gateway event endpoint), 3.5 (Job template with AGL_EVENT_URL),
3.6 (Adapter filters by event type).
2026-03-18 17:20:15 +08:00
Yuqing b9a2decc76 docs: design attempt_id from K8s pod UID, path-based gateway routing
Section 3.3:
- Added 'ID Generation and Flow' table (rollout_id from Store, attempt_id from K8s pod UID)
- K8s Job template showing Downward API + env var composition for OPENAI_BASE_URL
- 'Attempt as a data tag, not an entity' — explicit that attempt has no lifecycle in Store
- Retry data isolation example showing clean partitioning by pod UID
- Added list_attempts() to Store API
- Annotated RequestRecord/Trajectory with pod UID comments

Section 3.4:
- Replaced routing options with concrete request flow walkthrough
- Path-based routing is the chosen approach (not header-based)
- Gateway auto-increments sequence per (rollout_id, attempt_id)

Section 3.5:
- Added full Job template YAML example with Downward API
2026-03-18 17:03:48 +08:00
Yuqing d27508ca98 docs: agents are language-agnostic containers, remove Section 4
- Agent is no longer a Python base class; it's any LLM program that
  reads Gateway endpoint from env vars (OPENAI_BASE_URL, etc.)
- Can be written in any language/framework, packaged as container
- No SDK or base class required — only contract is HTTP API consumption
- Removed LitAgent from 'What Stays', added to 'What Gets Removed'
- Updated Gateway diagram to show 'Agent (any language)'
- Updated dev/todo.md Phase 3 accordingly
- Section 4 (Refactoring Phases) was already absent from arch doc
2026-03-18 16:22:27 +08:00
Yuqing 2abdac190d docs: clarify deployment flexibility — no co-location assumptions
- Compute Backend is a user-managed prerequisite (same cluster, separate
  cluster, or remote service)
- AGL-Lite (Store + Gateway) can be co-located with runner or compute
  backend; only needs to expose HTTP API
- Agent Runner only needs network access to Store + Gateway endpoints
- Updated architecture doc sections 3.1, 3.2, 3.5, Store API note
- Updated todo.md Phase 5 and Phase 1 descriptions
2026-03-18 16:03:38 +08:00
Yuqing 5e7221e736 docs: integrate excalidraw architecture diagram into 0_architecture.md
Replace ASCII art with reference to docs/images/lite_arch.excalidraw.svg
showing the three-column layout: Compute Backend (green), AGL-Lite (blue),
Agent Runner/K8s (red).
2026-03-18 15:39:56 +08:00
Yuqing bd565aaa90 docs: add architecture analysis and refactoring plan
- docs/refactor/0_architecture.md: comprehensive mapping of Agent Lightning
  architecture to agl-lite simplifications (core loop, data types, store,
  LLM proxy, execution strategies, VERL integration)
- dev/todo.md: phased refactoring plan (Phase 0-7) with task breakdown
- Covers all 4 key changes: replace litellm, remove OTEL, simplify
  trajectory format, adopt K8s runner
2026-03-18 14:34:13 +08:00
Yuqing 11bdda2b0d Initial commit 2026-03-18 13:23:01 +08:00
Leonardo Pinheiro c746af2f76 vercel ai webshop example (#440) 2026-02-11 22:20:42 +08:00
Imran Siddique 49bf9cd9ec [Contrib] Agent-OS Integration: Kernel-Level Safety for RL Training (#478)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-11 09:00:36 +08:00
Jeonghye Kim 9864b8fbff New example: AGL Simulation (#367) 2026-02-10 12:00:12 +08:00
Yuge Zhang 82d8535048 CI maintenance (Feb) (#479) 2026-02-09 15:59:02 +08:00
Dunura Saradha Witharama 5fa6582491 Validate input length in generate_id utility (#460) 2026-02-09 14:39:50 +08:00
Salman Chishti 3f36754d64 Upgrade GitHub Actions for Node 24 compatibility (#465)
Signed-off-by: Salman Muin Kayser Chishti <13schishti@gmail.com>
2026-01-27 15:16:38 +08:00
Barkhayot Juraev b0592efe1f [chore] fix minor typos (#457)
Co-authored-by: Barkhayot Juraev <barkhayotjuraev@Barkhayots-MacBook-Pro.local>
2026-01-27 14:57:37 +08:00
Yuge Zhang 5f3093d62a Pipeline maintainence (#451) 2026-01-19 12:10:23 +08:00
荔枝 bfb94a8750 Make APO templates configurable via constructor arguments (#443) 2026-01-12 16:20:40 +08:00
Yuge Zhang 25eda47a29 Fix broken links in changelog (#433) 2025-12-24 19:13:34 +08:00
Yuge Zhang a214474402 Bump to 0.3.1 (#431) 2025-12-24 11:45:50 +08:00
Yuge Zhang 3b5d733861 [Release] v0.3.0 (#427)
Deploy Documentation / deploy (push) Has been cancelled
PyPI Release / check-version (push) Has been cancelled
PyPI Release / publish-pypi (push) Has been cancelled
2025-12-24 09:46:58 +08:00
Yuge Zhang 158f5df28e Fix documentation and dashboard building issues (#429) 2025-12-23 23:55:59 +08:00
Yuge Zhang 40dc59205b Scale out benchmark parameters (#428) 2025-12-23 23:32:19 +08:00
Yuge Zhang c1a43b6c3a Update parallelization guides (#426) 2025-12-23 14:57:24 +08:00
Jiahang Xu 4235731a0d Feat: Add trace_aggregator to support both transition and trajectory aggregation (#134) 2025-12-22 11:12:21 +08:00
Yuge Zhang 22b80b38bf v0.3 Documentation Update (#422) 2025-12-18 01:12:50 +08:00
Yuge Zhang 9f178accaf Minor optimizations to store benchmark (#421) 2025-12-18 00:10:22 +08:00
Yuge Zhang 68a47d5087 Make weave import optional (#423) 2025-12-17 20:31:48 +08:00
Yuge Zhang 4b36b25aad Fix Weave get username (#420) 2025-12-17 13:00:24 +08:00
Wang Zilong a13e09fc6c add youtu agent blog link in community projects (#416) 2025-12-17 09:00:04 +08:00
Yuge Zhang e63c340ebd Benchmark minor improvements (#418) 2025-12-17 02:14:32 +08:00
Yuge Zhang e62b7ca252 Support Weave tracer in TracerTraceToTriplet (#415) 2025-12-17 00:15:31 +08:00
Jiahang Xu f66d87745f Adapt the Search R1 Example to AGL v0.2 (#412)
Co-authored-by: SiyunZhao <siyunzhao@microsoft.com>
2025-12-16 23:32:20 +08:00
Jiahang Xu 52090e9dd5 Update benchmark results to Search-R1 v0.1 (#417) 2025-12-16 23:28:10 +08:00
Yuge Zhang fdaf3f1777 Fix unsloth config issue (#414) 2025-12-16 10:41:42 +08:00
Yuge Zhang 087c7d350a Reimplement Weave tracer and unify emitter interface (#411) 2025-12-15 15:20:59 +08:00
Yuge Zhang 2203070ef0 Misc CI fixes and Move Search-R1 to contrib (#410) 2025-12-13 15:12:23 +08:00
jinghuan-Chen a6078caa6c fix TraceTree/match_rewards assign_to elements. (#403) 2025-12-13 00:25:54 +08:00
Yuge Zhang f1a8072546 Add ChartQA to catalog (#409) 2025-12-12 23:39:41 +08:00
Totoluo 60f9955606 Multi-modal example: ChartQA (#379)
Co-authored-by: Totoluo <52833580+Yingluo-momo@users.noreply.github.com>
Co-authored-by: Yuge Zhang <scottyugochang@gmail.com>
2025-12-12 17:22:35 +08:00
Yuge Zhang 1d199b21c7 Support customizing trainer and daemon in VERL (#407) 2025-12-12 13:31:30 +08:00
Yuge Zhang 5f62ecb6f4 Split vllm 0.10.2 from 0.11.0 (#394) 2025-12-12 12:10:53 +08:00
Yuge Zhang 1948c2ba6d Sunset HTTP tracer and Refactor tests (#402) 2025-12-11 23:57:23 +08:00
Yuge Zhang 1e36e660b1 Support with_llm_proxy and with_store in algorithms (#398) 2025-12-11 16:50:42 +08:00
Yuge Zhang 267b9936bb Support image urls export in TracerTraceToTriplets (#400) 2025-12-11 16:47:28 +08:00
Wang Zilong 14714ded2b add youtu-agent in community projects (#399) 2025-12-11 15:40:49 +08:00
Yuge Zhang c3f5cc7a39 Initialize contribution area (#396) 2025-12-10 23:46:06 +08:00
Yuge Zhang ee0fffd3a2 Upgrade tinker dependency (#393) 2025-12-10 23:23:43 +08:00
Yuge Zhang 94d1cd780e Store Benchmark - Part 6 (#388) 2025-12-10 21:11:29 +08:00
Vasu bbd5c2a30a fix: handle ref_in_actor flag for LoRA compatibility with verl 0.6.0 (#386) 2025-12-10 18:30:38 +08:00
Yuge Zhang c6f4e6c283 Add playground workflow (#391) 2025-12-10 18:27:21 +08:00
Ni Hao 8c504518bb add weave tracer (#277) 2025-12-09 18:59:11 +08:00
etsplz 337cce7fdc Fix redundant cancel tracebacks on ctrl+c (issue #343) (#370) 2025-12-08 17:18:07 +08:00
Yuge Zhang 42c63d7a01 Store Benchmark - Part 5 (#380) 2025-12-08 12:43:18 +08:00
Yuge Zhang 5ecd23792d Fix trainer dev warning (#378) 2025-12-08 00:43:56 +08:00
Yuge Zhang ad89e173e1 Fix TracesTable story (#375) 2025-12-06 14:25:09 +08:00
Yuge Zhang feebaec24c Add AGENTS.md (#374) 2025-12-06 13:16:26 +08:00
Copilot 4adf4e3ea4 Fix sequence ID sorting in traces table (#371)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: ultmaster <8463288+ultmaster@users.noreply.github.com>
2025-12-06 12:31:42 +08:00
Yuge Zhang 0294eb5d32 GitHub Actions for RAG example (#357) 2025-12-06 12:04:42 +08:00
Leonardo Pinheiro f9fe772e10 Update langchain to 1.x (#364) 2025-12-05 21:35:39 +08:00
Yuge Zhang 9f8a25ffdc Store Benchmark - Part 4 (#356) 2025-12-05 12:00:11 +08:00
Yuge Zhang 3082ac0ee0 Centralized metrics helper (#368) 2025-12-05 08:47:10 +08:00
Yuge Zhang 56e5c7ce62 Operation emitter (#359) 2025-12-04 15:16:29 +08:00
Yuge Zhang 21892cc6d3 Skip vllm 0.12.0 (#361) 2025-12-04 14:21:23 +08:00
Wang Zilong 34811cb454 Update RAG example to v0.2.x (#349) 2025-12-03 15:46:57 +08:00
Yuge Zhang 003b8c6f83 Store Benchmark - Part 3 (#344) 2025-12-03 01:10:38 +08:00
Yuge Zhang 63b6d42669 Claude Code Example README update (#348) 2025-12-02 01:01:30 +08:00
Yuge Zhang 8c219175f5 Add CI for Claude Code (#346) 2025-12-01 23:48:51 +08:00
Yuge Zhang 931ddcfdcc Store Benchmark - Part 2 (#342) 2025-11-29 07:32:09 +08:00
Yuge Zhang ce80b09a4a Patch LiteLLM root span (#341) 2025-11-28 11:34:03 +08:00
Yuge Zhang f0546ca6c5 Semantic Convention (#340) 2025-11-28 01:22:42 +08:00
Ni Hao 3a3bfeef31 add test code to agentops's tracer (#324) 2025-11-27 21:25:47 +08:00
Geng Zhang a733950b74 Support Claude Code as LitAgent (#332) 2025-11-27 18:39:26 +08:00
Yuge Zhang 662fd90784 Upgrade transformers and CrewAI versions (#336) 2025-11-26 09:25:31 +08:00
Yuge Zhang 475c2adb91 Add Examples Catalog and Refine Contribution Guide (#331) 2025-11-23 16:17:16 +00:00
Yuge Zhang bffc7013f9 Store Benchmark - Part 1 (#328) 2025-11-22 23:35:29 +08:00
Yuge Zhang 4cf8fb94e7 Github Actions Workflow for Tinker and Azure (#327) 2025-11-22 01:47:53 +08:00
Yuge Zhang ab185a5c5a MongoDB-based Lightning Store (#323) 2025-11-21 11:49:54 +08:00
Yuge Zhang d581cbcd63 Upgrade VM image (#325) 2025-11-20 17:49:16 +08:00
Yuge Zhang 3459caa1de Fix OpenAI Agents 0.6 compatibility and pin vLLM < 0.11.1 (#322) 2025-11-20 07:13:15 +08:00
Yuge Zhang f3fd58e72a Put store init in the right place of tracer (#321) 2025-11-19 20:35:27 +08:00
Yuge Zhang b3cb5e1337 Minor improvements to make RL workflow more robust (#319) 2025-11-18 15:40:51 +08:00
Yuge Zhang 3761c0f54c Support native advanced queries in LightningStore (#318) 2025-11-18 10:54:55 +08:00
Yuge Zhang d4334182be Adding check traces with reward for VERL (#317) 2025-11-17 21:18:15 +08:00
Yuge Zhang 57c3c0525e Collection-based Lightning Store (#315) 2025-11-17 18:51:51 +08:00
Yuge Zhang e356593f73 Bump to 0.3.0 (#316) 2025-11-17 17:32:42 +08:00
Yuge Zhang 0e033831d5 Support OTLP in LightningStore (#313) 2025-11-15 16:34:09 +08:00
xiaochulaoban 0d721228d5 Added the README and script files for training sql_agent on NPU (#272)
Co-authored-by: Yuge Zhang <scottyugochang@gmail.com>
2025-11-15 01:27:07 +08:00
Yuge Zhang e49b75b7d8 Check all matching jobs per variant (#310) 2025-11-13 17:10:50 +00:00
Yuge Zhang eab691b1a1 Refactor logging (#306) 2025-11-13 22:48:52 +08:00
Yuge Zhang fd6494873d Make health timeout configurable (#305) 2025-11-13 19:46:02 +08:00
Yuge Zhang 6cbfc1fee0 Fix CI Badge and make Calc-X pipeline faster (#304) 2025-11-13 18:06:18 +08:00
Yuge Zhang b986ae132a Use PythonServerLauncher in LightningStoreServer (#303) 2025-11-13 14:22:54 +08:00
Yuge Zhang f24a47969e Increase graceful timeout on CI (#302) 2025-11-13 10:15:14 +08:00
Yuge Zhang a0bc1827d9 [Release] v0.2.2 (#298) 2025-11-12 23:54:35 +08:00
Yuge Zhang f2869cea30 Fix local model support in VERL (#299) 2025-11-12 22:56:10 +08:00
Geng Zhang 77cf447717 fix stream response for anthropic and openai api (#293)
Co-authored-by: Yuge Zhang <scottyugochang@gmail.com>
2025-11-12 21:29:02 +08:00
Yuge Zhang 790ed3efb3 View worker status on Dashboard (#296) 2025-11-12 21:27:31 +08:00
Yuge Zhang 5ae7933d41 Use unified server launcher for LiteLLM Proxy (#292) 2025-11-12 02:45:29 +08:00
Yuge Zhang 2ab977ed18 Dashboard - build into Python package (#291) 2025-11-11 16:29:02 +08:00
Yuge Zhang 1eae9a34f0 Fix dashboard pipeline (#289) 2025-11-11 00:27:02 +08:00
Yuge Zhang 4e7748b059 Dashboard - tests and infrastructure (#288) 2025-11-10 22:30:00 +08:00
Yuge Zhang 582f67cade Python Server Launcher (#286) 2025-11-10 16:08:05 +08:00
부창규 9e23ba6b50 Rename the function properly in Spider (#285) 2025-11-10 14:57:06 +08:00
Yuge Zhang 3f8a3ac0f1 Preserve interface for SQL store testing (#279) 2025-11-06 00:05:40 +08:00
Yuge Zhang e0b55ab057 Fix preparing status transition on rollout when creating attempts (#278) 2025-11-05 17:45:57 +08:00
Yuge Zhang 421f2773c7 RESTful API improvements (#275) 2025-11-05 14:12:58 +08:00
Yuge Zhang f717f9982f Fix: Port conflict in tracer tests (#271) 2025-11-05 11:10:05 +08:00
Shenghua Chen 44dbfde0b4 fix room_selector example which always run the first task (#270) 2025-11-05 10:47:07 +08:00
Yuge Zhang 713511902d Add Tinker × Agent-lightning tuning articles to docs (#269) 2025-11-04 15:43:24 +08:00
Ni Hao 80531c9c28 fix openai_agent version for compatibility issue. (#265)
* fix openai_agent version for compatibility issue.

* gen uv.lock

---------

Co-authored-by: Hao Ni (CSI Interfusion Co Ltd) <v-nhao@microsoft.com>
2025-11-04 14:54:44 +08:00
Yuge Zhang 37daf2104f Adding VERL replacement for Tinker (#264)
* Adding VERL replacement for Tinker

* Apply suggestion from @Copilot

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-11-04 12:09:36 +08:00
Yuge Zhang 9afdd4570c docs: add deepwiki badge to readme (#263) 2025-11-03 08:09:06 +00:00
Vishal V 55fbe66fe7 docs: fix typos in train-first-agent.md (#260)
Co-authored-by: Vishal <VishalV@ibm.com>
2025-11-02 16:01:46 +08:00
Yuge Zhang 3794c97c1e Store RESTful API updates (#259) 2025-11-02 16:01:32 +08:00
Yuge Zhang 848623766d Azure OpenAI Finetuning example (#256) 2025-11-01 23:44:30 +08:00
Yuge Zhang 4cd09ec900 Add contributor and maintainer guides (#239) 2025-11-01 13:08:59 +08:00
Zhiyuan He 3ed5e1e5b5 Fix training metrics before and after processing (#145) 2025-10-31 23:09:10 +08:00
Ni Hao 3f372ff7b3 Replace AgentOps mock server with bypassable client (#202)
---------

Co-authored-by: Hao Ni (CSI Interfusion Co Ltd) <v-nhao@microsoft.com>
2025-10-31 23:05:39 +08:00
Yuge Zhang c453c41fd2 Fix tests-full failure to checkout PR branch (#253) 2025-10-31 11:29:17 +00:00
Yuge Zhang 5c8ac61af6 Bump version to 0.2.2 (#248) 2025-10-31 18:14:43 +08:00
Zhiyuan He a02e1b91d9 Add support for verl 0.6.0 (#246) 2025-10-31 15:30:38 +08:00
Yuge Zhang 496e793f0b Tinker Integration (#245) 2025-10-30 12:44:17 +08:00
Yuge Zhang 80d306ff54 [Release] v0.2.1 (#243) 2025-10-30 08:31:45 +08:00
Yuge Zhang 5f67bfe137 Normalize Store FastAPI (#241) 2025-10-29 21:43:37 +08:00
John Eismeier f8c45b6ca8 propose fix a couple of typos and avoid emacs backup files (#237)
Signed-off-by: John E <jeis4wpi@outlook.com>
2025-10-29 09:42:58 +08:00
ddsfda99 01955aead7 Fix store port conflict handling (issue #221) (#227) 2025-10-28 14:58:41 +08:00
Yuge Zhang 0a9e3d75f2 Fix CI GPU trigger (#234) 2025-10-28 14:55:18 +08:00
Ni Hao a3b2db18fa Make the number of tasks on the server and client consistent. (#187) 2025-10-28 14:27:46 +08:00
Yuge Zhang 268bd77ce6 Refine notes and triggering conditions (#233) 2025-10-28 12:30:37 +08:00
Yuge Zhang ab6ea3c131 Augment backport implementation (#230) 2025-10-28 03:57:16 +00:00
Yuge Zhang d16538da96 Internal API update in preparation for Tinker integration (#226) 2025-10-28 11:26:49 +08:00
Yuge Zhang 8ce40a0410 Add backport support (#229) 2025-10-28 11:21:36 +08:00
Yuge Zhang a9c7dbef22 Track Actions Status in Issue Comment Responder (#228) 2025-10-28 00:01:31 +08:00
Yuge Zhang e69d24f4a8 Fix response ID security (#217) 2025-10-27 21:07:10 +08:00
Yuge Zhang 955a0cc9a3 Revert #224 (#225) 2025-10-27 20:38:12 +08:00
Yuge Zhang 3966db6d2a Post comment on workflow run ready (#224) 2025-10-27 19:46:41 +08:00
Yuge Zhang 584600d72e Fix property list too long in issue responder (#223) 2025-10-27 11:20:34 +00:00
Yuge Zhang 955524658d Update CI triggering mechanism (#222) 2025-10-27 19:10:16 +08:00
Yuge Zhang 4d5e133a06 Add vLLM blog link to resources (#215) 2025-10-26 09:57:07 +08:00
Yuge Zhang df2a159b00 Add tutorial for launching workers on separate machines (#213) 2025-10-25 14:16:27 +08:00
Yuge Zhang 675fc86727 Issue comment responder (#214) 2025-10-25 13:00:02 +08:00
Yuge Zhang c16b3a21b6 Add dependency groups from Tinker and CrewAI (#212) 2025-10-25 12:27:37 +08:00
Yuge Zhang aab976558b Add Trainer port option for client-server strategies (#198) 2025-10-25 01:41:41 +08:00
Yuge Zhang 91c85aef7e Serialize docs deployment workflow (#205) 2025-10-25 01:29:12 +08:00
scott-vsi a1c36b55a0 Update verl.md (#210)
included a link to the VERL Framework
2025-10-25 01:07:50 +08:00
Yuge Zhang 6700878f64 Switch tracer models to ConfigDict for Pydantic v2 compliance (#211) 2025-10-25 01:07:33 +08:00
Yuge Zhang 56fa8d6881 Fix LiteLLM dual init issue (#206) 2025-10-25 00:58:37 +08:00
Yuge Zhang b0f28423b2 Fix model name selection in LLMProxy (#197) 2025-10-24 01:38:49 +08:00
Yuge Zhang e28fb8cb6b Fix LiteLLM logging worker reset on proxy restart (#174) 2025-10-24 00:56:16 +08:00
Yuge Zhang fae0fba3d7 Fix trigger on label (#204) 2025-10-23 23:05:43 +08:00
Yuge Zhang 0decbabfbe Remove extra blank lines after Examples headers (#201) 2025-10-23 15:06:49 +08:00
Yuge Zhang af7a6aa2cc Bump version to 0.2.1 (#199) 2025-10-23 15:06:06 +08:00
Yuge Zhang ae4e992771 Use pull_request_target trigger to allow fork-origin PRs to check on privileged workflows (#200) 2025-10-23 13:46:44 +08:00
Yuge Zhang 8abe85ad91 Using Group Subscription for CI (#195) 2025-10-22 21:39:58 +08:00
Yuge Zhang 22454adedb Fix release pipeline (#194)
Deploy Documentation / deploy (push) Has been cancelled
PyPI Release / check-version (push) Has been cancelled
PyPI Release / publish-pypi (push) Has been cancelled
2025-10-22 14:02:36 +08:00
Yuge Zhang 483c518d74 Adjust CI status placement and example catalog details (#193) 2025-10-22 13:11:40 +08:00
Yuge Zhang 948506f3b6 Badge aggregation on workflow dispatch (#192) 2025-10-22 11:29:50 +08:00
Yuge Zhang 34437dd6f5 Trigger the workflows on certain labels and reopen event (#190) 2025-10-22 11:29:29 +08:00
Yuge Zhang 951fa685b5 Aggregate badge statuses (#191) 2025-10-22 10:55:34 +08:00
Yuge Zhang 2b12e29f32 Clarify platform and runtime requirements (#188) 2025-10-22 10:03:43 +08:00
Ni Hao 0e04363f4c force to output logs on windows. (#176) 2025-10-21 17:37:38 -07:00
Yuge Zhang e91187b491 Update installation instructions (#179) 2025-10-20 19:44:13 +08:00
Yuge Zhang c4b829dbe7 Update README and documentation README (#183) 2025-10-20 19:36:00 +08:00
Yuge Zhang 5c274703fe Split examples.yml into multiple workflow definitions (#181) 2025-10-20 14:59:20 +08:00
Yuge Zhang 55284f8394 Ensure store server serializes access per thread (#175) 2025-10-20 14:56:19 +08:00
Yuge Zhang 895bffc5b6 Split Examples test into mulitple jobs (#180) 2025-10-20 14:36:19 +08:00
Yuge Zhang 8e06fe6902 Migrate to use uv as dependency manager (#170) 2025-10-20 01:42:48 +08:00
Yuge Zhang 7d8dccd2b0 Refresh Python Package Docstrings and Minor Documentation Refinement (#173) 2025-10-19 23:08:10 +08:00
Yuge Zhang 89a887d835 Documentation update: Serving LLM, Unsloth SFT, Parallelize (#169) 2025-10-18 20:48:04 +08:00
Yuge Zhang d31090e9ee Pin LangChain version to less than 1.0 (#168) 2025-10-18 12:48:06 +08:00
Yuge Zhang c6298a96fd Documentation update: Train SQL Agent, Traces, Debugging (#167) 2025-10-17 18:24:27 +00:00
Yuge Zhang fcb2a0811e Upgrade Calc-X Agent Example and Misc Bug Fixes (#166) 2025-10-17 18:58:52 +08:00
Yuge Zhang bdf6a8f223 Make tracer.trace_context async (#165) 2025-10-17 02:03:27 +08:00
Yuge Zhang 8c673c241e Streamline in-memory span eviction thresholds (#161) 2025-10-17 00:51:22 +08:00
Yuge Zhang b7d2d6d6cb Upgrade SQL Agent Example to v0.2 (#164) 2025-10-16 17:49:45 +08:00
Yuge Zhang 46a08d7272 Documentation update: Write agents and Understanding Store (#163) 2025-10-16 15:01:39 +08:00
Yuge Zhang cca9e9d62f fix: include optional fields in rollout requests (#162) 2025-10-16 14:53:40 +08:00
Yuge Zhang 8aeb0ec1ba Preserve timeout status when spans arrive (#160) 2025-10-16 14:12:27 +08:00
Yuge Zhang 65ba916743 Support unmanaged execution store configuration (#159)
* Support unmanaged execution store configuration

* Refine managed store cleanup and extend strategy tests
2025-10-16 12:04:46 +08:00
Yuge Zhang d35a33dc14 [BREAKING] Strip "Base" from base classes (#158) 2025-10-16 09:52:12 +08:00
Nanako 418691e5a2 Add Search-R1 Example and Per-Source Test Statistics (#147)
* update Search_R1 Example

* update per-source statistics comments
2025-10-16 02:46:59 +08:00
Yuge Zhang 8b33ddc028 Quickstart tutorials update and documentation structure update (#157) 2025-10-15 18:01:09 +08:00
Yuge Zhang bdc0b7e2a8 [BREAKING] Update API names and imports (#155) 2025-10-15 13:37:44 +08:00
Yuge Zhang 2adaddbf7c Pin unsloth to 2025.10.1 (#154) 2025-10-15 01:13:45 +08:00
Yuge Zhang 86becfdbff Add Built-in APO algorithm and Associated Examples (#153) 2025-10-14 16:17:01 +00:00
Yuge Zhang 994384cb9b Fix MessagesAdapter (cont.) (#152) 2025-10-14 15:40:42 +08:00
Yuge Zhang 7f8395b941 Fix Messages Adapter (#150) 2025-10-14 09:01:56 +08:00
Yuge Zhang 495d4eba38 Refine algo decorator fallbacks (#146) 2025-10-13 23:46:47 +08:00
Yuge Zhang 8dd4c5a1a3 Local SFT example and bug fixes (#149) 2025-10-13 23:10:00 +08:00
Yuge Zhang b1ae0b75c4 Ensure Trainer.dev validates FastAlgorithm usage (#148) 2025-10-13 22:02:52 +08:00
Yuge Zhang 9f8ec4950f Refactor emitter module and extract common utilities (#143) 2025-10-12 00:37:44 +08:00
Yuge Zhang c08da2ae37 Use Azure OpenAI and MSR W&B (#142) 2025-10-12 00:01:49 +08:00
Yuge Zhang f032ffa319 Refactor LitAgent decorators and add prompt_rollout support (#141) 2025-10-11 13:56:08 +08:00
Yuge Zhang a4cf2fd5fd Update docs palette and add version warning (#139) 2025-10-10 17:59:01 +00:00
Yuge Zhang 8a4ecbacf6 Improve debugging experience and add new APO example (#138) 2025-10-11 01:42:54 +08:00
Yuge Zhang dd337d456e Add AgentFlow community project links (#137) 2025-10-11 01:28:19 +08:00
Yuge Zhang a0626bdea9 Bird's eye view (v0.2) (#136) 2025-10-10 17:09:02 +08:00
Yuge Zhang 2489d068ba Add env overrides for client/server execution strategy (#135) 2025-10-10 00:43:46 +08:00
Yuge Zhang f4814949cb Supports collecting trace data from LLMProxy (#133) 2025-10-10 00:16:03 +08:00
Yuge Zhang a0791e8b13 Fix flaky pipeline (#131) 2025-10-09 14:54:33 +08:00
Yuge Zhang 26d1df698d Show pytest durations in workflows (#130) 2025-10-09 01:54:06 +08:00
Yuge Zhang 7bf418ea67 Use v0.2 interfaces in Trainer (#129) 2025-10-09 01:53:12 +08:00
Yuge Zhang d735fb27c4 Handle recovering attempts in memory store (#124) 2025-10-09 01:45:50 +08:00
lhx 347638f218 fix: add BaseMessage import to sql_agent.py (#126)
* fix: add BaseMessage import to sql_agent.py

* trigger

---------

Co-authored-by: Yuge Zhang <scottyugochang@gmail.com>
2025-10-09 01:39:41 +08:00
Yuge Zhang a42839b7fb Move test files (#128) 2025-10-08 14:36:54 +08:00
Yuge Zhang e11036cf7b Fix HTTP tracer tests (#127) 2025-10-08 13:30:36 +08:00
Yuge Zhang 685eea70a6 Implement AgentRunnerV2 (#125) 2025-10-03 01:10:09 +08:00
Yuge Zhang a1a4fe39c6 Add missing future import annotations (#123) 2025-10-02 01:48:49 +08:00
Yuge Zhang a9d0c9237d Add LLM proxy (#122) 2025-10-02 01:26:04 +08:00
Yuge Zhang 1513b52a05 Add full pytest workflow on GPU (#121) 2025-10-01 08:06:40 +00:00
xJkie 4ec1029577 Rollout with rollout_manager with REMAX advantage estimator (#115) 2025-10-01 13:10:45 +08:00
Yuge Zhang 63c133051d Add Execution Strategies: Client-Server and Shared Memory implementations (#120) 2025-10-01 13:09:45 +08:00
Yuge Zhang 2316a8451e Add LightningStore interface and implementation (#118) 2025-09-30 09:29:14 +00:00
Yuge Zhang 138ad0e487 Add DeepWerewolf to community projects (#112) 2025-09-27 13:59:56 +08:00
Yuge Zhang 504ef2c627 Add visualization to adapter (#113)
* Add visualization to adapter

* Update agentlightning/adapter/triplet.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-09-27 12:21:40 +08:00
Yuge Zhang a63197355c Initialize trace adapter (#103) 2025-09-20 12:57:12 +00:00
Yuge Zhang 3eb725fade Update pre-commit configurations and bump to 0.2.0 (#102) 2025-09-20 07:20:14 +00:00
Yuge Zhang 66bcfeba11 Fix pyright issues (#101) 2025-09-20 14:51:56 +08:00
Yuge Zhang a9208ab700 Sort imports (#100) 2025-09-20 11:30:34 +08:00
Yuge Zhang ddc8997b8c Embed algorithm into trainer (#99) 2025-09-19 18:42:58 +08:00
Yuge Zhang 0a92600a4c Ensure blank line after copyright header (#97)
* Ensure copyright header has separating blank line

* fix check script

* trigger pre-commits
2025-09-19 05:32:24 +00:00
Yuge Zhang ba10c845e1 Bug fixes and RL improvements for Agent-framework support (#96) 2025-09-18 21:22:09 +08:00
Yuge Zhang 7ad967daf7 Skip unexpected rollout ids (#85) 2025-09-18 20:43:44 +08:00
Yuge Zhang f6db2dc8ab Migrate to 1ES pipeline (#95) 2025-09-18 20:26:16 +08:00
Yuge Zhang 5724f63cfc Bump agentops, pin verl (#90) 2025-09-13 10:14:53 +08:00
Luna Qiu bd6c62dd7c Update RAI transparency documentation (#84)
* Update RAI transparency documentation

* Update RAI_README.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-09-06 13:52:00 +08:00
Yuge Zhang b9595b8b0d Add rollout hooks and tests (#25) 2025-09-01 16:33:09 +08:00
Wang Zilong a54c6f39e8 Update README.md (#62)
Update retrieval corpus preparation in rag/README.md
2025-08-28 16:29:20 +08:00
Zhiyuan He 6bd01959cd Bug Fix: Correct model name when using a local model (#75)
* fix naming

* fix unexpected change
2025-08-28 16:05:33 +08:00
Yuge Zhang d00cc3e4aa Fix RAGAgent initialization (#53) 2025-08-15 14:06:09 +08:00
Yuge Zhang bea013632e docs: update Discord invitation link (#55) 2025-08-14 11:49:49 +08:00
Yuge Zhang 13bd48dbfc chore: update discord invitation (#54) 2025-08-14 09:11:45 +08:00
Yuge Zhang 31309810f7 docs: add Discord community badge (#52) 2025-08-14 00:42:49 +08:00
290 changed files with 34654 additions and 12557 deletions
+232
View File
@@ -0,0 +1,232 @@
---
name: release
description: Prepare and publish stable Agent Lightning releases through the repository's version bump, pull-request checks, merge, tag, PyPI trusted-publishing, and versioned-documentation workflows. Use when asked to plan, cut, verify, or explain a release; treat nightly TestPyPI builds as a separate path.
---
# Release Agent Lightning
Merging a pull request does not publish a stable release. Stable publication is
triggered only by pushing a `v*` tag to the canonical repository; the tagged
commit is what gets tested, built, and uploaded. That same tag push also deploys
versioned documentation and moves the public `stable` alias, so a release has two
public side effects, not one.
## Establish the release state
1. Confirm the repository root, clean working tree, current branch, and remotes.
2. Resolve the canonical `OWNER/REPO`, its default branch, and its permitted
merge methods with
`gh repo view OWNER/REPO --json nameWithOwner,defaultBranchRef,mergeCommitAllowed,rebaseMergeAllowed,squashMergeAllowed`.
Identify the local remotes for that repository and the contributor fork by
their URLs; do not assume particular remote names or merge settings.
3. Inspect the release contract in:
- `.github/workflows/pypi-release.yml`
- `.github/workflows/docs.yml`
- `.github/workflows/tests.yml`
- `scripts/bump_version.sh`
- `pyproject.toml`
- `agentlightning/__init__.py`
4. Confirm the canonical default branch is already green before branching from
it. Resolve its current commit with
`gh api repos/OWNER/REPO/commits/<default-branch>` and inspect that commit's
check runs; a general recent-run listing can omit or mix commits. A release
branch inherits every failure that main is carrying.
5. Query the canonical repository's tags and compare them with the versions
published at `https://pypi.org/pypi/agentlightning/json`. Confirm the target
version exists in neither place, and stop for an explicit release decision
when either of these holds:
- A tag exists with no matching PyPI version. A published version is
immutable, and its tag must never be reused or moved. A tag that never
published is a different situation and still needs a human decision,
informed by why it did not publish. See "Recovering a tag that never
published" below.
- The proposed bump would skip a version that was tagged but never published.
6. Treat verified PyPI trusted-publisher configuration for the canonical
repository and `pypi-release.yml` as a prerequisite. If it cannot be
inspected directly, require confirmation from an authorized PyPI project
owner before pushing the release tag.
## Prepare and merge the version pull request
Start a release branch from a freshly fetched canonical default branch, not
from another feature branch. The branch name is only a recommendation:
```bash
git fetch <canonical-remote> <default-branch>
git switch -c chore/release-vX.Y.Z <canonical-remote>/<default-branch>
scripts/bump_version.sh patch # or minor / major
```
The script updates the project version with uv and then edits
`agentlightning/__init__.py` separately. If it fails or is interrupted between
those writes, only some of the three version files may be updated. Inspect
`git diff` after any failure and restore or reconcile all three files before
retrying; blindly rerunning a partial patch bump can advance the version twice.
The bump rewrites exactly three files. Confirm that with `git diff --stat`:
- `pyproject.toml`
- the `agentlightning` entry in `uv.lock`
- `agentlightning.__version__` in `agentlightning/__init__.py`
Other version strings in the tree, such as the FastAPI `version` in
`agentlightning/server/app.py`, are deliberately outside the bump. Leave them
alone; changing them is a separate pull request, not release work.
Review the version diff, but do not run the release tests or package build
locally as a matter of course. `tests.yml` runs a broader test suite and the
same package build on the pull request, covering the narrower tests and build
that `pypi-release.yml` will run on the tag. The pull request's GitHub checks
are therefore the verification gate. Reproduce a single failure locally only
when the workflow logs are not enough to fix it.
Commit the version change, push it to the fork, and open the pull request with
the GitHub CLI when those external actions are authorized:
```bash
git commit -am "Bump version to X.Y.Z"
git push -u <fork-remote> <release-branch>
gh pr create --repo OWNER/REPO \
--base <default-branch> \
--head <fork-owner>:<release-branch> \
--title "Bump version to X.Y.Z" \
--body "Prepare the vX.Y.Z release."
```
`gh pr create` refuses to run without `--title` and `--body` outside an
interactive terminal, and every `gh` call needs `--repo OWNER/REPO` so it acts
on the canonical repository rather than the fork.
Follow the pull request through its required checks with
`gh pr checks <pr> --repo OWNER/REPO --watch`. If a check fails, take the run id
from that output, inspect it with
`gh run view <run-id> --repo OWNER/REPO --log-failed`, correct the source on the
same branch, and resume watching. Once every required check has succeeded,
extract the reviewed head and pass both a permitted merge-method flag from step
2 and `--match-head-commit` to `gh pr merge`:
```bash
HEAD_SHA="$(gh pr view <pr> --repo OWNER/REPO --json headRefOid --jq .headRefOid)"
gh pr merge <pr> --repo OWNER/REPO <merge-method-flag> \
--match-head-commit "$HEAD_SHA"
```
Replace `<merge-method-flag>` with one permitted flag discovered in step 2:
`--merge`, `--rebase`, or `--squash`.
Committing, pushing, opening the pull request, and merging are each distinct
external actions and each requires authorization.
## Tag and publish the merged release
After the pull request merges, update the local default branch from the
canonical repository, then confirm that the commit you are about to tag is the
one this pull request produced and not a later commit that landed behind it:
```bash
git switch <default-branch>
git pull --ff-only <canonical-remote> <default-branch>
gh pr view <pr> --repo OWNER/REPO --json mergeCommit
git rev-parse HEAD
```
If HEAD has moved past the merge commit, tag the merge commit explicitly instead
of HEAD.
`pypi-release.yml` fails the release when the packaged version does not equal the
tag without its leading `v`, or when it does not equal the runtime
`__version__`. Check both before tagging:
```bash
uv version --short
grep '^__version__' agentlightning/__init__.py
```
The workflow itself reads the runtime value as
`python -c 'from agentlightning import __version__; print(__version__)'` from
the repository root before its dependency-sync step, so Python resolves the
checkout through the current working directory. Read the file directly for the
local pre-tag check; `agentlightning/__init__.py` assigns `__version__` as a
single literal, making that check independent of the active Python environment.
GitHub reads workflow files as they exist **at the tagged commit**, not at the
tip of the default branch. Confirm that the commit being tagged actually
contains `.github/workflows/pypi-release.yml` with its `v*` trigger; a commit
that predates the workflow will never publish, however the tag is pushed.
Immediately query the canonical repository and PyPI again to ensure that
`vX.Y.Z` is still absent. Then create an annotated tag on the release commit and
push it to the canonical repository:
```bash
git tag -a vX.Y.Z -m "vX.Y.Z" <release-commit>
git push <canonical-remote> vX.Y.Z
```
The tag push starts the production PyPI publication, so obtain explicit
authorization immediately before it.
## Follow both tag-triggered workflows
One tag push starts two workflows, and both belong to the release:
- `PyPI Release` (`pypi-release.yml`) re-checks the version against the tag,
runs the tests, builds the wheel and source distribution, and uploads them to
PyPI through trusted publishing.
- `Deploy Documentation` (`docs.yml`) runs
`mike deploy --push --update-aliases X.Y.Z stable`, which publishes the
versioned documentation and repoints the public `stable` alias at this
release.
Look up each run by workflow and tag rather than selecting from an unfiltered
recent-run list:
```bash
gh run list --repo OWNER/REPO --workflow pypi-release.yml \
--branch vX.Y.Z --event push --limit 1
gh run list --repo OWNER/REPO --workflow docs.yml \
--branch vX.Y.Z --event push --limit 1
```
Confirm both runs have the expected tag commit, then follow them to a terminal
result with `gh run watch <run-id> --repo OWNER/REPO --exit-status`. After
`PyPI Release` succeeds, verify that PyPI exposes the exact version with both
the expected wheel and source distribution. After `Deploy Documentation`
succeeds, verify that the published site serves `X.Y.Z` and that `stable`
resolves to it. A green PyPI job with a failed documentation job is a
half-finished release: report both workflow URLs and both outcomes.
For a transient workflow failure, rerun only with authorization. For a source
or workflow defect, do not move the public tag; prepare a corrective release
version. A GitHub Release and release notes are optional, separate publication
actions and must not be created unless requested.
## Recovering a tag that never published
Separate the mechanics from the policy before proposing a recovery.
The mechanics: pushing a tag that already exists and points at the same commit
changes no ref, so it starts no workflow run. Creating a tag, moving one to a
different commit, or deleting and recreating one does change the ref and does
start a run. What that run executes is the workflow file at the tagged commit,
so a tag on a commit from before `pypi-release.yml` existed starts no PyPI
publication no matter how it is pushed. Run
`git ls-tree --name-only <tag> .github/workflows/` before assuming a re-push
would help.
The policy: never move or reuse a tag whose version is on PyPI. That version is
immutable, so a re-run could only fail at upload, and consumers who already
resolved the tag would silently get different code.
Between those, a tag that never published is a decision for a release owner,
not a default action. Releasing the next version from a commit that carries the
current workflow is usually simpler and always safer than resurrecting the old
tag. Note that a non-publishing tag may still have had effects: `docs.yml` has
carried the `v*` trigger for longer than `pypi-release.yml`, so an older tag can
have deployed documentation and moved `stable` without ever reaching PyPI.
## Nightly distinction
`.github/workflows/pypi-nightly.yml` publishes timestamped `.dev` builds to
TestPyPI on its schedule or by manual dispatch. It does not create a stable
release and should not be substituted for the tag-driven process above.
@@ -0,0 +1,4 @@
interface:
display_name: "Release"
short_description: "Prepare and publish Agent Lightning releases"
default_prompt: "Use $release to prepare and publish a new Agent Lightning release."
+81
View File
@@ -0,0 +1,81 @@
# Version control / editor state
# Local Python environments and caches
# Local-only runtime/deploy state
.git/
.gitignore
.gitattributes
.vscode/
.idea/
.claude/
.DS_Store
**/.DS_Store
# Local Python environments and caches
.venv/
.venv.bak/
venv/
env/
ENV/
__pycache__/
**/__pycache__/
*.py[codz]
*.pyo
*.pyd
*.so
*.egg-info/
.eggs/
dist/
build/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.pyright/
.ipynb_checkpoints/
**/.ipynb_checkpoints/
.cache/
# Local-only runtime/deploy state
.local/
.env
**/.env
.env.local
*.env.local
.envrc
tmp/
node_modules/
checkpoints/
artifacts/
logs/
**/logs/
*.log
*-debug.log
2026-*-debug.log
# Files not needed for runtime images
tests/
docs/
dev/
uv.lock
# Large example data and generated outputs
examples/*/data/
examples/*/outputs/
examples/*/wandb/
examples/*/mlruns/
wandb/
runs/
outputs/
mlruns/
# Archives and large packaged artifacts
*.zip
*.tar
*.tar.gz
*.tgz
*.tar.bz2
*.tar.xz
*.7z
agentlightning-main.zip
# Docs/dev generated artifacts
docs/refactor_review/public/
+11
View File
@@ -0,0 +1,11 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
groups:
github-actions:
patterns: ["*"]
schedule:
interval: "weekly"
cooldown:
default-days: 7
+15 -11
View File
@@ -8,6 +8,10 @@ on:
- 'v*'
workflow_dispatch:
concurrency:
group: docs-deploy
cancel-in-progress: false
permissions:
contents: write
pages: write
@@ -17,18 +21,17 @@ jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v5
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
with:
python-version: '3.12'
- name: Install dependencies
run: |
./scripts/setup_stable.sh
- uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7.6.0
with:
enable-cache: true
- name: Sync dependencies
run: uv sync --frozen --no-default-groups --group dev --group docs
- name: Configure Git
run: |
@@ -51,10 +54,11 @@ jobs:
- name: Deploy versioned docs
if: startsWith(github.ref, 'refs/tags/')
run: |
mike deploy --push --update-aliases ${{ steps.version.outputs.version }} stable
uv run --locked --no-sync mike deploy --push --update-aliases ${{ steps.version.outputs.version }} stable
- name: Deploy dev docs
if: github.ref == 'refs/heads/main'
run: |
mike deploy --push latest
mike set-default --push latest
uv run --locked --no-sync mike deploy --push latest
# Always set stable to default
uv run --locked --no-sync mike set-default --push stable
-156
View File
@@ -1,156 +0,0 @@
name: GPU Test
permissions:
contents: read
on:
schedule:
# Every day at 3 AM UTC+8
- cron: '0 19 * * *'
workflow_dispatch:
jobs:
examples:
runs-on: [self-hosted, linux, gpu]
timeout-minutes: 60
strategy:
matrix:
setup: [stable, latest]
fail-fast: false
container:
image: ghcr.io/microsoft/agent-lightning/base:latest
options: --gpus all --ipc=host --interactive --tty
steps:
- name: Check GPU status
run: nvidia-smi
- uses: actions/checkout@v4
- name: Create a virtual environment
run: python3 -m venv .venv
- name: Install deps inside the container (${{ matrix.setup }})
run: |
. .venv/bin/activate
./scripts/setup_${{ matrix.setup }}_gpu.sh
- name: Freeze dependencies
run: |
. .venv/bin/activate
which python
which pip
which uvx
pip list | tee requirements-freeze.txt
- name: Upload dependencies artifact
uses: actions/upload-artifact@v4
with:
name: dependencies-${{ matrix.setup }}
path: requirements-freeze.txt
compression-level: 0
- name: Prepare Spider dataset
run: |
set -ex
. .venv/bin/activate
cd examples/spider
gdown --fuzzy https://drive.google.com/file/d/1oi9J1jZP9TyM35L85CL3qeGWl2jqlnL6/view
unzip -q spider-data.zip -d data
rm spider-data.zip
- name: Prepare Calc-X dataset
run: |
set -ex
. .venv/bin/activate
cd examples/calc_x
gdown --fuzzy https://drive.google.com/file/d/1FQMyKLLd6hP9dw9rfZn1EZOWNvKaDsqw/view
unzip calc-x-data.zip -d data
rm calc-x-data.zip
- name: Spider sanity check
run: |
set -ex
. .venv/bin/activate
cd examples/spider
python sql_agent.py --trainer.n-workers 1 --trainer.dev true --trainer.max-tasks 2
env:
VERL_API_BASE: http://localhost:9999/
OPENAI_API_BASE: ${{ secrets.OPENAI_API_BASE }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
- name: Calc-X MCP sanity check
run: |
set -ex
. .venv/bin/activate
cd examples/calc_x
python tests/test_mcp_calculator.py
env:
OPENAI_API_BASE: ${{ secrets.OPENAI_API_BASE }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
- name: Calc-X sanity check
run: |
set -ex
. .venv/bin/activate
cd examples/calc_x
python calc_agent_dev.py
env:
OPENAI_API_BASE: ${{ secrets.OPENAI_API_BASE }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
# Calc-X training suddenly works after running the sanity check.
# And it has to be run before Spider training.
# The client side used to hang in many of my attempts.
# Don't ask why. Don't touch this.
- name: Calc-X training
run: |
set -ex
source .venv/bin/activate
cd examples/calc_x
../../scripts/restart_ray.sh
sleep 5
PYTHONUNBUFFERED=1 python calc_agent.py &
bash train_ci.sh
pkill -f calc_agent.py && echo "SIGTERM sent to calc_agent.py" || echo "No calc_agent.py process found"
while pgrep -f calc_agent.py; do
echo "Waiting for calc_agent.py to finish..."
sleep 5
done
echo "calc_agent.py has finished."
sleep 10
shell: bash
env:
WANDB_API_KEY: ${{ secrets.WANDB_API_KEY }}
id: calc_x_train
- name: Validate Calc-X training
run: |
set -ex
. .venv/bin/activate
python scripts/validate_example_wandb.py ${{ steps.calc_x_train.outputs.project_name }} ${{ steps.calc_x_train.outputs.run_name }}
env:
WANDB_API_KEY: ${{ secrets.WANDB_API_KEY }}
- name: Spider training
run: |
set -ex
source .venv/bin/activate
cd examples/spider
../../scripts/restart_ray.sh
sleep 5
PYTHONUNBUFFERED=1 python sql_agent.py --trainer.n-workers 10 &
bash train_ci.sh
pkill -f sql_agent.py && echo "SIGTERM sent to sql_agent.py" || echo "No sql_agent.py process found"
while pgrep -f sql_agent.py; do
echo "Waiting for sql_agent.py to finish..."
sleep 5
done
echo "sql_agent.py has finished."
sleep 10
shell: bash
env:
VERL_API_BASE: http://localhost:9991/
WANDB_API_KEY: ${{ secrets.WANDB_API_KEY }}
id: spider_train
if: success() || failure()
- name: Validate Spider training
run: |
set -ex
. .venv/bin/activate
python scripts/validate_example_wandb.py ${{ steps.spider_train.outputs.project_name }} ${{ steps.spider_train.outputs.run_name }}
env:
WANDB_API_KEY: ${{ secrets.WANDB_API_KEY }}
- name: Cleanup
run: ./scripts/cleanup.sh
if: success() || failure()
+46 -37
View File
@@ -2,58 +2,67 @@ name: PyPI Nightly Build
on:
schedule:
# Run daily at 6:00 AM UTC
- cron: '0 6 * * *'
workflow_dispatch: # Allow manual trigger
# Run daily at 6:00 AM UTC+8.
- cron: '0 22 * * *'
workflow_dispatch:
permissions:
contents: read
concurrency:
group: pypi-nightly
cancel-in-progress: false
jobs:
publish-test-pypi:
name: Publish nightly package to TestPyPI
runs-on: ubuntu-latest
timeout-minutes: 10
permissions:
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
contents: read
id-token: write
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
with:
python-version: '3.12'
- name: Install build dependencies
run: |
python -m pip install --upgrade pip
pip install -e .[dev]
- name: Get current version
id: get_version
run: |
VERSION=$(grep '^version = ' pyproject.toml | sed 's/version = "\(.*\)"/\1/')
echo "version=$VERSION" >> $GITHUB_OUTPUT
echo "Current version: $VERSION"
- uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7.6.0
with:
enable-cache: true
- name: Create development version
id: version
shell: bash
run: |
# Create a dev version with timestamp
TIMESTAMP=$(date +%Y%m%d%H%M%S)
DEV_VERSION="${{ steps.get_version.outputs.version }}.dev$TIMESTAMP"
echo "Creating dev version: $DEV_VERSION"
./scripts/bump_version.sh "$DEV_VERSION"
set -euo pipefail
BASE_VERSION=$(uv version --short)
TIMESTAMP=$(date -u +%Y%m%d%H%M%S)
DEV_VERSION="${BASE_VERSION}.dev${TIMESTAMP}"
uv version --frozen "${DEV_VERSION}"
sed -i "s/^__version__ = \".*\"$/__version__ = \"${DEV_VERSION}\"/" agentlightning/__init__.py
echo "version=${DEV_VERSION}" >> "${GITHUB_OUTPUT}"
- name: Verify version consistency
shell: bash
run: |
set -euo pipefail
PACKAGE_VERSION=$(uv version --short)
RUNTIME_VERSION=$(python -c 'from agentlightning import __version__; print(__version__)')
if [[ "${PACKAGE_VERSION}" != "${RUNTIME_VERSION}" ]]; then
echo "Package version ${PACKAGE_VERSION} does not match runtime version ${RUNTIME_VERSION}." >&2
exit 1
fi
- name: Build package
run: |
hatch build
run: uv build --no-sources
- name: Publish to Test PyPI
uses: pypa/gh-action-pypi-publish@release/v1
- name: Verify package contents
run: |
python -m tarfile -l dist/*.tar.gz
python -m zipfile -l dist/*.whl
- name: Publish ${{ steps.version.outputs.version }} to TestPyPI
uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
with:
repository-url: https://test.pypi.org/legacy/
- name: Test installation from Test PyPI
run: |
# Wait a bit for the package to be available
sleep 30
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ agentlightning
python -c "import agentlightning; print('Package installed successfully')"
+45 -55
View File
@@ -3,67 +3,64 @@ name: PyPI Release
on:
push:
tags:
- 'v*' # Trigger on version tags like v1.0.0, v1.2.3, etc.
workflow_dispatch: # Allow manual trigger
- 'v*'
permissions:
contents: read
jobs:
check-version:
runs-on: ubuntu-latest
permissions:
contents: read
outputs:
version: ${{ steps.get_version.outputs.version }}
tag_version: ${{ steps.get_tag.outputs.tag_version }}
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Get version from pyproject.toml
id: get_version
run: |
VERSION=$(grep '^version = ' pyproject.toml | sed 's/version = "\(.*\)"/\1/')
echo "version=$VERSION" >> $GITHUB_OUTPUT
echo "Package version: $VERSION"
- name: Get tag version
id: get_tag
run: |
TAG_VERSION=${GITHUB_REF#refs/tags/v}
echo "tag_version=$TAG_VERSION" >> $GITHUB_OUTPUT
echo "Tag version: $TAG_VERSION"
- name: Verify version matches tag
run: |
if [ "${{ steps.get_version.outputs.version }}" != "${{ steps.get_tag.outputs.tag_version }}" ]; then
echo "Error: Version in pyproject.toml (${{ steps.get_version.outputs.version }}) does not match tag (${{ steps.get_tag.outputs.tag_version }})"
exit 1
fi
echo "Version check passed!"
publish-pypi:
needs: check-version
name: Test, build, and publish package
runs-on: ubuntu-latest
timeout-minutes: 15
permissions:
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
contents: read
id-token: write
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
with:
python-version: '3.12'
- uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7.6.0
with:
enable-cache: true
- name: Install build dependencies
- name: Verify version matches tag
shell: bash
run: |
python -m pip install --upgrade pip
pip install -e .[dev]
set -euo pipefail
PACKAGE_VERSION=$(uv version --short)
TAG_VERSION="${GITHUB_REF_NAME#v}"
if [[ "${PACKAGE_VERSION}" != "${TAG_VERSION}" ]]; then
echo "Package version ${PACKAGE_VERSION} does not match tag ${GITHUB_REF_NAME}." >&2
exit 1
fi
- name: Verify version consistency
shell: bash
run: |
set -euo pipefail
PACKAGE_VERSION=$(uv version --short)
RUNTIME_VERSION=$(python -c 'from agentlightning import __version__; print(__version__)')
if [[ "${PACKAGE_VERSION}" != "${RUNTIME_VERSION}" ]]; then
echo "Package version ${PACKAGE_VERSION} does not match runtime version ${RUNTIME_VERSION}." >&2
exit 1
fi
- name: Sync test dependencies
run: uv sync --frozen --no-default-groups --extra dev --group dev
- name: Run tests
run: >-
uv run --locked --no-sync pytest -v --durations=20
tests/server
tests/controller
tests/test_package.py
tests/examples/test_swe_smith_images.py
- name: Build package
run: |
hatch build
run: uv build --no-sources
- name: Verify package contents
run: |
@@ -71,11 +68,4 @@ jobs:
python -m zipfile -l dist/*.whl
- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
- name: Test installation from PyPI
run: |
# Wait a bit for the package to be available
sleep 30
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ agentlightning
python -c "import agentlightning; print('Package installed successfully')"
uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+66
View File
@@ -0,0 +1,66 @@
name: Validate Agent Skills
permissions:
contents: read
on:
push:
branches: [main]
paths:
- 'skills/**'
- '.agents/skills/**'
- '.github/workflows/skills.yml'
pull_request:
branches: [main]
paths:
- 'skills/**'
- '.agents/skills/**'
- '.github/workflows/skills.yml'
workflow_dispatch:
jobs:
validate:
name: Validate Agent Skills and Claude plugin formats
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
- uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7.6.0
- name: Validate Agent Skills format
shell: bash
run: |
set -euo pipefail
# Published skills live in skills/ and repository-local agent skills in
# .agents/skills/. Both use the <root>/<name>/SKILL.md layout.
mapfile -t SKILLS < <(
find skills .agents/skills -mindepth 2 -maxdepth 2 -name SKILL.md -printf '%h\n' | sort
)
if [ "${#SKILLS[@]}" -eq 0 ]; then
echo "No SKILL.md found under skills/ or .agents/skills/." >&2
exit 1
fi
for SKILL in "${SKILLS[@]}"; do
echo "::group::${SKILL}"
uvx --from 'skills-ref==0.1.1' agentskills validate "${SKILL}"
echo "::endgroup::"
done
- uses: actions/setup-node@249970729cb0ef3589644e2896645e5dc5ba9c38 # v6.5.0
with:
node-version: '22'
- name: Validate Claude Code plugins
shell: bash
run: |
set -euo pipefail
mapfile -t PLUGINS < <(
find skills .agents/skills -mindepth 1 -maxdepth 1 -type d \
-exec test -f '{}/.claude-plugin/plugin.json' \; -print | sort
)
if [ "${#PLUGINS[@]}" -eq 0 ]; then
echo "No Claude Code plugin found under skills/ or .agents/skills/." >&2
exit 1
fi
for PLUGIN in "${PLUGINS[@]}"; do
echo "::group::${PLUGIN}"
npx --yes @anthropic-ai/claude-code@2.1.218 plugin validate "${PLUGIN}"
echo "::endgroup::"
done
+87 -69
View File
@@ -1,99 +1,117 @@
name: CPU Test
name: Test
permissions:
contents: read
on:
push:
branches: [ main ]
branches: [main]
pull_request:
branches: [ main ]
branches: [main]
workflow_dispatch:
schedule:
# Every day at noon and midnight
- cron: '0 0,12 * * *'
concurrency:
group: test-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
lint:
name: Lint with Black
name: Lint Python and repository files
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
with:
python-version: '3.12'
- name: Install dependencies
- uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7.6.0
with:
enable-cache: true
- name: Sync lint dependencies
run: uv sync --frozen --no-default-groups --extra dev --group dev
- name: Run pre-commit checks
run: uv run --locked --no-sync pre-commit run --all-files --show-diff-on-failure
- name: Run Ruff
run: uv run --locked --no-sync ruff check .
- name: Check Ruff formatting
run: uv run --locked --no-sync ruff format --check .
- name: Check Python headers
run: uv run --locked --no-sync python scripts/check_headers.py
typecheck:
name: Type-check Python
runs-on: ubuntu-latest
# Split from `lint` because the verl-cpu group pulls torch and friends.
# Pyright needs them to check agentlightning/verl and tests/verl; the fast
# checks above should not wait on that download.
timeout-minutes: 20
steps:
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
with:
python-version: '3.12'
- uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7.6.0
with:
enable-cache: true
- name: Sync type-check dependencies
run: uv sync --frozen --no-default-groups --extra dev --group dev --group verl-cpu
- name: Run Pyright
run: uv run --locked --no-sync pyright
test:
name: Run tests
runs-on: ubuntu-latest
# verl-cpu is needed for tests/verl; the rest of the suite only needs dev.
timeout-minutes: 20
steps:
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
with:
python-version: '3.12'
- uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7.6.0
with:
enable-cache: true
- name: Sync test dependencies
run: uv sync --frozen --no-default-groups --extra dev --group dev --group verl-cpu
- name: Run tests
run: uv run --locked --no-sync pytest -v --durations=20 tests
package:
name: Build package
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
with:
python-version: '3.12'
- uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7.6.0
with:
enable-cache: true
- name: Build package
run: uv build --no-sources
- name: Verify package contents
run: |
python -m pip install --upgrade pip
pip install -e .[dev]
- name: Run Black
run: |
black --check --diff --line-length=120 .
python -m tarfile -l dist/*.tar.gz
python -m zipfile -l dist/*.whl
docs:
name: Build documentation
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
with:
fetch-depth: 0
- uses: actions/setup-python@v4
- uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
with:
python-version: '3.12'
- name: Install documentation dependencies
run: |
./scripts/setup_stable.sh
- name: Set source commit for docs
run: |
echo "SOURCE_COMMIT=${{ github.sha }}" >> $GITHUB_ENV
- uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7.6.0
with:
enable-cache: true
- name: Sync documentation dependencies
run: uv sync --frozen --no-default-groups --group docs
- name: Build documentation
run: |
mkdocs build --strict
- name: Upload docs artifact
uses: actions/upload-artifact@v4
with:
name: documentation-site
path: site/
compression-level: 6
test:
strategy:
matrix:
include:
- python-version: '3.10'
setup-script: 'stable'
- python-version: '3.12'
setup-script: 'latest'
- python-version: '3.12'
setup-script: 'stable'
fail-fast: false
name: Test with Python ${{ matrix.python-version }} (${{ matrix.setup-script }})
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
./scripts/setup_${{ matrix.setup-script }}.sh
- name: Freeze dependencies
run: |
pip list | tee requirements-freeze-${{ matrix.python-version }}-${{ matrix.setup-script }}.txt
- name: Upload dependencies artifact
uses: actions/upload-artifact@v4
with:
name: dependencies-python-${{ matrix.python-version }}-${{ matrix.setup-script }}
path: requirements-freeze-${{ matrix.python-version }}-${{ matrix.setup-script }}.txt
compression-level: 0
- name: Run tests
run: |
pytest -v tests
env:
PYTEST_ADDOPTS: "--color=yes"
SOURCE_COMMIT: ${{ github.sha }}
run: uv run --locked --no-sync mkdocs build --strict
+108 -64
View File
@@ -1,15 +1,9 @@
# Agentlightning specific files
verl_old
meta-llama/**
debug/*.png
requirements-freeze*.txt
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
# Distribution / packaging
__pycache__/
*.py[codz]
*$py.class
*.so
# Distribution / packaging
@@ -33,11 +27,6 @@ share/python-wheels/
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
@@ -52,26 +41,29 @@ htmlcov/
nosetests.xml
coverage.xml
*.cover
*.py,cover
*.py.cover
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
# Django stuff
*.log
!examples/math-poc/reference_output.log
!examples/math-poc/reference_output_vllm.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
# Flask stuff
instance/
.webassets-cache
# Scrapy stuff:
# Scrapy stuff
.scrapy
# Sphinx documentation
@@ -83,46 +75,54 @@ target/
# Jupyter Notebook
.ipynb_checkpoints
.ipynb_checkpoints/
*.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that do not work, or not
# install all needed dependencies.
#Pipfile.lock
# UV
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
#uv.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
#poetry.toml
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
.pdm.toml
#pdm.toml
.pdm-python
.pdm-build/
# pixi
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
#pixi.lock
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one.
.pixi
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
@@ -133,14 +133,23 @@ celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
# Environments and local settings
.env
**/.env
.env.local
*.env.local
.envrc
.local/
.venv
.venv/
.venv.bak/
env/
venv/
ENV/
env.bak/
venv.bak/
.claude/
auto_docs/
# Spyder project settings
.spyderproject
@@ -152,52 +161,87 @@ venv.bak/
# mkdocs documentation
/site
# mypy
# mypy / pyright / pyre / pytype
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyright/
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# MacOS
.DS_Store
# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
# Abstra
# Abstra is an AI-powered process automation framework.
# Ignore directories containing user credentials, local state, and settings.
# Learn more at https://abstra.io/docs
.abstra/
# Visual Studio Code
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
# and can be added to the global gitignore or merged into this file. However, if you prefer,
# you could uncomment the following to ignore the enitre vscode folder
.vscode/
# Ruff stuff:
# Ruff stuff
.ruff_cache/
# PyPI configuration file
.pypirc
# Cursor
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
# refer to https://docs.cursor.com/context/ignore-files
# Cursor ignore files can contain local/sensitive context selection.
.cursorignore
.cursorindexingignore
# Marimo
marimo/_static/
marimo/_lsp/
__marimo__/
# Runtime logs and generated outputs
logs/
examples/*/logs/
.vscode/examples/math-poc/logs/
artifacts/
publicartifacts/
checkpoints/
wandb/
runs/
outputs/
mlruns/
*.ckpt
*.pt
*.pth
*.bin
*.safetensors
# Data not maintained in the repo
examples/calc_x/data/
!examples/calc_x/data/sample.jsonl
examples/calc_x/logs/
# Site/build output
site/
public/
# Archives / packaged artifacts
*.zip
*.tar
*.tar.gz
*.tgz
*.tar.bz2
*.tar.xz
*.7z
# Editor / OS
.vscode/
.idea/
.DS_Store
**/.DS_Store
*.swp
*.swo
*~
# Local example datasets
examples/**/*dataset*.jsonl
examples/**/subset*.jsonl
examples/**/verified_*.jsonl
# SWE-smith rollout stats
examples/swe_smith/rollout_stats.json
+14 -6
View File
@@ -1,8 +1,16 @@
exclude: ^(\.agents/|examples/llm-in-sandbox/vendor/)
repos:
- repo: https://github.com/psf/black
rev: 25.1.0
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0
hooks:
- id: black
pass_filenames: false
always_run: true
args: ["--line-length=120", "."]
- id: end-of-file-fixer
- id: trailing-whitespace
- id: check-yaml
exclude: ^(mkdocs\.yml|examples/calc_x/job-template\.yaml|examples/llm-in-sandbox/job-template\.yaml|examples/swe_smith/job-template-openai\.yaml)$
- id: check-toml
- id: check-added-large-files
args: ["--maxkb=1024"]
exclude: ^uv\.lock$
- id: check-shebang-scripts-are-executable
- id: detect-private-key
+1
View File
@@ -0,0 +1 @@
3.12
+1 -1
View File
@@ -16,4 +16,4 @@ 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.
THE SOFTWARE.
+99 -126
View File
@@ -1,158 +1,130 @@
![Agent-lightning-banner](docs/assets/readme-banner.png)
<p align="center">
<img src="docs/images/agl-v1.0.svg" alt="Agent Lightning v1.0" width="500">
</p>
# Agent Lightning⚡
<p align="center"><em>3,500-Line Lightweight Agentic RL Framework for Training Agents with Real Harnesses!</em></p>
[![CPU Test](https://github.com/microsoft/agent-lightning/actions/workflows/tests.yml/badge.svg)](https://github.com/microsoft/agent-lightning/actions/workflows/tests.yml)
[![GPU Test](https://github.com/microsoft/agent-lightning/actions/workflows/examples.yml/badge.svg)](https://github.com/microsoft/agent-lightning/actions/workflows/examples.yml)
[![PyPI version](https://badge.fury.io/py/agentlightning.svg)](https://badge.fury.io/py/agentlightning)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
<p align="center">
<a href="https://microsoft.github.io/agent-lightning/stable/">Documentation</a> &nbsp;·&nbsp; <a href="https://arxiv.org/pdf/2608.17528">Technical Report</a> &nbsp;·&nbsp; <a href="LICENSE">MIT License</a>
</p>
**The absolute trainer to light up AI agents.**
> Agent Lightning was completely refactored in v1.0. For legacy releases earlier than v1.0, see [this branch](https://github.com/microsoft/agent-lightning/tree/v0.x).
## ⚡ Core Features
## ⚡ Key Features
- Turn your agent into an optimizable beast with **ZERO CODE CHANGE** (almost)! 💤
- Build with **ANY** agent framework (LangChain, OpenAI Agent SDK, AutoGen, CrewAI, ...); or even WITHOUT agent framework (Python OpenAI). You name it! 🤖
- **Selectively** optimize one or more agents in a multi-agent system. 🎯
- Embraces Reinforcement Learning, Automatic Prompt Optimization and more **algorithms**. 🤗
- 🪶 **~3,500 lines of code:** We treat simplicity as the first principle.
- 🧩 **Train with real agent harnesses:** Agents interact with the model through the Agent Lightning v1.0 proxy with **ZERO changes**, while keeping tools, context, control flow, and environments in the loop.
- ☸️ **Native Kubernetes support:** Run agents directly as Kubernetes Jobs without relying on external sandbox services.
- 💻 **Full coding agent training example:** Using only **6K training samples**, an end-to-end Qwen3.5-9B workflow improves SWE-bench Verified from **41.8% to 56.4%**, a gain of **14.6 percentage points**. We release the full pipeline, including data cleaning, reward-hacking prevention, and training scripts.
![Agent-Lightning-code-diff](docs/assets/readme-diff.png)
## ⚡ Installation
## ⚡ Resources
The following is an example installation on a CUDA 13.0 machine:
```bash
cd <this-repo>
uv sync
bash scripts/setup_verl.sh 0.8.0 cu130
```
See the [Installation Guide](https://microsoft.github.io/agent-lightning/stable/00-installation/) for details.
## ⚡ Architecture
<p align="center">
<img src="docs/images/architecture.jpg" alt="Agent Lightning v1.0 architecture" width="800">
</p>
Agent Lightning v1.0 keeps the training architecture simple with three lightweight components:
- **Trainer:** Runs `verl` and vLLM, builds training samples, and updates the policy.
- **API Gateway:** Proxies model requests and captures training data.
- **Rollout Controller:** Runs agents locally or as Kubernetes Jobs.
The Trainer creates rollouts, the Controller launches agents, and the Gateway turns interactions into training data, while agents continue to run with their real harnesses.
## ⚡ Results
We evaluate Agent Lightning v1.0 across several practical training domains, including Search R1, LLM-in-Sandbox, and Coding Agent. Pure RL delivers substantial improvements across all three domains, as shown below.
<p align="center">
<img src="docs/images/benchmark-comparison.jpg" alt="Agent Lightning v1.0 benchmark comparison" width="600">
</p>
## ⚡ Documentation
| Section | Content |
|---------|---------|
| [Installation](https://microsoft.github.io/agent-lightning/stable/00-installation/) | Base environment and `verl` GPU stack |
| [Quick Start](https://microsoft.github.io/agent-lightning/stable/01-quick-start/) | Local first run and end-to-end flow |
| [Basics](https://microsoft.github.io/agent-lightning/stable/05-basics/) | Components, rollouts, events, and trajectories |
| [Trainer Configuration](https://microsoft.github.io/agent-lightning/stable/20-trainer-configuration/) | `verl` integration and trace aggregation |
| [API Gateway Configuration](https://microsoft.github.io/agent-lightning/stable/25-api-gateway-configuration/) | Gateway and model proxy settings |
| [Controller Configuration](https://microsoft.github.io/agent-lightning/stable/30-controller-configuration/) | Local and Kubernetes runners |
| [Asynchronous Training](https://microsoft.github.io/agent-lightning/stable/35-asynchronous-training/) | Collocated async collection and pause/drain |
## ⚡ Examples
| Example | Description |
|---|---|
| [Calc-X](https://microsoft.github.io/agent-lightning/stable/50-example-calc-x/) | POC math reasoning example with AutoGen and MCP calculator tools, requiring only one GPU. |
| [GSM8K](https://microsoft.github.io/agent-lightning/stable/55-example-gsm8k/) | POC grade-school math reasoning example. |
| [ScienceWorld](https://microsoft.github.io/agent-lightning/stable/60-example-science-world/) | Interactive science tasks in a text-based environment. |
| [Search-R1](https://microsoft.github.io/agent-lightning/stable/65-example-search-r1/) | Multi-turn retrieval and reasoning agent. |
| [LLM-in-Sandbox](https://microsoft.github.io/agent-lightning/stable/70-example-llm-in-sandbox/) | General agent with computer and code execution tools. |
| [Coding Agent](https://microsoft.github.io/agent-lightning/stable/75-example-coding-agent/) | Coding agent trained with repository tests. |
## ⚡ Articles
- 8/19/2026 [Agent Lightning v1.0: Towards Harnessed Agentic RL](https://arxiv.org/abs/2608.17528) technical report.
- 12/17/2025 [Adopting the Trajectory Level Aggregation for Faster Training](https://agent-lightning.github.io/posts/trajectory_level_aggregation/) Agent-lightning blog.
- 11/4/2025 [Tuning ANY AI agent with Tinker ✕ Agent-lightning](https://medium.com/@yugez/tuning-any-ai-agent-with-tinker-agent-lightning-part-1-1d8c9a397f0e) Medium. See also [Part 2](https://medium.com/@yugez/tuning-any-ai-agent-with-tinker-agent-lightning-part-2-332c5437f0dc).
- 10/22/2025 [No More Retokenization Drift: Returning Token IDs via the OpenAI Compatible API Matters in Agent RL](https://blog.vllm.ai/2025/10/22/agent-lightning.html) vLLM blog. See also [Zhihu writeup](https://zhuanlan.zhihu.com/p/1965067274642785725).
- 8/11/2025 [Training AI Agents to Write and Self-correct SQL with Reinforcement Learning](https://medium.com/@yugez/training-ai-agents-to-write-and-self-correct-sql-with-reinforcement-learning-571ed31281ad) Medium.
- 8/5/2025 [Agent Lightning: Train ANY AI Agents with Reinforcement Learning](https://arxiv.org/abs/2508.03680) arXiv paper.
- 7/26/2025 [We discovered an approach to train any AI agent with RL, with (almost) zero code changes.](https://www.reddit.com/r/LocalLLaMA/comments/1m9m670/we_discovered_an_approach_to_train_any_ai_agent/) Reddit.
- 6/6/2025 [Agent Lightning - Microsoft Research](https://www.microsoft.com/en-us/research/project/agent-lightning/) Project page.
## ⚡ Installation
## ⚡ Community Projects
First, let's get your environment set up. We'll be using `/path/to/agentlightning` to refer to the directory containing this README file.
### 1. Set Up Your Environment
We strongly recommend creating a new virtual environment to avoid conflicts with other packages. You can use either `conda` or `venv`. **Python 3.10 or later** is recommended.
### 2. Install Core Training Dependencies (Optional)
If you are running RL with Agent-Lightning, the next step is to install the essential packages: `PyTorch`, `FlashAttention`, `vLLM` and `VERL`. The following versions and installation order have been tested and are confirmed to work.
```bash
pip install torch==2.7.0 torchvision==0.22.0 torchaudio==2.7.0 --index-url https://download.pytorch.org/whl/cu128
pip install flash-attn --no-build-isolation
pip install vllm==0.9.2
pip install verl==0.5.0
```
See `scripts/setup_stable_gpu.sh` for a full installation script.
### 3. Install Agent Lightning
Now, you're ready to install Agent Lightning itself.
```bash
pip install agentlightning
```
### 4. Install Agent Frameworks (Optional)
If you plan to use other agent frameworks, you can install them with the following commands. If you don't need these, feel free to skip this step.
We recommend doing this as the final step to avoid dependency versions being overwritten by mistake.
```bash
# AutoGen (Recommended to install first)
pip install "autogen-agentchat" "autogen-ext[openai]"
# LiteLLM
pip install "litellm[proxy]"
# MCP
pip install mcp
# UV
pip install uv
# OpenAI Agents
pip install openai-agents
# LangChain
pip install langgraph "langchain[openai]" langchain-community langchain-text-splitters
# SQL-related dependencies
pip install sqlparse nltk
```
Don't worry if dependency conflicts arise during this step. Follow the installation order above and the conflicts generally do not matter.
## ⚡ Examples
For more detailed examples, please see the `examples` folder:
1. [calc_x](examples/calc_x): An agent built with AutoGen with calculator tool use, trained on Calc-X dataset with Reinforcement Learning.
2. [spider](examples/spider): A write-check-rewrite looped agent with LangGraph with SQL execution; selectively optimize write and rewrite on Spider dataset with Reinforcement Learning.
3. [apo](examples/apo): An example to customize an optimization algorithm: Automatic Prompt Optimization.
## ⚡ Important Caveats
1. **AgentOps Integration**: Agent Lightning uses [AgentOps](https://github.com/AgentOps-AI/agentops) for agent tracking by default. If you're already using AgentOps in your own code, you'll need to disable our managed AgentOps client by modifying the `tracer` parameter of trainer.
2. **Debugging Traces**: If you encounter issues with tracing, you can visualize the trace tree using `tracer.last_trace().visualize("tree_graph")`. Please note that this API is experimental and may change in future releases.
3. **Launching the Server and Agents**: Currently, the training server and agent clients must be launched in separate processes. You can open two terminal windows or run one of them in the background. The launching order generally doesn't matter.
4. **Environment Variables**: The environment variables and working directory at the time of `ray init` are important. If you run into "file not found" errors, try restarting Ray from your current working directory.
5. **Handling Timeouts**: The training server may hang if samples fail or time out on the agent side. To prevent this, we recommend setting limits on the prompt and response lengths, as this is the most common cause of failures.
6. **VERL Failures**: Save checkpoints frequently, as VERL with vLLM may sometimes experience out-of-memory issues. If you encounter a VERL failure, you can resume training from the last checkpoint.
## ⚡ Architecture
Currently, Agent Lightning is built around a **training server** and one or multiple **agents**.
* The **server** manages the training data, prepares samples for the agents, and provides the LLM endpoint.
* **Agents** retrieve samples from the server, process them (which may involve interacting with the LLM), and send the results back. These results, or "trajectories," are lists of prompts and responses from the LLM.
* The **server** then collects these trajectories and computes the losses to optimize the language models.
![Agent-Lightning-architecture](docs/assets/readme-architecture.png)
## ⚡ Development Instructions
Install with development dependencies:
```
git clone https://github.com/microsoft/agent-lightning
cd agent-lightning
pip install -e .[dev]
```
Please run pre-commit hooks before checking in code:
```
pre-commit install
pre-commit run --all-files --show-diff-on-failure --color=always
```
Serve documentation locally:
```bash
mkdocs serve
```
- [DeepWerewolf](https://github.com/af-74413592/DeepWerewolf) — A case study of agent RL training for the Chinese Werewolf game built with AgentScope and Agent Lightning.
- [AgentFlow](https://agentflow.stanford.edu/) — A modular multi-agent framework that combines planner, executor, verifier, and generator agents with the Flow-GRPO algorithm to tackle long-horizon, sparse-reward tasks.
- [Youtu-Agent](https://github.com/TencentCloudADP/Youtu-agent) — Youtu-Agent lets you build and train your agent with ease. Built with [a modified branch](https://github.com/microsoft/agent-lightning/tree/contrib/youtu-agent-lightning) of Agent Lightning, Youtu-Agent has verified up to 128 GPUs RL training on maths/code and search capabilities with steady convergence. Also check [the recipe](https://github.com/TencentCloudADP/youtu-agent/tree/rl/agl) and their blog [*Stop Wrestling with Your Agent RL: How Youtu-Agent Achieved Stable, 128-GPU Scaling Without Breaking a Sweat*](https://spotted-coconut-df8.notion.site/Stop-Wrestling-with-Your-Agent-RL-How-Youtu-Agent-Achieved-Stable-128-GPU-Scaling-Without-Breaking-2ca5e8f089ba80539a98c582b65e0233).
## ⚡ Citation
If you find Agent Lightning useful in your research or projects, please cite our paper:
If you use Agent Lightning v1.0 in your research or projects, please cite the technical report:
```bibtex
@misc{he2026agentlightningv10harnessed,
title={Agent Lightning v1.0: Towards Harnessed Agentic RL},
author={Zhiyuan He and Siwei Zhang and Zhiwen Zhou and Yuqing Yang and Yu Kang and Yuge Zhang and Luna K. Qiu and Tin Yan Tsui and Jiahang Xu and Chong Luo},
year={2026},
eprint={2608.17528},
archivePrefix={arXiv},
primaryClass={cs.AI},
url={https://arxiv.org/abs/2608.17528},
}
```
For the original Agent Lightning paper, please use:
```bibtex
@misc{luo2025agentlightningtrainai,
title={Agent Lightning: Train ANY AI Agents with Reinforcement Learning},
title={Agent Lightning: Train ANY AI Agents with Reinforcement Learning},
author={Xufang Luo and Yuge Zhang and Zhiyuan He and Zilong Wang and Siyun Zhao and Dongsheng Li and Luna K. Qiu and Yuqing Yang},
year={2025},
eprint={2508.03680},
archivePrefix={arXiv},
primaryClass={cs.AI},
url={https://arxiv.org/abs/2508.03680},
url={https://arxiv.org/abs/2508.03680},
}
```
## ⚡ Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
This project welcomes contributions and suggestions. Start by reading the [Contributing Guide](docs/community/contributing.md) for recommended contribution points, environment setup, branching conventions, and pull request expectations. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
@@ -166,6 +138,7 @@ This project may contain trademarks or logos for projects, products, or services
This project has been evaluated and certified to comply with the Microsoft Responsible AI Standard. The team will continue to monitor and maintain the repository, addressing any severe issues, including potential harms, if they arise.
## ⚡ License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
Agent Lightning v1.0 is released under the [MIT License](LICENSE).
+1 -1
View File
@@ -11,4 +11,4 @@ For security reporting information, locations, contact information, and policies
please review the latest guidance for Microsoft repositories at
[https://aka.ms/SECURITY.md](https://aka.ms/SECURITY.md).
<!-- END MICROSOFT SECURITY.MD BLOCK -->
<!-- END MICROSOFT SECURITY.MD BLOCK -->
+4 -9
View File
@@ -1,10 +1,5 @@
__version__ = "0.1.2"
# Copyright (c) Microsoft. All rights reserved.
from .client import AgentLightningClient, DevTaskLoader
from .config import lightning_cli
from .litagent import LitAgent
from .logging import configure_logger
from .reward import reward
from .server import AgentLightningServer
from .trainer import Trainer
from .types import *
"""Agent Lightning."""
__version__ = "1.0.1"
-20
View File
@@ -1,20 +0,0 @@
import time
from agentlightning.instrumentation.agentops import AgentOpsServerManager
if __name__ == "__main__":
import argparse
parser = argparse.ArgumentParser(description="Start AgentOps server")
parser.add_argument("--daemon", action="store_true", help="Run server as a daemon")
parser.add_argument("--port", type=int, default=8002, help="Port to run the server on")
args = parser.parse_args()
manager = AgentOpsServerManager(daemon=args.daemon, port=args.port)
try:
manager.start()
# Wait forever
while True:
time.sleep(1)
except KeyboardInterrupt:
manager.stop()
-10
View File
@@ -1,10 +0,0 @@
from typing import List
from vllm.entrypoints.cli.main import main
from agentlightning.instrumentation.vllm import instrument_vllm
if __name__ == "__main__":
instrument_vllm()
main()
+70 -353
View File
@@ -1,365 +1,82 @@
import asyncio
import logging
# Copyright (c) Microsoft. All rights reserved.
"""Thin httpx clients for Agent Lightning."""
from __future__ import annotations
import time
import urllib.parse
from typing import Any, Dict, Optional, List, Union
from typing import Any
import aiohttp
import requests
from .types import Rollout, Task, TaskInput, TaskIfAny, ResourcesUpdate, NamedResources
import httpx
logger = logging.getLogger(__name__)
def _headers_with_key(headers: httpx.Headers | dict[str, str] | None, key: str | None) -> dict[str, str]:
merged = dict(headers or {})
if key:
merged["Authorization"] = f"Bearer {key}"
return merged
class AgentLightningClient:
"""
Client for interacting with a version-aware Agent Lightning Server.
This client handles polling for tasks, fetching specific versions of resources
(like model configurations), and posting completed rollouts back to the server.
It provides both synchronous and asynchronous methods for these operations and
includes a cache for resources.
"""
_next_task_uri = "/task"
_resources_uri = "/resources"
_latest_resources_uri = "/resources/latest"
_report_rollout_uri = "/rollout"
def __init__(self, endpoint: str, poll_interval: float = 5.0, timeout: float = 10.0):
"""Initializes the AgentLightningClient.
Args:
endpoint: The root URL of the Agent Lightning server.
poll_interval: The interval in seconds to wait between polling for new tasks.
timeout: The timeout in seconds for HTTP requests.
"""
self.endpoint = endpoint
self.task_count = 0
self.poll_interval = poll_interval
self.timeout = timeout
self._resource_cache: Dict[str, ResourcesUpdate] = {} # TODO: mechanism to evict cache
self._default_headers = {"X-AgentLightning-Client": "true"}
async def _request_json_async(self, url: str) -> Optional[Dict[str, Any]]:
"""Makes an async GET request to the specified URL and returns the JSON response.
Args:
url: The URL to request.
Returns:
The JSON response as a dictionary or None if the request fails.
"""
timeout = aiohttp.ClientTimeout(total=self.timeout)
async with aiohttp.ClientSession(timeout=timeout) as session:
try:
async with session.get(url, headers=self._default_headers) as resp:
resp.raise_for_status()
return await resp.json()
except Exception as e:
logger.debug(f"Async GET request failed for {url}: {e}")
return None
async def _post_json_async(self, url: str, payload: Dict[str, Any]) -> Optional[Dict[str, Any]]:
"""Makes an async POST request with a JSON payload.
Args:
url: The URL to post to.
payload: The dictionary data to send as JSON.
Returns:
The JSON response as a dictionary or None if the request fails.
"""
timeout = aiohttp.ClientTimeout(total=self.timeout)
async with aiohttp.ClientSession(timeout=timeout) as session:
try:
async with session.post(url, json=payload, headers=self._default_headers) as resp:
resp.raise_for_status()
return await resp.json()
except Exception as e:
logger.debug(f"Async POST request failed for {url}: {e}")
return None
async def poll_next_task_async(self) -> Task:
"""Polls the server asynchronously for the next task until one is available.
Returns:
A Task object containing the task details.
"""
url = urllib.parse.urljoin(self.endpoint, self._next_task_uri)
while True:
response = await self._request_json_async(url)
if response:
task_if_any = TaskIfAny.model_validate(response)
if task_if_any.is_available and task_if_any.task:
self.task_count += 1
logger.info(f"[Task {self.task_count} Received] ID: {task_if_any.task.rollout_id}")
return task_if_any.task
logger.debug(f"No task available yet. Retrying in {self.poll_interval} seconds...")
await asyncio.sleep(self.poll_interval)
async def get_resources_by_id_async(self, resource_id: str) -> Optional[ResourcesUpdate]:
"""Fetches a specific version of resources by its ID, using a cache.
Args:
resource_id: The ID of the resources to fetch, usually from a Task's metadata.
Returns:
A ResourcesUpdate object containing the versioned resources, or None if not found.
"""
if resource_id in self._resource_cache:
logger.debug(f"Found resources '{resource_id}' in cache.")
return self._resource_cache[resource_id]
url = urllib.parse.urljoin(self.endpoint, f"{self._resources_uri}/{resource_id}")
response = await self._request_json_async(url)
if response:
resources_update = ResourcesUpdate.model_validate(response)
self._resource_cache[resource_id] = resources_update
logger.info(f"Fetched and cached resources for ID: {resource_id}")
return resources_update
return None
async def get_latest_resources_async(self) -> Optional[ResourcesUpdate]:
"""Fetches the latest available resources from the server.
Returns:
A ResourcesUpdate object containing the latest resources.
"""
url = urllib.parse.urljoin(self.endpoint, self._latest_resources_uri)
response = await self._request_json_async(url)
if response:
resources_update = ResourcesUpdate.model_validate(response)
# Cache this result as well
self._resource_cache[resources_update.resources_id] = resources_update
return resources_update
return None
async def post_rollout_async(self, rollout: Rollout) -> Optional[Dict[str, Any]]:
"""Posts a completed rollout to the server asynchronously.
Args:
rollout: A Rollout object containing the results of a task.
Returns:
The server's JSON response as a dictionary.
"""
url = urllib.parse.urljoin(self.endpoint, self._report_rollout_uri)
payload = rollout.model_dump(mode="json")
return await self._post_json_async(url, payload)
def _request_json(self, url: str) -> Optional[Dict[str, Any]]:
"""Makes a sync GET request to the specified URL and returns the JSON response.
Args:
url: The URL to request.
Returns:
The JSON response as a dictionary or None if the request fails.
"""
try:
response = requests.get(url, timeout=self.timeout, headers=self._default_headers)
response.raise_for_status()
return response.json()
except requests.exceptions.RequestException as e:
logger.debug(f"Sync GET request failed for {url}: {e}")
return None
def _post_json(self, url: str, payload: Dict[str, Any]) -> Optional[Dict[str, Any]]:
"""Makes a sync POST request with a JSON payload.
Args:
url: The URL to post to.
payload: The dictionary data to send as JSON.
Returns:
The JSON response as a dictionary or None if the request fails.
"""
try:
response = requests.post(url, json=payload, timeout=self.timeout, headers=self._default_headers)
response.raise_for_status()
return response.json()
except requests.exceptions.RequestException as e:
logger.debug(f"Sync POST request failed for {url}: {e}")
return None
def poll_next_task(self) -> Task:
"""Polls the server synchronously for the next task until one is available.
Returns:
A Task object containing the task details, including the required `resources_id`.
"""
url = urllib.parse.urljoin(self.endpoint, self._next_task_uri)
while True:
response = self._request_json(url)
if response:
task_if_any = TaskIfAny.model_validate(response)
if task_if_any.is_available and task_if_any.task:
self.task_count += 1
logger.info(f"[Task {self.task_count} Received] ID: {task_if_any.task.rollout_id}")
return task_if_any.task
logger.debug(f"No task available yet. Retrying in {self.poll_interval} seconds...")
time.sleep(self.poll_interval)
def get_resources_by_id(self, resource_id: str) -> Optional[ResourcesUpdate]:
"""Fetches a specific version of resources by its ID synchronously, using a cache.
Args:
resource_id: The ID of the resources to fetch, usually from a Task's metadata.
Returns:
A ResourcesUpdate object containing the versioned resources, or None if not found.
"""
if resource_id in self._resource_cache:
logger.debug(f"Found resources '{resource_id}' in cache.")
return self._resource_cache[resource_id]
url = urllib.parse.urljoin(self.endpoint, f"{self._resources_uri}/{resource_id}")
response = self._request_json(url)
if response:
resources_update = ResourcesUpdate.model_validate(response)
self._resource_cache[resource_id] = resources_update
logger.info(f"Fetched and cached resources for ID: {resource_id}")
return resources_update
return None
def get_latest_resources(self) -> Optional[ResourcesUpdate]:
"""Fetches the latest available resources from the server synchronously.
Returns:
A ResourcesUpdate object containing the latest resources.
"""
url = urllib.parse.urljoin(self.endpoint, self._latest_resources_uri)
response = self._request_json(url)
if response:
resources_update = ResourcesUpdate.model_validate(response)
self._resource_cache[resources_update.resources_id] = resources_update
return resources_update
return None
def post_rollout(self, rollout: Rollout) -> Optional[Dict[str, Any]]:
"""Posts a completed rollout to the server synchronously.
Args:
rollout: A Rollout object containing the results of a task.
Returns:
The server's JSON response as a dictionary.
"""
url = urllib.parse.urljoin(self.endpoint, self._report_rollout_uri)
payload = rollout.model_dump(mode="json")
return self._post_json(url, payload)
class DevTaskLoader(AgentLightningClient):
"""A local task manager for development that provides sample tasks and resources.
This client mocks the server APIs by maintaining a local queue of tasks and resources
within the same process. It's designed for development, testing, and scenarios where
a full Agent Lightning server is not needed.
The DevTaskLoader overrides the polling and resource fetching methods to return data
from local collections instead of making HTTP requests to a remote server.
"""
class AgentLightningAsyncClient(httpx.AsyncClient):
"""Async httpx client with optional bearer key."""
def __init__(
self,
tasks: Union[List[TaskInput], List[Task]],
resources: Union[NamedResources, ResourcesUpdate],
*,
key: str | None = None,
headers: httpx.Headers | dict[str, str] | None = None,
**kwargs: Any,
):
"""Initializes the DevTaskLoader with pre-defined tasks and resources.
) -> None:
super().__init__(
headers=_headers_with_key(headers, key),
**kwargs,
)
Args:
tasks: Either a List of TaskInput objects or a List of Task objects.
resources: Either NamedResources or ResourcesUpdate object.
**kwargs: Additional arguments passed to the parent AgentLightningClient.
class AgentLightningSyncClient(httpx.Client):
"""Sync httpx client with optional bearer key."""
def __init__(
self,
*,
key: str | None = None,
headers: httpx.Headers | dict[str, str] | None = None,
max_retries: int = 10,
**kwargs: Any,
) -> None:
self.max_retries = max_retries
super().__init__(
headers=_headers_with_key(headers, key),
**kwargs,
)
def get(self, *args: Any, **kwargs: Any) -> httpx.Response: # type: ignore[override]
last_exc: Exception | None = None
for attempt in range(self.max_retries + 1):
try:
return super().get(*args, **kwargs)
except Exception as exc:
last_exc = exc
print(f"GET failed (attempt {attempt + 1}/{self.max_retries + 1}): {exc}")
assert last_exc is not None
raise last_exc
def post_with_retry(self, *args: Any, **kwargs: Any) -> httpx.Response:
"""POST with retry + backoff, raising on non-2xx. Only for idempotent endpoints.
Retries both transport errors and error status codes, so a transient 5xx
is retried too. Callers get an already status-checked response back.
"""
super().__init__(endpoint="local://", **kwargs)
self._tasks = tasks.copy()
if len(self._tasks) == 0:
raise ValueError("DevTaskLoader requires at least one task to be provided.")
# Check if tasks are mixture of TaskInput and Task
if any(isinstance(task, Task) for task in self._tasks):
if not all(isinstance(task, Task) for task in self._tasks):
raise ValueError("All tasks must be either Task or TaskInput objects.")
self._task_index = 0
if isinstance(resources, ResourcesUpdate):
self._resources_update = resources
else:
self._resources_update = ResourcesUpdate(resources_id="local", resources=resources)
# Store rollouts posted back to the loader for easy debugging of local runs
self._rollouts: List[Rollout] = []
@property
def rollouts(self) -> List[Rollout]:
"""Return rollouts that have been posted back to the loader."""
return self._rollouts
def poll_next_task(self) -> Task:
"""Returns the next task from the local queue.
If tasks are TaskInput objects, assembles them into Task objects.
If tasks are already Task objects, returns them directly.
Returns:
The next Task object from the local task list.
"""
if self._task_index >= len(self._tasks):
self._task_index = 0
task_or_input = self._tasks[self._task_index]
if isinstance(task_or_input, Task):
task = task_or_input
else:
rollout_id = f"local_task_{self._task_index + 1:03d}"
task = Task(
rollout_id=rollout_id,
input=task_or_input,
resources_id=self._resources_update.resources_id,
create_time=time.time(),
)
self._task_index += 1
self.task_count += 1
logger.info(f"[Task {self.task_count} Received] Task ID: {task.rollout_id}")
return task
def get_resources_by_id(self, resource_id: str) -> Optional[ResourcesUpdate]:
logger.debug(f"DevTaskLoader checking resources for ID: {resource_id}")
if resource_id != self._resources_update.resources_id:
raise ValueError(
f"Resource ID '{resource_id}' not found. Only '{self._resources_update.resources_id}' is available."
)
return self._resources_update
def get_latest_resources(self) -> Optional[ResourcesUpdate]:
logger.debug("DevTaskLoader returning latest resources.")
return self._resources_update
def post_rollout(self, rollout: Rollout) -> Optional[Dict[str, Any]]:
logger.debug(f"DevTaskLoader received rollout for task: {rollout.rollout_id}")
self._rollouts.append(rollout)
return {"status": "received", "rollout_id": rollout.rollout_id}
async def poll_next_task_async(self) -> Task:
return self.poll_next_task()
async def get_resources_by_id_async(self, resource_id: str) -> Optional[ResourcesUpdate]:
return self.get_resources_by_id(resource_id)
async def get_latest_resources_async(self) -> Optional[ResourcesUpdate]:
return self.get_latest_resources()
async def post_rollout_async(self, rollout: Rollout) -> Optional[Dict[str, Any]]:
return self.post_rollout(rollout)
def __repr__(self):
return f"DevTaskLoader(num_tasks={len(self._tasks)}, resources={self._resources_update.resources})"
last_exc: Exception | None = None
for attempt in range(self.max_retries + 1):
try:
response = super().post(*args, **kwargs)
response.raise_for_status()
return response
except Exception as exc:
last_exc = exc
print(f"POST failed (attempt {attempt + 1}/{self.max_retries + 1}): {exc}")
if attempt < self.max_retries:
time.sleep(min(2 ** (attempt + 1), 30))
assert last_exc is not None
raise last_exc
-336
View File
@@ -1,336 +0,0 @@
"""
This file is not carefully reviewed.
It might contain unintentional bugs and issues.
Please always review the parsed construction arguments before using them.
"""
from __future__ import annotations
import argparse
import inspect
import logging
from typing import (
Any,
List,
Type,
TypeVar,
Union,
_GenericAlias, # type: ignore
get_origin,
get_args,
Tuple,
Callable,
overload,
Dict,
get_type_hints,
)
CliConfigurable = Any
logger = logging.getLogger(__name__)
# TypeVars for precise return type hinting with overloads
_C = TypeVar("_C", bound=CliConfigurable)
_C1 = TypeVar("_C1", bound=CliConfigurable)
_C2 = TypeVar("_C2", bound=CliConfigurable)
_C3 = TypeVar("_C3", bound=CliConfigurable)
_C4 = TypeVar("_C4", bound=CliConfigurable)
# Custom type for CLI arguments that can be string or None
def nullable_str(value: str) -> str | None:
"""Converts specific string values (case-insensitive) to None, otherwise returns the string."""
if value.lower() in ["none", "null", "~", "nil"]: # Define keywords for None
return None
return value
def nullable_int(value: str) -> int | None:
"""Converts specific string values (case-insensitive) to None, otherwise returns the integer."""
if value.lower() in ["none", "null", "~", "nil"]: # Define keywords for None
return None
try:
return int(value)
except ValueError:
raise argparse.ArgumentTypeError(f"Invalid integer value: '{value}'")
def nullable_float(value: str) -> float | None:
"""Converts specific string values (case-insensitive) to None, otherwise returns the float."""
if value.lower() in ["none", "null", "~", "nil"]: # Define keywords for None
return None
try:
return float(value)
except ValueError:
raise argparse.ArgumentTypeError(f"Invalid float value: '{value}'")
def _str_to_bool(v: str) -> bool:
"""Converts common string representations of bool to Python bool (case-insensitive)."""
if isinstance(v, bool): # Allow passing bools directly if used programmatically
return v
lowered_v = v.lower()
if lowered_v in ("yes", "true", "t", "y", "1"):
return True
elif lowered_v in ("no", "false", "f", "n", "0"):
return False
else:
raise argparse.ArgumentTypeError(f"Boolean value expected (e.g., 'true', 'false', 'yes', 'no'), got '{v}'")
def _get_param_type_details(param_annotation: Any) -> Tuple[Any, bool, bool]:
"""
Determines the core type, if it's Optional, and if it's a List.
Returns: (core_type, is_optional, is_list)
- For Optional[T]: (T, True, is_list_status_of_T)
- For List[T]: (List[T], is_optional_status_of_List, True)
- For Optional[List[T]]: (List[T], True, True)
"""
is_optional = False
is_list = False
current_type = param_annotation
# Check for outer Optional
origin = get_origin(current_type)
if origin is Union:
union_args = get_args(current_type)
if len(union_args) == 2 and type(None) in union_args:
is_optional = True
current_type = next(arg for arg in union_args if arg is not type(None)) # Unwrap Optional
# Check if the (potentially unwrapped) type is a List
origin = get_origin(current_type) # Re-check origin after potential unwrap
if origin is list or (isinstance(current_type, _GenericAlias) and current_type.__origin__ is list):
is_list = True
return current_type, is_optional, is_list
def _determine_argparse_type(param_type: Any) -> Callable[[str], Any]:
"""Determines the type for argparse based on parameter type details."""
core_type, is_optional, _ = _get_param_type_details(param_type)
if core_type is str and is_optional:
return nullable_str # Special handling for Optional[str]
elif core_type is int and is_optional:
return nullable_int
elif core_type is float and is_optional:
return nullable_float
elif core_type is bool:
return _str_to_bool # Special handling for bool
elif core_type in (int, float, str):
return core_type
return str # Default to str if no specific type is provided (including empty)
def _determine_argparse_type_and_nargs(
core_param_type: Any, is_param_list: bool # The type after unwrapping an outer Optional
) -> Dict[str, Any]:
"""Determines the 'type' and 'nargs' for argparse based on parameter type details."""
kwargs: Dict[str, Any] = {}
if is_param_list:
kwargs["nargs"] = "*" # Allows zero or more arguments for lists
list_item_annotations = get_args(core_param_type) # For List[T], core_param_type is List[T]
if list_item_annotations and list_item_annotations[0] is not Any:
item_ann = list_item_annotations[0]
# Check if the list item itself is, e.g., Optional[str] or bool
kwargs["type"] = _determine_argparse_type(item_ann)
else:
kwargs["type"] = str
else: # Not a list
kwargs["type"] = _determine_argparse_type(core_param_type)
return kwargs
def _build_help_string(cls_name: str, param_name: str, core_type: Any, is_optional: bool, is_list: bool) -> str:
"""Constructs a descriptive help string for a CLI argument."""
type_display_name = "Any"
if core_type is not inspect.Parameter.empty:
type_display_name = getattr(core_type, "__name__", str(core_type))
if is_list:
list_item_args = get_args(core_type) # core_type is List[T] here
item_name = "Any"
if list_item_args and list_item_args[0] is not Any:
inner_item_core_type, inner_item_optional, _ = _get_param_type_details(list_item_args[0])
item_name = getattr(inner_item_core_type, "__name__", str(inner_item_core_type))
if inner_item_optional: # e.g. List[Optional[str]]
item_name = f"Optional[{item_name}]"
type_display_name = f"List[{item_name}]"
full_type_display = f"Optional[{type_display_name}]" if is_optional and not is_list else type_display_name
if is_optional and is_list: # e.g. Optional[List[str]]
full_type_display = f"Optional[{type_display_name}]"
help_str = f"For {cls_name}: '{param_name}'. Inferred type: {full_type_display}."
return help_str
def _add_argument_for_parameter(
parser: argparse.ArgumentParser,
cls: Type[CliConfigurable],
param_name: str,
param_obj: inspect.Parameter,
dest_name: str,
resolved_param_annotation: Any = None,
) -> None:
"""Configures and adds a single CLI argument for an __init__ parameter."""
if resolved_param_annotation is None:
param_type_annotation = param_obj.annotation
else:
param_type_annotation = resolved_param_annotation
# core_type is the main type (e.g., int, str, List[str]), after unwrapping the outermost Optional.
# is_overall_optional indicates if the parameter itself can be None (e.g. param: Optional[T] = None)
# is_list indicates if core_type is a List.
core_type, is_overall_optional, is_list = _get_param_type_details(param_type_annotation)
has_init_default = param_obj.default is not inspect.Parameter.empty
init_default_value = param_obj.default if has_init_default else None
argparse_kwargs = _determine_argparse_type_and_nargs(core_type if is_list else param_type_annotation, is_list)
if has_init_default:
argparse_kwargs["default"] = init_default_value
elif is_overall_optional: # Parameter is Optional (e.g. Optional[int]) and no explicit default in __init__
argparse_kwargs["default"] = None # So, if not provided on CLI, it becomes None.
argparse_kwargs["help"] = _build_help_string(cls.__name__, param_name, core_type, is_overall_optional, is_list)
if not has_init_default and not is_overall_optional: # Required if no __init__ default AND not Optional
argparse_kwargs["required"] = True
if "default" in argparse_kwargs: # Should not happen if logic is correct
del argparse_kwargs["default"]
cli_arg_name = f"--{cls.__name__.lower()}.{param_name.replace('_', '-')}"
parser.add_argument(cli_arg_name, dest=dest_name, **argparse_kwargs)
def _add_arguments_for_class(
parser: argparse.ArgumentParser,
cls: Type[CliConfigurable],
class_arg_configs_maps: Dict[Type[CliConfigurable], Dict[str, str]], # Maps cls to {param_name: dest_name}
) -> None:
"""Adds all relevant CLI arguments for a given class by processing its __init__ parameters."""
cls_name_lower = cls.__name__.lower()
sig = inspect.signature(cls.__init__)
try:
# Resolve string annotations to actual types using get_type_hints.
# For methods, get_type_hints automatically uses obj.__globals__ for globalns.
resolved_hints = get_type_hints(cls.__init__)
except Exception as e:
logger.warning(
f"Could not resolve type hints for {cls.__name__}.__init__ using get_type_hints: {e}. "
f"CLI argument parsing for this class might be based on string annotations, "
"which could be unreliable for complex types."
)
resolved_hints = {} # Fallback to an empty dict if resolution fails
if cls not in class_arg_configs_maps: # Ensure the class entry exists
class_arg_configs_maps[cls] = {}
for param_name, param_obj in sig.parameters.items():
if param_name == "self": # Skip 'self'
continue
dest_name = f"{cls_name_lower}_{param_name}" # Unique destination for argparse
class_arg_configs_maps[cls][param_name] = dest_name # Store mapping for later instantiation
# Use the resolved hint if available, otherwise fallback to param_obj.annotation (which might be a string)
actual_param_annotation = resolved_hints.get(param_name, param_obj.annotation)
_add_argument_for_parameter(parser, cls, param_name, param_obj, dest_name, actual_param_annotation)
def _create_argument_parser() -> argparse.ArgumentParser:
"""Creates and returns the main ArgumentParser with default settings."""
return argparse.ArgumentParser(
description="CLI configurator for application components.",
formatter_class=argparse.ArgumentDefaultsHelpFormatter, # Automatically shows default values in help
)
def _instantiate_classes(
parsed_args: argparse.Namespace,
classes: Tuple[Type[CliConfigurable], ...],
class_arg_configs_maps: Dict[Type[CliConfigurable], Dict[str, str]],
) -> Tuple[CliConfigurable, ...]:
"""Instantiates classes using the parsed CLI arguments and the stored mappings."""
instances_list: List[CliConfigurable] = []
for cls in classes:
constructor_args: Dict[str, Any] = {}
# Get the {__init__ param_name: argparse_dest_name} map for the current class
param_to_dest_map = class_arg_configs_maps.get(cls, {})
sig = inspect.signature(cls.__init__)
for param_name_in_sig, _ in sig.parameters.items():
if param_name_in_sig == "self":
continue
dest_name_for_arg = param_to_dest_map.get(param_name_in_sig)
if dest_name_for_arg and hasattr(parsed_args, dest_name_for_arg):
value = getattr(parsed_args, dest_name_for_arg)
constructor_args[param_name_in_sig] = value
# If an argument was required by argparse, parse_args() would have exited if missing.
# If not required and not provided, its default value (set by argparse) is used.
try:
logger.info("Instantiating %s with args: %s", cls.__name__, constructor_args)
instances_list.append(cls(**constructor_args))
except Exception as e:
parsed_args_for_cls = {
k: getattr(parsed_args, v) for k, v in param_to_dest_map.items() if hasattr(parsed_args, v)
}
logger.error(
f"Error instantiating {cls.__name__} with resolved args {constructor_args}. "
f"Parsed args for class: "
f"{parsed_args_for_cls}. "
f"Error: {e}"
)
raise
return tuple(instances_list)
@overload
def lightning_cli(cls1: Type[_C1]) -> _C1: ...
@overload
def lightning_cli(cls1: Type[_C1], cls2: Type[_C2]) -> Tuple[_C1, _C2]: ...
@overload
def lightning_cli(cls1: Type[_C1], cls2: Type[_C2], cls3: Type[_C3]) -> Tuple[_C1, _C2, _C3]: ...
@overload
def lightning_cli(cls1: Type[_C1], cls2: Type[_C2], cls3: Type[_C3], cls4: Type[_C4]) -> Tuple[_C1, _C2, _C3, _C4]: ...
@overload # Fallback for more than 4 or a dynamic number of classes
def lightning_cli(*classes: Type[CliConfigurable]) -> Tuple[CliConfigurable, ...]: ...
def lightning_cli(*classes: Type[CliConfigurable]) -> CliConfigurable | Tuple[CliConfigurable, ...]:
"""
Parses command-line arguments to configure and instantiate provided CliConfigurable classes.
Args:
*classes: One or more classes that inherit from CliConfigurable. Each class's
__init__ parameters will be exposed as command-line arguments.
Returns:
A tuple of instantiated objects, corresponding to the input classes in order.
"""
if not classes:
return tuple() # Return an empty tuple if no classes are provided
parser = _create_argument_parser()
# This map will store {cls: {init_param_name: argparse_dest_name}}
class_arg_configs_maps: Dict[Type[CliConfigurable], Dict[str, str]] = {}
for cls in classes:
_add_arguments_for_class(parser, cls, class_arg_configs_maps)
parsed_args = parser.parse_args() # Uses sys.argv[1:] by default
# Correctly handle single class case for return type matching overloads
instances = _instantiate_classes(parsed_args, classes, class_arg_configs_maps)
if len(classes) == 1:
return instances[0]
return instances
+3
View File
@@ -0,0 +1,3 @@
# Copyright (c) Microsoft. All rights reserved.
"""Hydra configuration package for Agent Lightning."""
+19
View File
@@ -0,0 +1,19 @@
runner_type: k8s # k8s | local
agl_server:
url: http://localhost:8080
# Optional external URL for agent pods. If unset, falls back to agl_server.url.
# Example for minikube docker driver:
# agent_url: http://host.minikube.internal:8080
agent_url: null
key: ""
k8s_runner:
namespace: default
ttl_after_finished: 1200
max_jobs_per_minute: 100
poll_interval: 5
local_runner:
maximum_size: 50
poll_interval: 10
+10
View File
@@ -0,0 +1,10 @@
host: 0.0.0.0
port: 8080
key: ""
default_proxy:
model_name: "Qwen/Qwen2.5-7B-Instruct"
include_log_probs: True
train:
temperature: 1
val:
temperature: 0.7
+1
View File
@@ -0,0 +1 @@
# Copyright (c) Microsoft. All rights reserved.
+52
View File
@@ -0,0 +1,52 @@
# Copyright (c) Microsoft. All rights reserved.
"""Hydra entrypoint for the Agent Lightning controller."""
from __future__ import annotations
import asyncio
import contextlib
import signal
import hydra
from omegaconf import DictConfig
from agentlightning.client import AgentLightningAsyncClient
async def _run_controller(config: DictConfig) -> None:
async with AgentLightningAsyncClient(
base_url=str(config.agl_server.url),
key=str(config.agl_server.key or "") or None,
) as api:
if config.runner_type == "k8s":
try:
from agentlightning.controller.k8s_reconciler import K8sReconciler
except ImportError:
raise RuntimeError("kr8s unavailable - install agentlightning[controller]") from None
reconciler = K8sReconciler(api=api, config=config)
elif config.runner_type == "local":
from agentlightning.controller.local_reconciler import LocalReconciler
reconciler = LocalReconciler(
api=api,
config=config,
)
else:
raise ValueError(f"unknown runner_type: {config.runner_type}")
loop = asyncio.get_running_loop()
for sig in (signal.SIGTERM, signal.SIGINT):
with contextlib.suppress(NotImplementedError):
loop.add_signal_handler(sig, reconciler.stop)
await reconciler.run()
@hydra.main(version_base=None, config_path="../config", config_name="controller")
def main(config: DictConfig) -> None:
asyncio.run(_run_controller(config))
if __name__ == "__main__":
main()
+362
View File
@@ -0,0 +1,362 @@
# Copyright (c) Microsoft. All rights reserved.
"""K8s controller reconciler — manages rollout lifecycle via K8s Jobs.
Two concurrent tasks:
1. periodic_reconcile() — poll queuing rollouts, create Jobs, expire stale
2. watch_jobs() — react to Job completions/failures, update rollout status
Uses AgentLightningAsyncClient for store access and kr8s for K8s API.
"""
from __future__ import annotations
import asyncio
import json
import time
from collections import deque
from typing import Any, cast
import httpx
import kr8s
import kr8s.asyncio
import structlog
import yaml
from jinja2 import Environment
from kr8s.asyncio import objects as k8s_objects
from omegaconf import DictConfig
from agentlightning.client import AgentLightningAsyncClient
from agentlightning.schemas import DEFAULT_ATTEMPT_ID, Rollout, RolloutPatch, RolloutState, RolloutStatusPatch
log = structlog.get_logger()
MANAGED_BY_SELECTOR = "app.kubernetes.io/managed-by=agentlightning"
JOB_CREATION_WINDOW_SECONDS = 60
def build_job_name(rollout_id: str) -> str:
"""Deterministic Job name from rollout ID."""
return f"agl-rollout-{rollout_id}"
def build_job_spec(rollout: Rollout, controller_config: DictConfig) -> dict[str, Any]:
"""Build a K8s Job manifest from the rollout's complete Jinja2 Job template."""
template = rollout.config.k8s.job_template if rollout.config.k8s else None
if not template:
raise ValueError("invalid rollout config: missing config.k8s.job_template")
env = Environment()
env.filters["yaml_escape"] = lambda value: json.dumps(str(value), ensure_ascii=True)
rendered = env.from_string(template).render(
job_name=build_job_name(rollout.rollout_id),
input=rollout.input,
)
docs = [doc for doc in yaml.safe_load_all(rendered) if doc is not None]
if len(docs) != 1:
raise ValueError("invalid rollout config: config.k8s.job_template must render exactly one YAML document")
job = docs[0]
if not isinstance(job, dict) or job.get("kind") != "Job":
raise ValueError("invalid rollout config: config.k8s.job_template must render a Kubernetes Job")
metadata = job.setdefault("metadata", {})
metadata["name"] = build_job_name(rollout.rollout_id)
metadata["namespace"] = controller_config.k8s_runner.namespace
labels = metadata.setdefault("labels", {})
labels["app.kubernetes.io/managed-by"] = "agentlightning"
labels["agentlightning/rollout-id"] = rollout.rollout_id
labels["agentlightning/attempt-id"] = DEFAULT_ATTEMPT_ID
spec = job.setdefault("spec", {})
spec["backoffLimit"] = 0
spec["ttlSecondsAfterFinished"] = controller_config.k8s_runner.ttl_after_finished
if rollout.config.timeout_seconds:
spec["activeDeadlineSeconds"] = rollout.config.timeout_seconds
pod_spec = spec.setdefault("template", {}).setdefault("spec", {})
pod_spec["restartPolicy"] = "Never"
mode = "train" if rollout.is_train else "val"
agent_base_url = str(
controller_config.agl_server.get("agent_url", None) or controller_config.agl_server.url
).rstrip("/")
agl_openai_base_url = (
f"{agent_base_url}/proxy/rollout/{rollout.rollout_id}/attempt/{DEFAULT_ATTEMPT_ID}/mode/{mode}/openai/v1"
)
for container in pod_spec.get("containers", []):
env = container.setdefault("env", [])
for name, value in {
"AGL_OPENAI_BASE_URL": agl_openai_base_url,
"AGL_EVENT_URL": (
f"{agent_base_url}/api/rollouts/{rollout.rollout_id}/attempt/{DEFAULT_ATTEMPT_ID}/events"
),
"AGL_KEY": str(controller_config.agl_server.key or ""),
}.items():
existing = next((item for item in env if item.get("name") == name), None)
if existing is None:
env.append({"name": name, "value": value})
else:
existing.clear()
existing.update({"name": name, "value": value})
return job
class K8sReconciler:
"""Main controller loop. Reconciles rollouts into K8s Jobs.
Args:
api: AgentLightningAsyncClient for store access.
config: Controller configuration.
"""
def __init__(self, api: AgentLightningAsyncClient, config: DictConfig) -> None:
self._api = api
self._config = config
self._runner_config = config.k8s_runner
self._namespace = str(self._runner_config.namespace)
self._k8s_api: Any | None = None
self._stop = asyncio.Event()
self._job_creation_timestamps: deque[float] = deque()
async def _get_k8s_api(self) -> Any:
if self._k8s_api is None:
self._k8s_api = await kr8s.asyncio.api()
return self._k8s_api
async def run(self) -> None:
"""Start both reconcile loops. Blocks until stop() is called."""
log.info(
"Controller starting",
namespace=self._namespace,
poll_interval=self._runner_config.poll_interval,
)
try:
await asyncio.gather(
self._periodic_reconcile_loop(),
self._watch_jobs_loop(),
)
except asyncio.CancelledError:
log.info("Controller stopped")
def stop(self) -> None:
"""Signal the controller to stop."""
self._stop.set()
# --- Periodic reconcile ---
async def _periodic_reconcile_loop(self) -> None:
"""Poll queuing rollouts and reconcile."""
while not self._stop.is_set():
try:
await self._reconcile_once()
except Exception:
log.exception("Periodic reconcile error")
# Sleep with cancellation support.
try:
await asyncio.wait_for(self._stop.wait(), timeout=self._runner_config.poll_interval)
return # stop was set
except TimeoutError:
pass
async def _reconcile_once(self) -> None:
"""One reconcile cycle: align queuing/running rollouts with K8s Jobs."""
rollouts = await self._query_rollouts(state_in=[RolloutState.QUEUING, RolloutState.RUNNING], limit=500)
api = await self._get_k8s_api()
jobs = [
cast(k8s_objects.Job, job).raw
async for job in k8s_objects.Job.async_list(
namespace=self._namespace,
label_selector=MANAGED_BY_SELECTOR,
api=api,
)
]
jobs_by_name = {job.get("metadata", {}).get("name", ""): job for job in jobs}
for rollout in rollouts:
job_name = rollout.status.k8s_job_name or build_job_name(rollout.rollout_id)
job = jobs_by_name.get(job_name)
if job is None:
if rollout.status.state == RolloutState.QUEUING:
await self._create_job(rollout)
continue
log.warning("Orphaned running rollout — Job gone", rollout_id=rollout.rollout_id, job_name=job_name)
await self._patch_status(rollout.rollout_id, state=RolloutState.FAILED, error_message="Job disappeared")
continue
attempt_id = (
job.get("metadata", {}).get("labels", {}).get("agentlightning/attempt-id") or DEFAULT_ATTEMPT_ID
)
job_status = job.get("status", {})
state = None
error_message = None
for condition in job_status.get("conditions", []):
if condition.get("status") != "True":
continue
if condition.get("type") == "Complete":
state = RolloutState.SUCCEEDED
break
if condition.get("type") == "Failed":
reason = condition.get("reason", "Unknown")
message = condition.get("message", "")
error_message = f"Job failed: {reason}"
if message:
error_message += f"{message}"
state = RolloutState.FAILED
break
if state is None and job_status.get("succeeded", 0) > 0:
state = RolloutState.SUCCEEDED
elif state is None and job_status.get("failed", 0) > 0:
state = RolloutState.FAILED
error_message = "Job failed"
if state is None:
if rollout.status.state == RolloutState.QUEUING:
await self._patch_status(
rollout.rollout_id,
state=RolloutState.RUNNING,
k8s_job_name=job_name,
last_attempt_id=attempt_id,
)
continue
if rollout.status.state == RolloutState.QUEUING and state == RolloutState.SUCCEEDED:
patched = await self._patch_status(
rollout.rollout_id,
state=RolloutState.RUNNING,
k8s_job_name=job_name,
last_attempt_id=attempt_id,
)
if not patched:
continue
await self._patch_status(
rollout.rollout_id,
state=state,
k8s_job_name=job_name,
last_attempt_id=attempt_id,
error_message=error_message,
)
async def _create_job(self, rollout: Rollout) -> None:
"""Create a K8s Job for a queuing rollout without changing rollout state."""
job_name = build_job_name(rollout.rollout_id)
now = time.monotonic()
window_start = now - JOB_CREATION_WINDOW_SECONDS
while self._job_creation_timestamps and self._job_creation_timestamps[0] <= window_start:
self._job_creation_timestamps.popleft()
if len(self._job_creation_timestamps) >= self._runner_config.max_jobs_per_minute:
log.info(
"Job creation rate limit reached — deferring queued rollouts",
rollout_id=rollout.rollout_id,
jobs_in_last_minute=len(self._job_creation_timestamps),
max_jobs_per_minute=self._runner_config.max_jobs_per_minute,
)
return
try:
manifest = build_job_spec(rollout, self._config)
attempt_id = manifest["metadata"]["labels"]["agentlightning/attempt-id"]
api = await self._get_k8s_api()
job = k8s_objects.Job(manifest, api=api)
await job.async_create()
self._job_creation_timestamps.append(time.monotonic())
log.info("Job created", rollout_id=rollout.rollout_id, job_name=job_name, attempt_id=attempt_id)
except Exception as exc:
error_str = str(exc)
lower_error = error_str.lower()
if "422" in lower_error or "unprocessable" in lower_error or "invalid" in lower_error:
log.error("Invalid Job spec — marking failed", rollout_id=rollout.rollout_id, error=error_str)
await self._patch_status(
rollout.rollout_id,
state=RolloutState.FAILED,
error_message=f"Invalid Job spec: {error_str}",
)
else:
log.warning("Job creation failed — will retry", rollout_id=rollout.rollout_id, error=error_str)
# --- Watch Jobs ---
async def _watch_jobs_loop(self) -> None:
"""Watch K8s Job events and react to completions/failures."""
while not self._stop.is_set():
try:
watcher = kr8s.asyncio.watch(
"jobs",
namespace=self._namespace,
label_selector=MANAGED_BY_SELECTOR,
api=await self._get_k8s_api(),
)
async for event_type, obj in watcher:
if self._stop.is_set():
return
if event_type in ("MODIFIED", "ADDED"):
await self._handle_job_event(obj.raw)
except Exception:
log.exception("Watch error — restarting watch")
await asyncio.sleep(5)
async def _handle_job_event(self, job: dict[str, Any]) -> None:
"""Process a Job event — check conditions, update rollout status."""
labels = job.get("metadata", {}).get("labels", {})
rollout_id = labels.get("agentlightning/rollout-id")
if not rollout_id:
return
attempt_id = labels.get("agentlightning/attempt-id") or DEFAULT_ATTEMPT_ID
conditions = job.get("status", {}).get("conditions", [])
if not conditions:
return
for condition in conditions:
cond_type = condition.get("type", "")
cond_status = condition.get("status", "")
if cond_status != "True":
continue
if cond_type == "Complete":
log.info("Job completed", rollout_id=rollout_id, last_attempt_id=attempt_id)
await self._patch_status(rollout_id, state=RolloutState.SUCCEEDED, last_attempt_id=attempt_id)
return
elif cond_type == "Failed":
reason = condition.get("reason", "Unknown")
message = condition.get("message", "")
error_msg = f"Job failed: {reason}"
if message:
error_msg += f"{message}"
log.info("Job failed", rollout_id=rollout_id, last_attempt_id=attempt_id, reason=reason)
await self._patch_status(
rollout_id,
state=RolloutState.FAILED,
last_attempt_id=attempt_id,
error_message=error_msg,
)
return
async def _query_rollouts(
self,
*,
state_in: list[RolloutState],
limit: int = 50,
) -> list[Rollout]:
params = httpx.QueryParams()
for state in state_in:
params = params.add("state_in", state.value)
params = params.add("limit", limit)
response = await self._api.get("/api/rollouts", params=params)
response.raise_for_status()
return [Rollout.model_validate(item) for item in response.json()]
async def _patch_status(self, rollout_id: str, **status: Any) -> bool:
try:
patch = RolloutPatch(status=RolloutStatusPatch.model_validate(status))
response = await self._api.patch(
f"/api/rollouts/{rollout_id}",
json=patch.model_dump(mode="json", exclude_unset=True),
)
response.raise_for_status()
return True
except Exception as exc:
log.warning("Failed to patch rollout", rollout_id=rollout_id, error=str(exc))
return False
@@ -0,0 +1,283 @@
# Copyright (c) Microsoft. All rights reserved.
"""Local reconciler that runs rollouts as short-lived Python subprocesses."""
from __future__ import annotations
import asyncio
import contextlib
import importlib
import inspect
import json
import os
import signal
import sys
import time
import traceback
from dataclasses import dataclass
import httpx
import structlog
from omegaconf import DictConfig
from agentlightning.client import AgentLightningAsyncClient
from agentlightning.schemas import DEFAULT_ATTEMPT_ID, Rollout, RolloutPatch, RolloutState, RolloutStatusPatch
log = structlog.get_logger()
_SHUTDOWN_WAIT_TIMEOUT = 5.0
def _run_local_reconciler_worker(agent_class_path: str) -> int:
try:
if ":" in agent_class_path:
module_name, class_name = agent_class_path.split(":", 1)
else:
module_name, class_name = agent_class_path.rsplit(".", 1)
loaded = getattr(importlib.import_module(module_name), class_name)
if not isinstance(loaded, type):
raise TypeError(f"{agent_class_path} is not a class")
result = loaded().run()
if inspect.isawaitable(result):
asyncio.run(result) # type: ignore[arg-type]
return 0
except Exception:
traceback.print_exc()
return 1
@dataclass
class Proc:
"""In-flight local subprocess."""
attempt_id: str
proc: asyncio.subprocess.Process
spawned_at: float
killed: bool = False
def _build_env_from_map(task_input: object, env_map: dict[str, str]) -> dict[str, str]:
env: dict[str, str] = {}
for name, path in env_map.items():
value = _resolve_input_path(task_input, path)
if isinstance(value, str):
env[name] = value
continue
try:
env[name] = json.dumps(value, ensure_ascii=False)
except (TypeError, ValueError) as exc:
raise ValueError(f"local.env_map.{name} value is not JSON serializable") from exc
return env
def _resolve_input_path(task_input: object, path: str) -> object:
if path == "input":
return task_input
if not path.startswith("input."):
return path
value = task_input
for part in path.split(".")[1:]:
if isinstance(value, dict) and part in value:
value = value[part]
elif isinstance(value, list) and part.isdigit() and int(part) < len(value):
value = value[int(part)]
else:
raise ValueError(f"local.env_map path not found: {path}")
return value
class LocalReconciler:
"""Local-mode rollout reconciler."""
def __init__(
self,
api: AgentLightningAsyncClient,
config: DictConfig,
) -> None:
assert config.runner_type == "local"
self._api = api
self._config = config
self._runner_config = config.local_runner
self._pool_size = int(self._runner_config.maximum_size)
self._tick_interval = float(self._runner_config.poll_interval)
self._rid_to_proc: dict[str, Proc] = {}
self._stop = asyncio.Event()
async def run(self) -> None:
log.info("LocalReconciler starting", pool_size=self._pool_size, tick=self._tick_interval)
try:
await self._reconcile_loop()
finally:
await self._shutdown()
def stop(self) -> None:
self._stop.set()
async def _reconcile_loop(self) -> None:
while not self._stop.is_set():
try:
await self._reconcile_once()
except Exception:
log.exception("Local reconcile error")
try:
await asyncio.wait_for(self._stop.wait(), timeout=self._tick_interval)
break
except TimeoutError:
pass
async def _reconcile_once(self) -> None:
params = httpx.QueryParams()
params = params.add("state_in", RolloutState.QUEUING.value)
params = params.add("state_in", RolloutState.RUNNING.value)
params = params.add("limit", 50)
response = await self._api.get("/api/rollouts", params=params)
response.raise_for_status()
rollouts = [Rollout.model_validate(item) for item in response.json()]
rollouts_by_id = {rollout.rollout_id: rollout for rollout in rollouts}
live_count = sum(1 for item in self._rid_to_proc.values() if item.proc.returncode is None)
for rollout in rollouts:
item = self._rid_to_proc.get(rollout.rollout_id)
if item is None:
if rollout.status.state == RolloutState.QUEUING and live_count < self._pool_size:
if await self._spawn_for(rollout):
live_count += 1
elif rollout.status.state == RolloutState.RUNNING:
await self._patch(rollout.rollout_id, RolloutState.FAILED, "local subprocess is not running")
continue
if item.proc.returncode is None:
if rollout.status.state == RolloutState.QUEUING:
await self._patch(rollout.rollout_id, RolloutState.RUNNING, last_attempt_id=item.attempt_id)
continue
await self._finish_proc(rollout, item)
now = time.monotonic()
for rollout_id, item in list(self._rid_to_proc.items()):
if item.proc.returncode is not None:
continue
rollout = rollouts_by_id.get(rollout_id)
timeout = float(rollout.config.timeout_seconds) if rollout and rollout.config.timeout_seconds else None
if (
timeout is not None
and (now - item.spawned_at) > timeout
and await self._kill_process_group(rollout_id, item)
):
await self._patch(rollout_id, RolloutState.FAILED, "local subprocess timed out")
async def _finish_proc(self, rollout: Rollout, item: Proc) -> bool:
if rollout.status.state == RolloutState.QUEUING:
patched = await self._patch(rollout.rollout_id, RolloutState.RUNNING, last_attempt_id=item.attempt_id)
if not patched:
return False
if item.proc.returncode == 0:
return await self._patch(rollout.rollout_id, RolloutState.SUCCEEDED, last_attempt_id=item.attempt_id)
return await self._patch(
rollout.rollout_id,
RolloutState.FAILED,
f"subprocess exited with code {item.proc.returncode}",
)
async def _kill_process_group(self, rollout_id: str, item: Proc) -> bool:
"""SIGKILL the worker process group and wait for exit."""
if item.proc.returncode is not None:
return True
if not item.killed:
with contextlib.suppress(ProcessLookupError):
os.killpg(item.proc.pid, signal.SIGKILL)
item.killed = True
log.info("SIGKILL sent to subprocess group", rollout_id=rollout_id, pid=item.proc.pid)
try:
await asyncio.wait_for(item.proc.wait(), timeout=_SHUTDOWN_WAIT_TIMEOUT)
return True
except TimeoutError:
log.warning("Subprocess did not exit after SIGKILL within 5s", rollout_id=rollout_id, pid=item.proc.pid)
return False
async def _spawn_for(self, rollout: Rollout) -> bool:
"""Spawn one local subprocess for a rollout."""
try:
attempt_id = DEFAULT_ATTEMPT_ID
if rollout.config.local is None or not rollout.config.local.agent_class:
raise ValueError("invalid rollout config: missing config.local.agent_class")
agent_class = rollout.config.local.agent_class
mode = "train" if rollout.is_train else "val"
env = {
**os.environ,
"AGL_KEY": str(self._config.agl_server.key or ""),
"AGL_OPENAI_BASE_URL": (
f"{self._config.agl_server.url}/proxy/rollout/{rollout.rollout_id}"
f"/attempt/{attempt_id}/mode/{mode}/openai/v1"
),
"AGL_EVENT_URL": (
f"{self._config.agl_server.url}/api/rollouts/{rollout.rollout_id}/attempt/{attempt_id}/events"
),
}
env.update(_build_env_from_map(rollout.input, rollout.config.local.env_map))
proc = await asyncio.create_subprocess_exec(
sys.executable,
"-c",
(
"import sys; "
"from agentlightning.controller.local_reconciler import _run_local_reconciler_worker; "
"sys.exit(_run_local_reconciler_worker(sys.argv[1]))"
),
agent_class,
stdin=asyncio.subprocess.DEVNULL,
stdout=None,
stderr=None,
env=env,
start_new_session=True,
)
except Exception as e:
log.exception("Spawn failed", rollout_id=rollout.rollout_id)
await self._patch(rollout.rollout_id, RolloutState.FAILED, f"local subprocess spawn failed: {e}")
return False
self._rid_to_proc[rollout.rollout_id] = Proc(
attempt_id=attempt_id,
proc=proc,
spawned_at=time.monotonic(),
)
await self._patch(rollout.rollout_id, RolloutState.RUNNING, last_attempt_id=attempt_id)
log.info("Spawned rollout subprocess", rollout_id=rollout.rollout_id, attempt_id=attempt_id, pid=proc.pid)
return True
async def _shutdown(self) -> None:
"""Kill live subprocesses and mark them failed."""
try:
await self._reconcile_once()
except Exception:
log.exception("Final reconcile during shutdown failed")
for rollout_id, item in list(self._rid_to_proc.items()):
if item.proc.returncode is None and await self._kill_process_group(rollout_id, item):
await self._patch(rollout_id, RolloutState.FAILED, "local controller shutdown")
async def _patch(
self,
rollout_id: str,
state: RolloutState,
error_message: str | None = None,
*,
last_attempt_id: str | None = None,
) -> bool:
status = RolloutStatusPatch(state=state)
if error_message is not None:
status.error_message = error_message
if last_attempt_id is not None:
status.last_attempt_id = last_attempt_id
patch = RolloutPatch(status=status)
try:
response = await self._api.patch(
f"/api/rollouts/{rollout_id}",
json=patch.model_dump(mode="json", exclude_unset=True),
)
response.raise_for_status()
return True
except Exception as e:
log.warning("Failed to patch rollout", rollout_id=rollout_id, error=str(e))
return False
+63
View File
@@ -0,0 +1,63 @@
# Copyright (c) Microsoft. All rights reserved.
"""Rollout lifecycle hooks used by enqueue and fit flows."""
from __future__ import annotations
from typing import TYPE_CHECKING, Any, Protocol
from agentlightning.schemas import RolloutCreate
if TYPE_CHECKING:
from agentlightning.schemas import Rollout
class TraceWriter(Protocol):
def add_event(self, rollout_id: str, attempt_id: str, event_type: str, data: dict[str, Any]) -> Any: ...
class RolloutHooks:
"""Base class for synchronous rollout lifecycle hooks."""
def on_startup(self, store: Any | None = None) -> None:
"""Initialize hook state once after startup."""
def on_enqueue(self, request: RolloutCreate) -> RolloutCreate:
"""Transform a rollout request before it is persisted."""
return request
def on_succeeded(self, rollout: Rollout, events: dict[str, list[Any]], store: TraceWriter) -> None:
"""Run after a rollout transitions to SUCCEEDED."""
def on_failed(self, rollout: Rollout, store: TraceWriter) -> None:
"""Run after a rollout transitions to FAILED."""
def load_hooks(path: str) -> RolloutHooks:
"""Load the single ``RolloutHooks`` subclass from a Python file."""
import importlib.util
import inspect
from pathlib import Path
module_path = Path(path).resolve()
if not module_path.exists():
raise FileNotFoundError(f"Hooks module not found: {module_path}")
spec = importlib.util.spec_from_file_location("_agl_hooks", str(module_path))
assert spec is not None and spec.loader is not None
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
hook_classes = [
obj
for _, obj in inspect.getmembers(module, inspect.isclass)
if issubclass(obj, RolloutHooks) and obj is not RolloutHooks
]
if len(hook_classes) == 0:
raise ValueError(f"No RolloutHooks subclass found in {path}")
if len(hook_classes) > 1:
names = [cls.__name__ for cls in hook_classes]
raise ValueError(f"Multiple RolloutHooks subclasses found in {path}: {names}")
return hook_classes[0]()
-109
View File
@@ -1,109 +0,0 @@
import warnings
AGENTOPS_INSTALLED = False
AGENTOPS_LANGCHAIN_INSTALLED = False
LITELLM_INSTALLED = False
VLLM_INSTALLED = False
try:
from . import agentops
AGENTOPS_INSTALLED = True
except ImportError:
pass
try:
from . import litellm
LITELLM_INSTALLED = True
except ImportError:
pass
# MAGIC! DO NOT TOUCH THIS!
# vllm import will cause reward tracing function to fail and produce nothing.
# try:
# from . import vllm
# VLLM_INSTALLED = True
# except ImportError:
# pass
try:
from . import agentops_langchain
AGENTOPS_LANGCHAIN_INSTALLED = True
except ImportError:
pass
def instrument_all():
if AGENTOPS_INSTALLED:
from .agentops import instrument_agentops
instrument_agentops()
else:
warnings.warn("agentops is not installed. It's therefore not instrumented.")
if LITELLM_INSTALLED:
from .litellm import instrument_litellm
instrument_litellm()
else:
warnings.warn("litellm is not installed. It's therefore not instrumented.")
if VLLM_INSTALLED:
from .vllm import instrument_vllm
instrument_vllm()
else:
warnings.warn("vllm is not installed. It's therefore not instrumented.")
if AGENTOPS_LANGCHAIN_INSTALLED:
from .agentops_langchain import instrument_agentops_langchain
instrument_agentops_langchain()
else:
warnings.warn("Agentops-langchain integration is not installed. It's therefore not instrumented.")
def uninstrument_all():
if AGENTOPS_INSTALLED:
try:
from .agentops import uninstrument_agentops
uninstrument_agentops()
except ImportError:
warnings.warn("agentops is installed but uninstrument_agentops could not be imported.")
else:
warnings.warn("agentops is not installed. It's therefore not uninstrumented.")
if LITELLM_INSTALLED:
try:
from .litellm import uninstrument_litellm
uninstrument_litellm()
except ImportError:
warnings.warn("litellm is installed but uninstrument_litellm could not be imported.")
else:
warnings.warn("litellm is not installed. It's therefore not uninstrumented.")
if VLLM_INSTALLED:
try:
from .vllm import uninstrument_vllm
uninstrument_vllm()
except ImportError:
warnings.warn("vllm is installed but uninstrument_vllm could not be imported.")
else:
warnings.warn("vllm is not installed. It's therefore not uninstrumented.")
if AGENTOPS_LANGCHAIN_INSTALLED:
try:
from .agentops_langchain import uninstrument_agentops_langchain
uninstrument_agentops_langchain()
except ImportError:
warnings.warn("agentops_langchain is installed but uninstrument_agentops_langchain could not be imported.")
else:
warnings.warn("Agentops-langchain integration is not installed. It's therefore not uninstrumented.")
-240
View File
@@ -1,240 +0,0 @@
import logging
import multiprocessing
import signal
import socket
import time
import flask
import setproctitle
logger = logging.getLogger(__name__)
# Module-level storage for originals
_original_handle_chat_attributes = None
_original_handle_response = None
def _patch_new_agentops():
import agentops.instrumentation.providers.openai.wrappers.chat
import agentops.instrumentation.providers.openai.stream_wrapper
from agentops.instrumentation.providers.openai.wrappers.chat import handle_chat_attributes
global _original_handle_chat_attributes
if _original_handle_chat_attributes is not None:
logger.warning("AgentOps already patched. Skipping.")
return True
_original_handle_chat_attributes = handle_chat_attributes
def _handle_chat_attributes_with_tokens(args=None, kwargs=None, return_value=None, **kws):
attributes = _original_handle_chat_attributes(args=args, kwargs=kwargs, return_value=return_value, **kws)
if hasattr(return_value, "prompt_token_ids"):
attributes["prompt_token_ids"] = list(return_value.prompt_token_ids)
if hasattr(return_value, "response_token_ids"):
attributes["response_token_ids"] = list(return_value.response_token_ids[0])
# For LiteLLM, response is a openai._legacy_response.LegacyAPIResponse
if hasattr(return_value, "http_response") and hasattr(return_value.http_response, "json"):
json_data = return_value.http_response.json()
if isinstance(json_data, dict):
if "prompt_token_ids" in json_data:
attributes["prompt_token_ids"] = list(json_data["prompt_token_ids"])
if "response_token_ids" in json_data:
attributes["response_token_ids"] = list(json_data["response_token_ids"][0])
return attributes
agentops.instrumentation.providers.openai.wrappers.chat.handle_chat_attributes = _handle_chat_attributes_with_tokens
agentops.instrumentation.providers.openai.stream_wrapper.handle_chat_attributes = (
_handle_chat_attributes_with_tokens
)
logger.info("Patched newer version of agentops using handle_chat_attributes")
return True
def _unpatch_new_agentops():
import agentops.instrumentation.providers.openai.wrappers.chat
import agentops.instrumentation.providers.openai.stream_wrapper
global _original_handle_chat_attributes
if _original_handle_chat_attributes is not None:
agentops.instrumentation.providers.openai.wrappers.chat.handle_chat_attributes = (
_original_handle_chat_attributes
)
agentops.instrumentation.providers.openai.stream_wrapper.handle_chat_attributes = (
_original_handle_chat_attributes
)
_original_handle_chat_attributes = None
logger.info("Unpatched newer version of agentops using handle_chat_attributes")
def _patch_old_agentops():
import opentelemetry.instrumentation.openai.shared.chat_wrappers
from opentelemetry.instrumentation.openai.shared.chat_wrappers import _handle_response, dont_throw
global _original_handle_response
_original_handle_response = _handle_response
@dont_throw
def _handle_response_with_tokens(response, span, *args, **kwargs):
_original_handle_response(response, span, *args, **kwargs)
if hasattr(response, "prompt_token_ids"):
span.set_attribute("prompt_token_ids", list(response.prompt_token_ids))
if hasattr(response, "response_token_ids"):
span.set_attribute("response_token_ids", list(response.response_token_ids[0]))
# For LiteLLM, response is a openai._legacy_response.LegacyAPIResponse
if hasattr(response, "http_response") and hasattr(response.http_response, "json"):
json_data = response.http_response.json()
if isinstance(json_data, dict):
if "prompt_token_ids" in json_data:
span.set_attribute("prompt_token_ids", list(json_data["prompt_token_ids"]))
if "response_token_ids" in json_data:
span.set_attribute("response_token_ids", list(json_data["response_token_ids"][0]))
opentelemetry.instrumentation.openai.shared.chat_wrappers._handle_response = _handle_response_with_tokens
logger.info("Patched earlier version of agentops using _handle_response")
return True
def _unpatch_old_agentops():
import opentelemetry.instrumentation.openai.shared.chat_wrappers
global _original_handle_response
if _original_handle_response is not None:
opentelemetry.instrumentation.openai.shared.chat_wrappers._handle_response = _original_handle_response
_original_handle_response = None
logger.info("Unpatched earlier version of agentops using _handle_response")
def instrument_agentops():
"""
Instrument agentops to capture token IDs.
Automatically detects and uses the appropriate patching method based on the installed agentops version.
"""
# Try newest version first (tested for 0.4.16)
try:
return _patch_new_agentops()
except ImportError as e:
logger.debug(f"Couldn't patch newer version of agentops: {str(e)}")
# Note: 0.4.15 needs another patching method, but it's too shortlived to be worth handling separately.
# Try older version (tested for 0.4.13)
try:
return _patch_old_agentops()
except ImportError as e:
logger.warning(f"Couldn't patch older version of agentops: {str(e)}")
logger.error("Failed to instrument agentops - neither patching method was successful")
return False
def uninstrument_agentops():
try:
_unpatch_new_agentops()
except Exception:
pass
try:
_unpatch_old_agentops()
except Exception:
pass
def agentops_local_server():
"""
Returns a Flask app that can be used to test agentops integration.
This server provides endpoints for token fetching and a catch-all endpoint.
"""
app = flask.Flask(__name__)
@app.route("/v3/auth/token", methods=["POST"])
def fetch_token():
return {"token": "dummy", "project_id": "dummy"}
@app.route("/", defaults={"path": ""}, methods=["GET", "POST"])
@app.route("/<path:path>", methods=["GET", "POST"])
def catch_all(path):
return {"path": path}
return app
def _run_server(**kwargs):
"""
Internal function to run the Flask server.
This is used to avoid issues with multiprocessing and Flask's reloader.
"""
signal.signal(signal.SIGINT, signal.SIG_IGN) # Ignore SIGINT in worker processes
setproctitle.setproctitle(multiprocessing.current_process().name)
app = agentops_local_server()
app.run(**kwargs)
class AgentOpsServerManager:
def __init__(self, daemon: bool = True, port: int | None = None):
self.server_process: multiprocessing.Process | None = None
self.server_port = port
self.daemon = daemon
logger.info("AgentOpsServerManager initialized.")
def _find_available_port(self) -> int:
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
s.bind(("", 0))
return s.getsockname()[1]
def start(self):
if self.server_process and self.server_process.is_alive():
logger.warning("AgentOps server process appears to be already running.")
return
if self.server_port is None:
self.server_port = self._find_available_port()
logger.info(f"Starting AgentOps local server on port {self.server_port}...")
self.server_process = multiprocessing.Process(
target=_run_server,
kwargs={"host": "127.0.0.1", "port": self.server_port, "use_reloader": False, "debug": False},
daemon=self.daemon,
name="AgentLightning-AgentOpsServer",
)
self.server_process.start()
logger.info(
f"AgentOps local server process (PID: {self.server_process.pid}) started, targeting port {self.server_port}."
)
time.sleep(0.5) # Brief wait for server to start up
if not self.server_process.is_alive():
logger.error(f"AgentOps local server failed to start or exited prematurely.")
def is_alive(self) -> bool:
if self.server_process and self.server_process.is_alive():
return True
return False
def stop(self):
if self.is_alive():
logger.info(f"Stopping AgentOps local server (PID: {self.server_process.pid})...")
self.server_process.terminate() # Send SIGTERM
self.server_process.join(timeout=5) # Wait for clean exit
if self.server_process.is_alive():
logger.warning(
f"AgentOps server (PID: {self.server_process.pid}) did not terminate gracefully, killing..."
)
self.server_process.kill() # Force kill
self.server_process.join(timeout=10) # Wait for kill
self.server_process = None
logger.info(f"AgentOps local server stopped.")
else:
logger.info("AgentOps local server was not running or already stopped.")
def get_port(self) -> int | None:
# Check liveness again in case it died since start()
if self.is_alive() and self.server_port is not None:
return self.server_port
# If called after server stopped or failed, port might be stale or None
if self.server_port is not None and (self.server_process is None or not self.server_process.is_alive()):
logger.warning(
f"AgentOps server port {self.server_port} is stored, but server process is not alive. Returning stored port."
)
return self.server_port
@@ -1,36 +0,0 @@
from typing import Dict, Any
from agentops.integration.callbacks.langchain import LangchainCallbackHandler
from agentops import instrumentation
original_on_chain_start = LangchainCallbackHandler.on_chain_start
langgraph_entry = None
def on_chain_start(self, serialized: Dict[str, Any], inputs: Dict[str, Any], **kwargs: Any) -> None:
if "name" in kwargs:
if serialized is None:
serialized = {}
serialized = serialized.copy()
serialized["name"] = kwargs["name"]
if "run_id" in kwargs:
if serialized is None:
serialized = {}
serialized = serialized.copy()
if "id" not in serialized:
serialized["id"] = kwargs["run_id"]
return original_on_chain_start(self, serialized, inputs, **kwargs)
def instrument_agentops_langchain():
global langgraph_entry
langgraph_entry = instrumentation.AGENTIC_LIBRARIES.pop("langgraph", None)
LangchainCallbackHandler.on_chain_start = on_chain_start
def uninstrument_agentops_langchain():
global langgraph_entry
if langgraph_entry is not None:
instrumentation.AGENTIC_LIBRARIES["langgraph"] = langgraph_entry
langgraph_entry = None
LangchainCallbackHandler.on_chain_start = original_on_chain_start
-26
View File
@@ -1,26 +0,0 @@
from typing import Optional, Any
from litellm.integrations.opentelemetry import OpenTelemetry
# It's unclear whether or not this file is useful
# It seems that LiteLLM owns its own telemetry from their own entrance
# https://docs.litellm.ai/docs/observability/agentops_integration
original_set_attributes = OpenTelemetry.set_attributes
def patched_set_attributes(self, span: Any, kwargs, response_obj: Optional[Any]):
original_set_attributes(self, span, kwargs, response_obj)
# Add custom attributes
if response_obj.get("prompt_token_ids"):
span.set_attribute("prompt_token_ids", list(response_obj.get("prompt_token_ids")))
if response_obj.get("response_token_ids"):
span.set_attribute("response_token_ids", list(response_obj.get("response_token_ids")[0]))
def instrument_litellm():
OpenTelemetry.set_attributes = patched_set_attributes
def uninstrument_litellm():
OpenTelemetry.set_attributes = original_set_attributes
@@ -1,148 +0,0 @@
# type: ignore
# https://github.com/volcengine/verl/blob/bd94bd61fe4193e56f2845dc794004afbef7f818/examples/ppo_trainer/naive_chat_scheduler.py
# This file is part of VERL example. It should be included in the VERL package but it's not currently.
# Copyright 2024 Bytedance Ltd. and/or its affiliates
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import asyncio
from typing import Any, Dict, List
import torch
from openai.types.chat.chat_completion import ChatCompletion
from tensordict import TensorDict
from verl.protocol import DataProto
from verl.workers.rollout.async_server import ChatCompletionScheduler
class NaiveChatCompletionScheduler(ChatCompletionScheduler):
"""
A very naive implementation of ChatCompletionScheduler for demo purpose,
only do single-turn chat completion.
"""
async def generate_sequences(self, batch: DataProto, **sampling_params) -> DataProto:
kwargs = dict(
n=self.config.n,
max_completion_tokens=self.config.response_length,
temperature=self.config.temperature,
top_p=self.config.top_p,
)
do_sample = batch.meta_info.get("do_sample", True)
is_validate = batch.meta_info.get("validate", False)
if not do_sample or is_validate:
kwargs["n"] = 1
kwargs["temperature"] = 0
kwargs.update(sampling_params)
print(f"[NaiveChatCompletionScheduler] generate_sequences sampling params: {kwargs}")
async def callback(completions: ChatCompletion, info: Dict[str, Any], exception: Exception):
assert exception is None, f"exception: {exception}"
conversation, batch_conversations, batch_index = (
info["conversation"],
info["batch_conversations"],
info["batch_index"],
)
conversations = []
for choice in completions.choices:
chat = conversation.copy()
chat.append({"role": choice.message.role, "content": choice.message.content})
conversations.append(chat)
batch_conversations[batch_index] = conversations
# NOTE: we can call tools and resubmit chat completions here.
# call_tools(completions, info)
# await self.submit_chat_completions(callback2, ...)
# TODO: we may need to control max concurrent requests here, or it will harm prefix cache hit rate.
tasks, batch_conversations = [], [None] * len(batch)
for batch_index, conversation in enumerate(batch.non_tensor_batch["raw_prompt"]):
# raw_prompt: [{"role": "user", "content": ""}, ["role": "assistant", "content"], ...]
tasks.append(
asyncio.create_task(
self.submit_chat_completions(
callback=callback,
callback_additional_info={
"batch_conversations": batch_conversations,
"batch_index": batch_index,
"conversation": list(conversation),
},
model=self.model_name,
messages=conversation.tolist(),
**kwargs,
)
)
)
await asyncio.gather(*tasks)
print("[NaiveChatCompletionScheduler] generate_sequences done")
return self._postprocess(batch, batch_conversations, kwargs["n"])
def _postprocess(
self, batch: DataProto, batch_conversations: List[List[List[Dict[str, str]]]], n: int
) -> DataProto:
# NOTE: consistent with batch version of generate_sequences in vllm_rollout_spmd.py
# prompts: left pad
# responses: right pad
# input_ids: prompt + response
# attention_mask: [0,0,0,0,1,1,1,1, | 1,1,1,0,0,0,0,0]
# position_ids: [0,0,0,0,0,1,2,3, | 4,5,6,7,8,9,10,11]
# prompts: [prompt] from input dataset
prompts = [
self.tokenizer.apply_chat_template(prompt, add_generation_prompt=True, tokenize=False)
for prompt in batch.non_tensor_batch["raw_prompt"]
]
# flatten batch_conversations if n > 1
assert len(batch_conversations) == len(prompts)
batch_conversations = [conversation for conversations in batch_conversations for conversation in conversations]
assert len(batch_conversations) == len(prompts) * n
# sequences: [prompt + response]
sequences = [
self.tokenizer.apply_chat_template(conversation, add_generation_prompt=False, tokenize=False)
for conversation in batch_conversations
]
# responses: [response]
# TODO: mask out tools calling tokens?
responses = [sequence[len(prompts[i // n]) :] for i, sequence in enumerate(sequences)]
prompts = self.tokenizer(prompts, return_tensors="pt", padding="longest", padding_side="left")
responses = self.tokenizer(responses, return_tensors="pt", padding="longest", padding_side="right")
if n > 1:
prompts["input_ids"] = prompts["input_ids"].repeat_interleave(n, dim=0)
prompts["attention_mask"] = prompts["attention_mask"].repeat_interleave(n, dim=0)
input_ids = torch.cat([prompts["input_ids"], responses["input_ids"]], dim=1)
attention_mask = torch.cat([prompts["attention_mask"], responses["attention_mask"]], dim=1)
position_ids = (attention_mask.cumsum(dim=1) - 1) * attention_mask
batch = TensorDict(
{
"prompts": prompts["input_ids"],
"responses": responses["input_ids"],
"input_ids": input_ids,
"attention_mask": attention_mask,
"position_ids": position_ids,
},
batch_size=len(input_ids),
)
return DataProto(batch=batch)
-69
View File
@@ -1,69 +0,0 @@
from __future__ import annotations
import warnings
from typing import List
from vllm.entrypoints.openai.protocol import ChatCompletionResponse
import vllm.entrypoints.openai.protocol
from vllm.entrypoints.openai.serving_chat import OpenAIServingChat
class ChatCompletionResponsePatched(ChatCompletionResponse):
prompt_token_ids: List[int] | None = None
response_token_ids: List[int] | None = None
original_chat_completion_full_generator = OpenAIServingChat.chat_completion_full_generator
async def chat_completion_full_generator(
self,
request,
result_generator,
request_id: str,
model_name: str,
conversation,
tokenizer,
request_metadata,
):
prompt_token_ids: List[int] | None = None
response_token_ids: List[List[int]] | None = None
async def _generate_inceptor():
nonlocal prompt_token_ids, response_token_ids
async for res in result_generator:
yield res
prompt_token_ids = res.prompt_token_ids
response_token_ids = [output.token_ids for output in res.outputs]
response = await original_chat_completion_full_generator(
self,
request,
_generate_inceptor(),
request_id,
model_name,
conversation,
tokenizer,
request_metadata,
)
response = response.model_copy(
update={
"prompt_token_ids": prompt_token_ids,
"response_token_ids": response_token_ids,
}
)
return response
def instrument_vllm():
if vllm.entrypoints.openai.protocol.ChatCompletionResponse is ChatCompletionResponsePatched:
warnings.warn("vllm is already instrumented. Skip the instrumentation.")
return
vllm.entrypoints.openai.protocol.ChatCompletionResponse = ChatCompletionResponsePatched
OpenAIServingChat.chat_completion_full_generator = chat_completion_full_generator
def uninstrument_vllm():
OpenAIServingChat.chat_completion_full_generator = original_chat_completion_full_generator
-178
View File
@@ -1,178 +0,0 @@
from __future__ import annotations
import logging
import weakref
from typing import Any, List, Dict, Union, Optional, TYPE_CHECKING
from .types import NamedResources, Rollout, Task, TaskInput, Triplet, RolloutRawResult
if TYPE_CHECKING:
from .trainer import Trainer
from .runner import AgentRunner
from .tracer import BaseTracer
logger = logging.getLogger(__name__)
class LitAgent:
"""Base class for the training and validation logic of an agent.
Developers should subclass this class and implement the rollout methods
to define the agent's behavior for a single task. The agent's logic
is completely decoupled from the server communication and training
infrastructure.
"""
def __init__(self, *, trained_agents: Optional[str] = None) -> None: # FIXME: str | None won't work for cli
"""
Initialize the LitAgent.
Args:
trained_agents: Optional string representing the trained agents.
This can be used to track which agents have been trained by this instance.
"""
self.trained_agents = trained_agents
self._trainer_ref: weakref.ReferenceType[Trainer] | None = None
self._runner_ref: weakref.ReferenceType[AgentRunner] | None = None
def set_trainer(self, trainer: Trainer) -> None:
"""
Set the trainer for this agent.
Args:
trainer: The Trainer instance that will handle training and validation.
"""
self._trainer_ref = weakref.ref(trainer)
@property
def trainer(self) -> Trainer:
"""
Get the trainer for this agent.
Returns:
The Trainer instance associated with this agent.
"""
if self._trainer_ref is None:
raise ValueError("Trainer has not been set for this agent.")
trainer = self._trainer_ref()
if trainer is None:
raise ValueError("Trainer reference is no longer valid (object has been garbage collected).")
return trainer
@property
def tracer(self) -> BaseTracer:
"""
Get the tracer for this agent.
Returns:
The BaseTracer instance associated with this agent.
"""
return self.trainer.tracer
def set_runner(self, runner: AgentRunner) -> None:
"""
Set the runner for this agent.
Args:
runner: The AgentRunner instance that will handle the execution of rollouts.
"""
self._runner_ref = weakref.ref(runner)
@property
def runner(self) -> AgentRunner:
"""
Get the runner for this agent.
Returns:
The AgentRunner instance associated with this agent.
"""
if self._runner_ref is None:
raise ValueError("Runner has not been set for this agent.")
runner = self._runner_ref()
if runner is None:
raise ValueError("Runner reference is no longer valid (object has been garbage collected).")
return runner
def training_rollout(self, task: TaskInput, rollout_id: str, resources: NamedResources) -> RolloutRawResult:
"""Defines the agent's behavior for a single training task.
This method should contain the logic for how the agent processes an
input, uses the provided resources (like LLMs or prompts), and
produces a result.
Args:
task: The task object received from the server, containing the
input data and metadata.
rollout_id: A unique identifier for the rollout, used for tracking
and reporting purposes.
resources: A dictionary of named resources (e.g., LLMs, prompt
templates) for the agent to use.
Returns:
The result of the rollout, which can be one of:
- None. The tracing should be handled by the agent runner.
- A float representing the final reward.
- A list of `Triplet` objects for detailed, step-by-step feedback.
- A list of `ReadableSpan` objects for OpenTelemetry tracing.
- A list of dictionaries for any trace spans.
- A complete `Rollout` object for full control over reporting.
"""
raise NotImplementedError("Subclasses must implement the `training_rollout` method.")
def validation_rollout(self, task: TaskInput, rollout_id: str, resources: NamedResources) -> RolloutRawResult:
"""Defines the agent's behavior for a single validation task.
By default, this method redirects to `training_rollout`. Override it
if the agent should behave differently during validation.
Args:
task: The task object received from the server, containing the
input data and metadata.
rollout_id: A unique identifier for the validation rollout,
used for tracking and reporting purposes.
resources: A dictionary of named resources for the agent to use.
Returns:
The result of the validation rollout. See `training_rollout` for
possible return types.
"""
return self.training_rollout(task, rollout_id, resources)
async def training_rollout_async(
self, task: TaskInput, rollout_id: str, resources: NamedResources
) -> RolloutRawResult:
"""Asynchronous version of `training_rollout`.
This method should be implemented by agents that perform asynchronous
operations (e.g., non-blocking I/O, concurrent API calls).
Args:
task: The task object received from the server.
rollout_id: A unique identifier for the training rollout,
used for tracking and reporting purposes.
resources: A dictionary of named resources for the agent to use.
Returns:
The result of the asynchronous training rollout.
"""
raise NotImplementedError("Async agents must implement the `training_rollout_async` method.")
async def validation_rollout_async(
self, task: TaskInput, rollout_id: str, resources: NamedResources
) -> RolloutRawResult:
"""Asynchronous version of `validation_rollout`.
By default, this method redirects to `training_rollout_async`.
Override it for different asynchronous validation behavior.
Args:
task: The task object received from the server.
rollout_id: A unique identifier for the validation rollout,
used for tracking and reporting purposes.
resources: A dictionary of named resources for the agent to use.
Returns:
The result of the asynchronous validation rollout.
"""
return await self.training_rollout_async(task, rollout_id, resources)
-16
View File
@@ -1,16 +0,0 @@
import logging
def configure_logger(level: int = logging.INFO, name: str = "agentlightning") -> logging.Logger:
logger = logging.getLogger(name)
logger.handlers.clear() # clear existing handlers
# log to stdout
handler = logging.StreamHandler()
handler.setLevel(level)
formatter = logging.Formatter("%(asctime)s [%(levelname)s] (Process-%(process)d %(name)s) %(message)s")
handler.setFormatter(formatter)
logger.addHandler(handler)
logger.setLevel(level)
logger.propagate = False # prevent double logging
return logger
-66
View File
@@ -1,66 +0,0 @@
import asyncio
import inspect
import warnings
from typing import TypedDict, Optional
from agentops.sdk.decorators import operation
class RewardSpanData(TypedDict):
type: "reward"
value: Optional[float]
def reward(fn: callable) -> callable:
"""
A decorator to wrap a function that computes rewards.
It will automatically handle the input and output of the function.
"""
def wrap_result(result: Optional[float]) -> RewardSpanData:
"""
Wrap the result of the function in a dict.
"""
if result is None:
return {"type": "reward", "value": None}
if not isinstance(result, (float, int)):
warnings.warn(f"Reward is ignored because it is not a number: {result}")
return {"type": "reward", "value": None}
return {"type": "reward", "value": float(result)}
# Check if the function is async
is_async = asyncio.iscoroutinefunction(fn) or inspect.iscoroutinefunction(fn)
if is_async:
async def wrapper_async(*args, **kwargs):
result: Optional[float] = None
@operation
async def agentops_reward_operation() -> RewardSpanData:
# The reward function we are interested in tracing
# It takes zero inputs and return a formatted dict
nonlocal result
result = await fn(*args, **kwargs)
return wrap_result(result)
await agentops_reward_operation()
return result
return wrapper_async
else:
def wrapper(*args, **kwargs):
result: Optional[float] = None
@operation
def agentops_reward_operation() -> RewardSpanData:
nonlocal result
result = fn(*args, **kwargs)
return wrap_result(result)
agentops_reward_operation()
return result
return wrapper
-253
View File
@@ -1,253 +0,0 @@
import asyncio
import json
import logging
import os
import time
from contextlib import nullcontext
from typing import List, Optional, Union, Dict, Any
import agentops
from opentelemetry.sdk.trace import ReadableSpan
from .client import AgentLightningClient
from .litagent import LitAgent
from .types import Rollout, Task, Triplet, RolloutRawResult
from .types import ParallelWorkerBase
from .tracer.base import BaseTracer
from .tracer import TripletExporter
logger = logging.getLogger(__name__)
class AgentRunner(ParallelWorkerBase):
"""Manages the agent's execution loop and integrates with AgentOps.
This class orchestrates the interaction between the agent (`LitAgent`) and
the server (`AgentLightningClient`). It handles polling for tasks, executing
the agent's logic, and reporting results back to the server. If enabled,
it will also automatically trace each rollout using AgentOps.
Attributes:
agent: The `LitAgent` instance containing the agent's logic.
client: The `AgentLightningClient` for server communication.
tracer: The tracer instance for this runner/worker.
worker_id: An optional identifier for the worker process.
max_tasks: The maximum number of tasks to process before stopping.
"""
def __init__(
self,
agent: LitAgent,
client: AgentLightningClient,
tracer: BaseTracer,
triplet_exporter: TripletExporter,
worker_id: Optional[int] = None,
max_tasks: Optional[int] = None,
):
super().__init__()
self.agent = agent
self.client = client
self.tracer = tracer
self.triplet_exporter = triplet_exporter
# Worker-specific attributes
self.worker_id = worker_id
self.max_tasks = max_tasks
def _log_prefix(self, rollout_id: Optional[str] = None) -> str:
"""Generates a standardized log prefix for the current worker."""
if self.worker_id is not None:
if rollout_id:
return f"[Worker {self.worker_id} | Rollout {rollout_id}]"
else:
return f"[Worker {self.worker_id}]"
if rollout_id:
return f"[Rollout {rollout_id}]"
return "[Default Worker]"
def _to_rollout_object(
self,
result: RolloutRawResult,
rollout_id: str,
) -> Rollout:
"""Standardizes the agent's return value into a Rollout object.
Args:
result: The output from the agent's rollout method.
rollout_id: The unique identifier for the current task.
Returns:
A standardized `Rollout` object for reporting to the server.
"""
trace: Any = None
final_reward: Optional[float] = None
triplets: Optional[List[Triplet]] = None
trace_spans: Optional[List[ReadableSpan]] = None
# Handle different types of results from the agent
# Case 1: result is a float (final reward)
if isinstance(result, float):
final_reward = result
# Case 2: result is a list of Triplets
if isinstance(result, list) and all(isinstance(t, Triplet) for t in result):
triplets = result # type: ignore
# Case 3: result is a list of ReadableSpan (OpenTelemetry spans)
if isinstance(result, list) and all(isinstance(t, ReadableSpan) for t in result):
trace_spans = result # type: ignore
trace = [json.loads(readable_span.to_json()) for readable_span in trace_spans] # type: ignore
# Case 4: result is a list of dict (trace JSON)
if isinstance(result, list) and all(isinstance(t, dict) for t in result):
trace = result
# Case 5: result is a Rollout object
if isinstance(result, Rollout):
final_reward = result.final_reward
triplets = result.triplets
trace = result.trace
# If the agent has tracing enabled, use the tracer's last trace if not already set
if self.tracer and (trace is None or trace_spans is None):
spans = self.tracer.get_last_trace()
if spans:
trace = [json.loads(readable_span.to_json()) for readable_span in spans]
trace_spans = spans
# Always extract triplets from the trace using TripletExporter
if trace_spans:
triplets = self.triplet_exporter.export(trace_spans)
# If the agent has triplets, use the last one for final reward if not set
if triplets and triplets[-1].reward is not None and final_reward is None:
final_reward = triplets[-1].reward
# Create the Rollout object with standardized fields
result_dict: Dict[str, Any] = {
"rollout_id": rollout_id,
}
if final_reward is not None:
result_dict["final_reward"] = final_reward
if triplets is not None:
result_dict["triplets"] = triplets
if trace is not None:
result_dict["trace"] = trace
if isinstance(result, Rollout):
return result.model_copy(update=result_dict)
return Rollout(**result_dict)
def run(self) -> bool:
"""Poll the task and rollout once synchronously."""
self.agent.set_runner(self) # Ensure the agent has a reference to this runner
task = self.client.poll_next_task()
if task is None:
logger.info(f"{self._log_prefix()} Poll returned no task. Exiting.")
return False
rollout_id = task.rollout_id
resources_id = task.resources_id
resources_update = None
if resources_id:
resources_update = self.client.get_resources_by_id(resources_id)
else:
logger.debug(f"{self._log_prefix(rollout_id)} No 'resources_id'. Fetching latest resources.")
resources_update = self.client.get_latest_resources()
if not resources_update:
logger.error(f"{self._log_prefix(rollout_id)} Failed to fetch resources. Skipping.")
return False
rollout_obj = Rollout(rollout_id=task.rollout_id) # Default empty rollout
try:
with self.tracer.trace_context(name=f"rollout_{rollout_id}"):
start_time = time.time()
rollout_method = self.agent.training_rollout if task.mode == "train" else self.agent.validation_rollout
# Pass the task input, not the whole task object
result = rollout_method(task.input, task.rollout_id, resources_update.resources)
rollout_obj = self._to_rollout_object(result, task.rollout_id)
end_time = time.time()
logger.info(
f"{self._log_prefix(rollout_id)} Completed in "
f"{end_time - start_time:.2f}s. Triplet length: "
f"{len(rollout_obj.triplets) if rollout_obj.triplets is not None else 'N/A'}. "
f"Reward: {rollout_obj.final_reward}"
)
except Exception:
logger.exception(f"{self._log_prefix(rollout_id)} Exception during rollout.")
finally:
self.client.post_rollout(rollout_obj)
return True
def iter(self) -> int:
"""Executes the synchronous polling and rollout loop."""
num_tasks_processed = 0
logger.info(f"{self._log_prefix()} Started sync rollouts (max: {self.max_tasks or 'unlimited'}).")
while self.max_tasks is None or num_tasks_processed < self.max_tasks:
if self.run():
num_tasks_processed += 1
if num_tasks_processed % 10 == 0 or num_tasks_processed == 1:
logger.info(f"{self._log_prefix()} Progress: {num_tasks_processed}/{self.max_tasks or 'unlimited'}")
logger.info(f"{self._log_prefix()} Finished sync rollouts. Processed {num_tasks_processed} tasks.")
return num_tasks_processed
async def run_async(self) -> bool:
"""Poll the task and rollout once."""
self.agent.set_runner(self) # Ensure the agent has a reference to this runner
task = await self.client.poll_next_task_async()
if task is None:
logger.info(f"{self._log_prefix()} Poll returned no task. Exiting.")
return False
rollout_id = task.rollout_id
resources_id = task.resources_id
resources_update = None
if resources_id:
resources_update = await self.client.get_resources_by_id_async(resources_id)
else:
logger.debug(f"{self._log_prefix(rollout_id)} No 'resources_id'. Fetching latest resources.")
resources_update = await self.client.get_latest_resources_async()
if not resources_update:
logger.error(f"{self._log_prefix(rollout_id)} Failed to fetch resources. Skipping.")
return False
rollout_obj = Rollout(rollout_id=task.rollout_id) # Default empty rollout
try:
with self.tracer.trace_context(name=f"rollout_{rollout_id}"):
start_time = time.time()
rollout_method = (
self.agent.training_rollout_async if task.mode == "train" else self.agent.validation_rollout_async
)
# Pass the task input, not the whole task object
result = await rollout_method(task.input, task.rollout_id, resources_update.resources)
rollout_obj = self._to_rollout_object(result, task.rollout_id)
end_time = time.time()
logger.info(
f"{self._log_prefix(rollout_id)} Completed in "
f"{end_time - start_time:.2f}s. Reward: {rollout_obj.final_reward}"
)
except Exception:
logger.exception(f"{self._log_prefix(rollout_id)} Exception during rollout.")
finally:
await self.client.post_rollout_async(rollout_obj)
return True
async def iter_async(self) -> int:
"""Executes the asynchronous polling and rollout loop."""
num_tasks_processed = 0
logger.info(f"{self._log_prefix()} Started async rollouts (max: {self.max_tasks or 'unlimited'}).")
while self.max_tasks is None or num_tasks_processed < self.max_tasks:
if await self.run_async():
num_tasks_processed += 1
if num_tasks_processed % 10 == 0 or num_tasks_processed == 1:
logger.info(f"{self._log_prefix()} Progress: {num_tasks_processed}/{self.max_tasks or 'unlimited'}")
logger.info(f"{self._log_prefix()} Finished async rollouts. Processed {num_tasks_processed} tasks.")
return num_tasks_processed
+183
View File
@@ -0,0 +1,183 @@
# Copyright (c) Microsoft. All rights reserved.
"""Shared Pydantic schemas for Agent Lightning."""
from __future__ import annotations
from enum import StrEnum
from typing import Any
from pydantic import BaseModel, ConfigDict, Field
class Event(BaseModel):
"""Single event in a trajectory.
Events are stored in insertion order per rollout. Position in the list
is the identity — no separate event ID needed. Only two event types
have well-known structure (model_request, reward). Everything else is
opaque pass-through.
"""
event_type: str # "model_request", "reward", or any user-defined string
rollout_id: str
attempt_id: str
timestamp: float # assigned by store at write time
data: dict[str, Any] # event-type-specific payload
class EventCreate(BaseModel):
"""Input for appending a user-defined event."""
event_type: str
data: dict[str, Any] = Field(default_factory=dict)
class ModelRequestData(BaseModel):
"""Well-known structure for event_type='model_request'.
Created automatically by the Gateway on every proxied LLM call.
Not enforced by the Store — this is a documentation/validation helper.
"""
model: str
model_version: int | None = None # training step of the serving model
request: dict[str, Any] # original request body (messages, temperature, etc.)
adjusted_params: dict[str, Any] | None = None # only if param adjustment changed anything
response: dict[str, Any] # full response body
latency_ms: float | None = None
http_status: int | None = None
status: str = "ok" # "ok" or "error"
retry_count: int = 0
usage: dict[str, Any] | None = None
finish_reason: str | None = None
class RewardData(BaseModel):
"""Well-known structure for event_type='reward'.
Reported by the environment, evaluator, or runner.
Not enforced by the Store — this is a documentation/validation helper.
"""
value: float # scalar reward (required)
message: str | None = None # optional human-readable explanation
source: str | None = None # e.g. "agent" for explicit evaluator output, "fallback" for system fill-in
reason: str | None = None # optional machine-readable explanation
class Model(BaseModel):
"""A registered model inference endpoint. Keyed by (model, endpoint)."""
model: str
endpoint: str
version: int = 0
class RolloutState(StrEnum):
"""Rollout lifecycle state values. Terminal states are final — no transitions out."""
QUEUING = "queuing"
RUNNING = "running"
SUCCEEDED = "succeeded"
FAILED = "failed"
# Valid state transitions (Store-enforced).
VALID_TRANSITIONS: dict[RolloutState, set[RolloutState]] = {
RolloutState.QUEUING: {RolloutState.RUNNING, RolloutState.FAILED},
RolloutState.RUNNING: {RolloutState.SUCCEEDED, RolloutState.FAILED},
# Terminal states — no transitions out.
RolloutState.SUCCEEDED: set(),
RolloutState.FAILED: set(),
}
TERMINAL_STATES: frozenset[RolloutState] = frozenset(
{
RolloutState.SUCCEEDED,
RolloutState.FAILED,
}
)
DEFAULT_ATTEMPT_ID = "0"
class RolloutLocalConfig(BaseModel):
"""Local runner config for a rollout."""
agent_class: str | None = None
env_map: dict[str, str] = Field(default_factory=dict)
class RolloutK8sConfig(BaseModel):
"""K8s runner config for a rollout."""
job_template: str | None = None
class RolloutConfig(BaseModel):
"""Controller-facing rollout config."""
timeout_seconds: int = 3600
local: RolloutLocalConfig | None = None
k8s: RolloutK8sConfig | None = None
class RolloutMetadata(BaseModel):
"""Algorithm-facing batch context."""
model_config = ConfigDict(extra="allow")
batch_idx: int | None = None
sample_idx_in_batch: int | None = None
class RolloutCreate(BaseModel):
"""Input for creating a rollout."""
input: Any
is_train: bool = True
config: RolloutConfig | None = None
metadata: RolloutMetadata | dict[str, Any] | None = None
# A caller-supplied id makes rollout creation idempotent and safe to retry.
rollout_id: str | None = None
class RolloutLifecycleStatus(BaseModel):
"""Controller-managed rollout lifecycle status."""
state: RolloutState = RolloutState.QUEUING
k8s_job_name: str | None = None
last_attempt_id: str | None = None
error_message: str | None = None
version: int = 1
created_at: float
updated_at: float
class RolloutStatusPatch(BaseModel):
"""Partial update for the nested rollout status object."""
model_config = ConfigDict(extra="forbid")
state: RolloutState | None = None
k8s_job_name: str | None = None
last_attempt_id: str | None = None
error_message: str | None = None
class RolloutPatch(BaseModel):
"""Partial rollout update. Only nested status may be patched."""
status: RolloutStatusPatch | None = None
class Rollout(BaseModel):
"""Unit of work. Lifecycle managed by the K8s controller."""
rollout_id: str
input: Any
is_train: bool = True
config: RolloutConfig
metadata: RolloutMetadata = Field(default_factory=RolloutMetadata)
status: RolloutLifecycleStatus
-353
View File
@@ -1,353 +0,0 @@
import asyncio
import logging
import time
import uuid
import threading
from contextlib import asynccontextmanager
from typing import Any, Dict, List, Optional, Literal
import uvicorn
from fastapi import FastAPI, HTTPException, Path
from pydantic import Field
from .types import (
Rollout,
Task,
TaskIfAny,
NamedResources,
GenericResponse,
ResourcesUpdate,
)
logger = logging.getLogger(__name__)
class ServerDataStore:
"""
A centralized, thread-safe, async, in-memory data store for the server's state.
This holds the task queue, versioned resources, and completed rollouts.
"""
def __init__(self):
self._task_queue: asyncio.Queue[Task] = asyncio.Queue()
self._processing_tasks: Dict[str, Task] = {} # Currently processing tasks
self._completed_rollouts: Dict[str, Rollout] = {}
# Store for versioned resources
self._resource_versions: Dict[str, NamedResources] = {}
self._latest_resources_id: Optional[str] = None
# Locks for thread-safe access
self._results_lock = asyncio.Lock()
self._resources_lock = asyncio.Lock()
async def add_task(
self,
sample: Any,
mode: Literal["train", "val", "test"] | None = None,
resources_id: str | None = None,
metadata: Dict[str, Any] | None = None,
) -> str:
"""
Adds a new task to the queue with specific metadata and returns its unique ID.
"""
rollout_id = f"rollout-{uuid.uuid4()}"
task = Task(
rollout_id=rollout_id,
input=sample,
mode=mode,
resources_id=resources_id,
create_time=time.time(),
num_claims=0,
metadata=metadata or {},
)
await self._task_queue.put(task)
logger.info(f"Task queued: {rollout_id} (mode: {mode}, resources_id: {resources_id})")
return rollout_id
async def get_next_task(self) -> Optional[Task]:
"""
Retrieves the next task from the queue without blocking.
Returns None if the queue is empty.
"""
try:
async with self._results_lock:
task = self._task_queue.get_nowait()
task = task.model_copy(
update={
"last_claim_time": time.time(),
"num_claims": (task.num_claims or 0) + 1,
}
)
self._processing_tasks[task.rollout_id] = task
if task.num_claims == 1:
logger.debug(f"Next task retrieved: {task.rollout_id}")
else:
logger.info(f"Task {task.rollout_id} re-claimed (attempt {task.num_claims})")
return task
except asyncio.QueueEmpty:
return None
async def update_resources(self, update: ResourcesUpdate):
"""
Safely stores a new version of named resources and sets it as the latest.
"""
# TODO: evict old resources if necessary.
async with self._resources_lock:
self._resource_versions[update.resources_id] = update.resources
self._latest_resources_id = update.resources_id
logger.info(f"Resources updated. New version '{update.resources_id}' is now latest.")
async def get_resources_by_id(self, resources_id: str) -> Optional[ResourcesUpdate]:
"""
Safely retrieves a specific version of named resources by its ID.
"""
async with self._resources_lock:
resources = self._resource_versions.get(resources_id)
if resources:
return ResourcesUpdate(resources_id=resources_id, resources=resources)
return None
async def get_latest_resources(self) -> Optional[ResourcesUpdate]:
"""
Safely retrieves the latest version of named resources.
"""
if self._latest_resources_id:
return await self.get_resources_by_id(self._latest_resources_id)
return None
async def store_rollout(self, rollout: Rollout):
"""
Safely stores a completed rollout from a client.
"""
async with self._results_lock:
self._processing_tasks.pop(rollout.rollout_id, None)
self._completed_rollouts[rollout.rollout_id] = rollout
logger.info(f"Rollout received and stored: {rollout.rollout_id}")
async def retrieve_rollout(self, rollout_id: str) -> Optional[Rollout]:
"""
Safely retrieves a single rollout by its ID, removing it from the store.
"""
async with self._results_lock:
return self._completed_rollouts.pop(rollout_id, None)
async def retrieve_completed_rollouts(self) -> List[Rollout]:
"""
Retrieves all completed rollouts and clears the store.
"""
async with self._results_lock:
rollouts = list(self._completed_rollouts.values())
self._completed_rollouts.clear()
return rollouts
def get_processing_tasks(self) -> Dict[str, Task]:
"""Returns a copy of currently processing tasks for timeout checking."""
return self._processing_tasks.copy()
async def requeue_task(self, task: Task):
"""Requeues a task that has timed out and removes it from processing."""
logger.warning(f"Requeuing task {task.rollout_id} after timeout (attempt {task.num_claims})")
async with self._results_lock:
# Remove from processing tasks
self._processing_tasks.pop(task.rollout_id, None)
self._task_queue.put_nowait(task)
class AgentLightningServer:
"""
The main SDK class for developers to control the Agent Lightning Server.
This class manages the server lifecycle, task queueing, resources updates,
and retrieval of results, providing a simple interface for the optimization logic.
"""
def __init__(self, host: str = "127.0.0.1", port: int = 8000, task_timeout_seconds: float = 300.0):
"""
Initializes the server controller.
Args:
host: The host to bind the server to.
port: The port to bind the server to.
task_timeout_seconds: Time in seconds after which a claimed task is considered stale and requeued.
"""
self.host = host
self.port = port
self.endpoint = f"http://{host}:{port}"
self._task_timeout_seconds = task_timeout_seconds
# Defer initialization and use event for cross-thread communication
self._store: Optional[ServerDataStore] = None
self.loop: Optional[asyncio.AbstractEventLoop] = None
self.startup_event = threading.Event()
# Create FastAPI app instance with a lifespan manager
self._app = FastAPI(lifespan=self._lifespan)
self._setup_routes()
self._uvicorn_config = uvicorn.Config(self._app, host=self.host, port=self.port, log_level="info")
self._uvicorn_server = uvicorn.Server(self._uvicorn_config)
# --- ADDED: Lifespan context manager ---
@asynccontextmanager
async def _lifespan(self, app: FastAPI):
"""
Manages server startup and shutdown. This runs inside the server's event loop.
"""
logger.info("Server is starting up...")
self.loop = asyncio.get_running_loop()
self._store = ServerDataStore() # Initialize data store here
self.startup_event.set() # Signal that the server is ready
yield
logger.info("Server is shutting down.")
self._store = None
self.startup_event.clear() # Clear the startup event
self.loop = None
async def _check_and_requeue_stale_tasks(self):
"""
Check for stale tasks and requeue them. Called reactively during get_next_task.
"""
current_time = time.time()
# Ensure store is initialized before checking
if not self._store:
return
processing_tasks = self._store.get_processing_tasks()
for rollout_id, task in processing_tasks.items():
if task.last_claim_time and current_time - task.last_claim_time > self._task_timeout_seconds:
await self._store.requeue_task(task)
logger.warning(
f"Task {task.rollout_id} timed out after {self._task_timeout_seconds}s, requeued (attempt {task.num_claims})"
)
def _setup_routes(self):
"""Setup FastAPI routes."""
@self._app.get("/task", response_model=TaskIfAny)
async def next_task() -> TaskIfAny:
"""Endpoint for clients to poll for the next available task."""
await self._check_and_requeue_stale_tasks()
if not self._store:
return TaskIfAny(is_available=False)
task = await self._store.get_next_task()
if task:
logger.debug(f"Serving task {task.rollout_id} to a client.")
return TaskIfAny(is_available=True, task=task)
else:
logger.debug("No task available for client.")
return TaskIfAny(is_available=False)
@self._app.get("/resources/latest", response_model=ResourcesUpdate)
async def fetch_latest_resources() -> ResourcesUpdate:
"""Endpoint for clients to poll for the latest available resources."""
if not self._store:
raise HTTPException(status_code=503, detail="Server not fully initialized.")
resources_update = await self._store.get_latest_resources()
if not resources_update:
raise HTTPException(status_code=404, detail="No resources have been set on the server.")
logger.debug(f"Serving latest resources '{resources_update.resources_id}' to a client.")
return resources_update
@self._app.get("/resources/{resource_id}", response_model=ResourcesUpdate)
async def fetch_resources_by_id(
resource_id: str = Path(..., description="The unique identifier for the resource version.")
) -> ResourcesUpdate:
"""Endpoint for clients to fetch a specific version of resources."""
if not self._store:
raise HTTPException(status_code=503, detail="Server not fully initialized.")
resources_update = await self._store.get_resources_by_id(resource_id)
if not resources_update:
raise HTTPException(status_code=404, detail=f"Resource ID '{resource_id}' not found.")
logger.debug(f"Serving resources for ID '{resource_id}' to a client.")
return resources_update
@self._app.post("/rollout", response_model=GenericResponse)
async def post_rollout(payload: Rollout) -> GenericResponse:
"""Endpoint for clients to report a completed rollout."""
if not self._store:
raise HTTPException(status_code=503, detail="Server not fully initialized.")
await self._store.store_rollout(payload)
return GenericResponse(
status="ok",
message=f"Rollout {payload.rollout_id} received and stored.",
)
async def start(self):
"""Starts the FastAPI server in the background."""
logger.info(f"Starting server at {self.endpoint}")
asyncio.create_task(self._uvicorn_server.serve())
await asyncio.sleep(1) # Allow time for server to start up.
async def stop(self):
"""Gracefully stops the running FastAPI server."""
if self._uvicorn_server.started:
logger.info("Stopping server...")
self._uvicorn_server.should_exit = True
await asyncio.sleep(1) # Allow time for graceful shutdown.
logger.info("Server stopped.")
async def run_forever(self):
"""
Runs the server indefinitely until stopped.
This is useful when async start and stop methods do not work.
"""
await self._uvicorn_server.serve()
async def queue_task(
self,
sample: Any,
mode: Literal["train", "val", "test"] | None = None,
resources_id: str | None = None,
metadata: Dict[str, Any] | None = None,
) -> str:
"""
Adds a task to the queue for a client to process.
"""
if not self._store:
raise RuntimeError("Store not initialized. The server may not be running.")
return await self._store.add_task(sample, mode=mode, resources_id=resources_id, metadata=metadata)
async def update_resources(self, resources: NamedResources) -> str:
"""
Updates the resources, creating a new version and setting it as the latest.
"""
if not self._store:
raise RuntimeError("Store not initialized. The server may not be running.")
resources_id = f"res-{uuid.uuid4()}"
update = ResourcesUpdate(resources_id=resources_id, resources=resources)
await self._store.update_resources(update)
return resources_id
async def get_completed_rollout(self, rollout_id: str) -> Optional[Rollout]:
"""
Retrieves a specific completed rollout by its ID.
"""
if not self._store:
raise RuntimeError("Store not initialized. The server may not be running.")
return await self._store.retrieve_rollout(rollout_id)
async def poll_completed_rollout(self, rollout_id: str, timeout: Optional[float] = None) -> Optional[Rollout]:
"""
Polls for a completed rollout by its ID, waiting up to `timeout` seconds.
"""
start_time = time.time()
while True:
rollout = await self.get_completed_rollout(rollout_id)
if rollout:
return rollout
if timeout and (time.time() - start_time) >= timeout:
return None
await asyncio.sleep(1)
async def retrieve_completed_rollouts(self) -> List[Rollout]:
"""
Retrieves all available completed trajectories and clears the internal store.
"""
if not self._store:
raise RuntimeError("Store not initialized. The server may not be running.")
return await self._store.retrieve_completed_rollouts()
+1
View File
@@ -0,0 +1 @@
# Copyright (c) Microsoft. All rights reserved.
+27
View File
@@ -0,0 +1,27 @@
# Copyright (c) Microsoft. All rights reserved.
"""Hydra entrypoint for the Agent Lightning server."""
from __future__ import annotations
import hydra
import uvicorn
from omegaconf import DictConfig
from agentlightning.server.app import create_app
@hydra.main(version_base=None, config_path="../config", config_name="server")
def main(config: DictConfig) -> None:
application = create_app(config)
uvicorn.run(
application,
host=str(config.host),
port=int(config.port),
workers=1,
timeout_keep_alive=120,
)
if __name__ == "__main__":
main()
+93
View File
@@ -0,0 +1,93 @@
# Copyright (c) Microsoft. All rights reserved.
"""FastAPI application — lifespan, mount routes, wire proxy."""
from __future__ import annotations
from collections.abc import AsyncIterator, Mapping
from contextlib import asynccontextmanager
from typing import Any, cast
import httpx
import structlog
from fastapi import Depends, FastAPI, Request
from fastapi.exceptions import HTTPException
from omegaconf import DictConfig, OmegaConf
from agentlightning.server.proxy import ProxyPauseState, ProxyRouter
from agentlightning.server.routes import events, models, proxy, rollouts
log = structlog.get_logger()
def _server_config(config: Mapping[str, Any] | DictConfig | None) -> dict[str, Any]:
if config is None:
raise ValueError("server config is required")
elif OmegaConf.is_config(config):
raw = dict(cast(Any, OmegaConf.to_container(config, resolve=True)))
else:
raw = dict(config)
return raw
def _build_auth_dependency(key: str):
"""Return a dependency that validates the optional API key."""
async def verify_key(request: Request) -> None:
if not key:
return
auth_header = request.headers.get("authorization", "")
if auth_header.startswith("Bearer ") and auth_header[7:] == key:
return
if request.headers.get("x-api-key", "") == key:
return
raise HTTPException(status_code=401, detail="Invalid or missing API key")
return verify_key
def create_app(config: Mapping[str, Any] | DictConfig | None = None) -> FastAPI:
"""Create and configure the FastAPI application."""
server_config = _server_config(config)
key = str(server_config["key"] or "")
if not key:
log.warning("AGL_KEY not set — authentication disabled. Do not use in production.")
verify_key = _build_auth_dependency(key)
default_proxy = server_config["default_proxy"]
log.info("Proxy config loaded", model_name=default_proxy["model_name"])
@asynccontextmanager
async def lifespan(app: FastAPI) -> AsyncIterator[None]:
app.state.proxy_pause_state = ProxyPauseState()
app.state.proxy_router = ProxyRouter(default_proxy)
async with httpx.AsyncClient(timeout=httpx.Timeout(timeout=300.0)) as client:
app.state.http_client = client
yield
app = FastAPI(title="Agent Lightning", version="1.0.0", lifespan=lifespan)
# Health check — no auth.
@app.get("/healthz")
async def healthz() -> dict[str, str]:
return {"status": "ok"}
# Store API routes — all require auth.
app.include_router(rollouts.router, prefix="/api", dependencies=[Depends(verify_key)])
app.include_router(events.router, prefix="/api", dependencies=[Depends(verify_key)])
app.include_router(models.router, prefix="/api", dependencies=[Depends(verify_key)])
# Proxy routes (LLM proxy + event ingestion) — require agent-facing auth.
app.include_router(proxy.router, dependencies=[Depends(verify_key)])
# Proxy management routes use the same server key as the rest of the API.
app.include_router(proxy.management_router, dependencies=[Depends(verify_key)])
return app
+255
View File
@@ -0,0 +1,255 @@
# Copyright (c) Microsoft. All rights reserved.
"""Server-side OpenAI chat-completions proxy."""
from __future__ import annotations
import asyncio
import hashlib
import json
import random
import time
from collections.abc import Mapping
from dataclasses import dataclass, field
from typing import Any
import httpx
import structlog
from fastapi import HTTPException, Response
from fastapi.responses import JSONResponse
from agentlightning.schemas import Model
from agentlightning.server.routes.events import record_event
from agentlightning.server.store import _models
log = structlog.get_logger()
_UPSTREAM_MAX_ATTEMPTS = 6
_RETRY_STATUS_CODES = {408, 409, 429}
_RETRY_BACKOFF_BASE_SECONDS = 0.5
_RETRY_BACKOFF_CAP_SECONDS = 8.0
class NoServersError(Exception):
def __init__(self, model: str) -> None:
self.model = model
super().__init__(f"No servers available for model '{model}'")
class ProxyRouter:
"""Selects the configured default model server and rewrites request params."""
def __init__(self, default_proxy: Mapping[str, Any]) -> None:
self._model_name = str(default_proxy["model_name"])
self._train_temperature = float(default_proxy["train"]["temperature"])
self._val_temperature = float(default_proxy["val"]["temperature"])
self._include_log_probs = bool(default_proxy.get("include_log_probs", True))
@property
def model_name(self) -> str:
return self._model_name
def select_server(self, model: str, rollout_id: str) -> Model:
servers = _models.get(model, {})
if not servers:
raise NoServersError(model)
# Stable ordering pins each rollout to one endpoint for prefix-cache reuse.
pool = [servers[endpoint] for endpoint in sorted(servers)]
digest = hashlib.sha256(rollout_id.encode("utf-8")).digest()
index = int.from_bytes(digest[:8], "big") % len(pool)
return pool[index]
def prepare_body(self, body: dict[str, Any], mode: str) -> dict[str, Any]:
if mode == "train":
prepared = {
**body,
"model": self._model_name,
"temperature": self._train_temperature,
"return_token_ids": True,
}
if self._include_log_probs:
prepared["logprobs"] = True
return prepared
if mode == "val":
prepared = {
**body,
"model": self._model_name,
"temperature": self._val_temperature,
"return_token_ids": True,
}
return prepared
raise ValueError(f"Unsupported proxy mode: {mode}")
@dataclass
class ProxyPauseState:
paused: bool = False
retry_after_seconds: int = 5
reason: str | None = None
inflight: int = 0
lock: asyncio.Lock = field(default_factory=asyncio.Lock)
async def forward_request(
*,
client: httpx.AsyncClient,
server: Model,
body: dict[str, Any],
upstream_path: str = "chat/completions",
rollout_id: str,
attempt_id: str,
pause_state: ProxyPauseState | None = None,
) -> Response:
if pause_state is not None:
async with pause_state.lock:
if pause_state.paused:
retry_after = pause_state.retry_after_seconds
reason = pause_state.reason
return Response(
status_code=429,
headers={"Retry-After": str(retry_after), "X-Agl-Paused": "true"},
content=json.dumps({"error": "gateway paused", "reason": reason}),
media_type="application/json",
)
pause_state.inflight += 1
try:
if body.get("stream", False):
raise HTTPException(status_code=400, detail="Streaming responses are not supported")
url = f"{server.endpoint.rstrip('/')}/{upstream_path}"
log.debug("Proxying request", rollout_id=rollout_id, model=server.model, path=upstream_path)
started_at = time.perf_counter()
response = await _send_upstream_with_retries(client=client, url=url, body=body)
latency_ms = (time.perf_counter() - started_at) * 1000
response_body = (
response.json() if response.headers.get("content-type", "").startswith("application/json") else {}
)
_capture_event(
rollout_id=rollout_id,
attempt_id=attempt_id,
request_body=body,
response_body=response_body,
server=server,
latency_ms=latency_ms,
http_status=response.status_code,
status=_status_from_http_status(response.status_code),
retry_count=int(response.extensions.get("agl_retry_count", 0)),
)
return JSONResponse(content=response_body, status_code=response.status_code)
finally:
if pause_state is not None:
await _dec_inflight(pause_state)
async def _send_upstream_with_retries(
*,
client: httpx.AsyncClient,
url: str,
body: dict[str, Any],
) -> httpx.Response:
for attempt_index in range(_UPSTREAM_MAX_ATTEMPTS):
try:
response = await client.post(url, json=body, headers={"content-type": "application/json"})
except httpx.TimeoutException as exc:
if attempt_index == _UPSTREAM_MAX_ATTEMPTS - 1:
raise HTTPException(status_code=504, detail="Upstream model server timed out") from exc
await _sleep_before_retry(url=url, attempt_index=attempt_index, reason="timeout")
continue
except httpx.TransportError as exc:
if attempt_index == _UPSTREAM_MAX_ATTEMPTS - 1:
raise HTTPException(status_code=502, detail="Upstream model server request failed") from exc
await _sleep_before_retry(url=url, attempt_index=attempt_index, reason="transport error")
continue
if not _is_retryable_status(response.status_code) or attempt_index == _UPSTREAM_MAX_ATTEMPTS - 1:
response.extensions["agl_retry_count"] = attempt_index
return response
await response.aclose()
await _sleep_before_retry(
url=url,
attempt_index=attempt_index,
reason=f"status {response.status_code}",
)
raise HTTPException(status_code=502, detail="Upstream model server request failed")
async def _sleep_before_retry(*, url: str, attempt_index: int, reason: str) -> None:
delay = _retry_delay_seconds(attempt_index)
log.warning(
"Retrying upstream request",
url=url,
attempt=attempt_index + 1,
max_attempts=_UPSTREAM_MAX_ATTEMPTS,
delay_seconds=round(delay, 3),
reason=reason,
)
await asyncio.sleep(delay)
def _is_retryable_status(status_code: int) -> bool:
return status_code in _RETRY_STATUS_CODES or status_code >= 500
def _retry_delay_seconds(attempt_index: int) -> float:
delay = min(_RETRY_BACKOFF_BASE_SECONDS * (2**attempt_index), _RETRY_BACKOFF_CAP_SECONDS)
return delay * random.uniform(0.75, 1.25)
async def _dec_inflight(pause_state: ProxyPauseState) -> None:
async with pause_state.lock:
pause_state.inflight = max(0, pause_state.inflight - 1)
def _capture_event(
*,
rollout_id: str,
attempt_id: str,
request_body: dict[str, Any],
response_body: dict[str, Any],
server: Model,
latency_ms: float,
http_status: int,
status: str,
retry_count: int,
) -> None:
record_event(
rollout_id,
attempt_id,
"model_request",
{
"model": server.model,
"model_version": server.version,
"request": request_body,
"response": response_body,
"server": {"model": server.model, "endpoint": server.endpoint, "version": server.version},
"latency_ms": latency_ms,
"http_status": http_status,
"status": status,
"retry_count": retry_count,
"usage": _extract_usage(response_body),
"finish_reason": _extract_finish_reason(response_body),
},
)
def _status_from_http_status(http_status: int) -> str:
return "ok" if http_status < 400 else "error"
def _extract_usage(response_body: dict[str, Any]) -> dict[str, Any] | None:
usage = response_body.get("usage")
return usage if isinstance(usage, dict) else None
def _extract_finish_reason(response_body: dict[str, Any]) -> str | None:
choices = response_body.get("choices")
if isinstance(choices, list) and choices:
reason = choices[0].get("finish_reason") if isinstance(choices[0], dict) else None
if isinstance(reason, str) and reason:
return reason
return None
+1
View File
@@ -0,0 +1 @@
# Copyright (c) Microsoft. All rights reserved.
+206
View File
@@ -0,0 +1,206 @@
# Copyright (c) Microsoft. All rights reserved.
"""Event API routes."""
from __future__ import annotations
import math
import time
from typing import Any
from fastapi import APIRouter, Query
from fastapi.exceptions import HTTPException
from agentlightning.schemas import DEFAULT_ATTEMPT_ID, Event, EventCreate
from agentlightning.server.store import _events, _rollouts
router = APIRouter(tags=["events"])
def _not_found(rollout_id: str) -> HTTPException:
return HTTPException(status_code=404, detail=f"Rollout not found: {rollout_id}")
def record_event(rollout_id: str, attempt_id: str, event_type: str, data: dict[str, Any]) -> Event:
"""Append a single event for an existing rollout."""
if rollout_id not in _rollouts:
raise _not_found(rollout_id)
event = Event(
event_type=event_type,
rollout_id=rollout_id,
attempt_id=attempt_id,
timestamp=time.time(),
data=data,
)
rid_events = _events[rollout_id]
if attempt_id not in rid_events:
rid_events[attempt_id] = []
rid_events[attempt_id].append(event)
return event
def _query_events(
rollout_id: str,
*,
event_type: str | None = None,
) -> list[Event]:
if rollout_id not in _rollouts:
raise _not_found(rollout_id)
rollout = _rollouts[rollout_id]
attempt_id = rollout.status.last_attempt_id or DEFAULT_ATTEMPT_ID
rid_events = _events.get(rollout_id, {})
events = rid_events.get(attempt_id, [])
if event_type is not None:
events = [event for event in events if event.event_type == event_type]
return events
def _extract_choice_log_probs(choice: dict[str, Any]) -> list[float] | None:
"""Extract chosen-token logprobs from a single choice.
Returns the per-token logprobs, or None when they are missing or unusable
(no logprobs field, unrecognized schema, or any non-finite/non-float value).
Never raises: a malformed response yields None so the triplet query stays a
successful HTTP response and the training bridge drops the sample.
"""
lp = choice.get("logprobs")
if not isinstance(lp, dict):
return None
raw: list[Any]
if isinstance(lp.get("content"), list):
# OpenAI chat schema: logprobs.content -> [{"logprob": float, ...}, ...]
raw = []
for item in lp["content"]:
if not isinstance(item, dict) or "logprob" not in item:
return None
raw.append(item["logprob"])
elif isinstance(lp.get("token_logprobs"), list):
# Completions schema: logprobs.token_logprobs -> [float, ...]
raw = list(lp["token_logprobs"])
else:
return None
out: list[float] = []
for v in raw:
try:
f = float(v)
except (TypeError, ValueError):
return None
if not math.isfinite(f):
return None
out.append(f)
return out
def _trim_model_request(data: dict[str, Any]) -> dict[str, Any]:
"""Extract prompt_token_ids and response_token_ids from a model_request event.
Non-streaming gateway responses use a dict shape with prompt_token_ids at
top level for chat completions or per choice for completions, and token_ids
per choice. Legacy raw-chunk format (list) is also supported for backward
compatibility.
"""
resp = data.get("response")
prompt_token_ids: list[int] = []
response_token_ids: list[int] = []
response_log_probs: list[float] | None = None
if isinstance(resp, dict):
prompt_token_ids = resp.get("prompt_token_ids", [])
choices = resp.get("choices", [])
if choices:
if not prompt_token_ids:
prompt_token_ids = choices[0].get("prompt_token_ids", [])
response_token_ids = choices[0].get("token_ids", [])
response_log_probs = _extract_choice_log_probs(choices[0])
elif isinstance(resp, list):
# Legacy: raw SSE chunks (pre-assembly format, backward compat).
for chunk in resp:
if not prompt_token_ids and chunk.get("prompt_token_ids"):
prompt_token_ids = chunk["prompt_token_ids"]
choices = chunk.get("choices", [])
if choices:
tids = choices[0].get("token_ids")
if tids:
response_token_ids.extend(tids)
srv = data.get("server", {})
trimmed = {
"prompt_token_ids": prompt_token_ids,
"response_token_ids": response_token_ids,
"response_log_probs": response_log_probs,
"server": {"model": srv.get("model"), "version": srv.get("version")},
}
for key in ("http_status", "status"):
if key in data:
trimmed[key] = data[key]
if isinstance(resp, dict) and "error" in resp:
trimmed["error"] = resp["error"]
return trimmed
def _trim_reward(data: dict[str, Any]) -> dict[str, Any]:
"""Keep only the scalar value from a reward event."""
trimmed = {"value": data.get("value")}
for key in ("source", "reason"):
if key in data:
trimmed[key] = data[key]
return trimmed
def _to_triplet_format(event: Event) -> Event:
"""Trim event data for triplet consumption.
- model_request: extract prompt_token_ids + response_token_ids only
- reward: keep only the scalar value
- other event types: pass through unchanged
"""
if event.event_type == "model_request":
trimmed = _trim_model_request(event.data)
return event.model_copy(update={"data": trimmed})
elif event.event_type == "reward":
trimmed = _trim_reward(event.data)
return event.model_copy(update={"data": trimmed})
return event
def _dedupe_model_requests_by_prompt_token_ids(events: list[Event]) -> list[Event]:
"""Keep only the last model_request event for each prompt_token_ids key."""
last_index_by_prompt: dict[tuple[Any, ...], int] = {}
for index, event in enumerate(events):
if event.event_type != "model_request":
continue
prompt_token_ids = event.data.get("prompt_token_ids", [])
prompt_key = tuple(prompt_token_ids) if isinstance(prompt_token_ids, list) else ()
last_index_by_prompt[prompt_key] = index
last_indexes = set(last_index_by_prompt.values())
return [event for index, event in enumerate(events) if event.event_type != "model_request" or index in last_indexes]
@router.post("/rollouts/{rollout_id}/attempt/{attempt_id}/events", response_model=Event)
async def post_event(rollout_id: str, body: EventCreate, attempt_id: str) -> Event:
"""Post an event for one rollout attempt."""
return record_event(rollout_id, attempt_id, body.event_type, body.data)
@router.get("/rollouts/{rollout_id}/events", response_model=list[Event])
async def query_events(
rollout_id: str,
event_type: str | None = None,
format: str | None = Query(None, description="Set to 'triplet' to trim events for RL training"),
) -> list[Event]:
"""Query events for the default rollout attempt."""
events = _query_events(
rollout_id=rollout_id,
event_type=event_type,
)
if format == "triplet":
events = [_to_triplet_format(e) for e in events]
events = _dedupe_model_requests_by_prompt_token_ids(events)
return events
+31
View File
@@ -0,0 +1,31 @@
# Copyright (c) Microsoft. All rights reserved.
"""Model server API routes."""
from __future__ import annotations
from fastapi import APIRouter
from agentlightning.schemas import Model
from agentlightning.server.store import _models
router = APIRouter(tags=["models"])
@router.post("/models", status_code=201, response_model=list[Model])
async def register_models(body: list[Model]) -> list[Model]:
"""Register model server(s). Upsert by (model, endpoint)."""
results: list[Model] = []
for req in body:
if req.model not in _models:
_models[req.model] = {}
_models[req.model][req.endpoint] = req
results.append(req)
return results
@router.delete("/models")
async def delete_all_models() -> dict[str, str]:
"""Remove all model servers."""
_models.clear()
return {"status": "ok"}
+137
View File
@@ -0,0 +1,137 @@
# Copyright (c) Microsoft. All rights reserved.
"""Proxy forwarding and pause/drain management routes."""
from __future__ import annotations
import json
import structlog
from fastapi import APIRouter, Request, Response
from fastapi.exceptions import HTTPException
from pydantic import BaseModel
from agentlightning.server.proxy import NoServersError, ProxyPauseState, ProxyRouter, forward_request
from agentlightning.server.store import _rollouts
log = structlog.get_logger()
router = APIRouter(tags=["gateway"])
management_router = APIRouter(tags=["gateway-management"], prefix="/proxy")
def _get_pause_state(request: Request) -> ProxyPauseState:
state: ProxyPauseState | None = getattr(request.app.state, "proxy_pause_state", None)
if state is None:
raise HTTPException(status_code=503, detail="Gateway pause state not configured")
return state
@router.post(
"/proxy/rollout/{rollout_id}/attempt/{attempt_id}/mode/{mode}/openai/v1/{upstream_path:path}",
)
async def llm_proxy(rollout_id: str, attempt_id: str, mode: str, upstream_path: str, request: Request) -> Response:
"""LLM reverse proxy — forwards to model server, captures events."""
if mode not in {"train", "val"}:
raise HTTPException(status_code=404, detail=f"Unsupported proxy mode: {mode}")
if upstream_path not in {"chat/completions", "completions"}:
raise HTTPException(status_code=404, detail=f"Unsupported upstream path: {upstream_path}")
# Validate rollout exists.
if rollout_id not in _rollouts:
raise HTTPException(status_code=404, detail=f"Rollout not found: {rollout_id}")
# Get gateway router and httpx client from app state.
proxy_router: ProxyRouter | None = getattr(request.app.state, "proxy_router", None)
http_client = getattr(request.app.state, "http_client", None)
if proxy_router is None or http_client is None:
raise HTTPException(status_code=503, detail="Proxy not configured")
pause_state: ProxyPauseState | None = getattr(request.app.state, "proxy_pause_state", None)
# Read and parse request body.
raw_body = await request.body()
try:
body = json.loads(raw_body) if raw_body else {}
except json.JSONDecodeError:
raise HTTPException(status_code=400, detail="Invalid JSON in request body") from None
# Select server.
model_name = proxy_router.model_name
try:
server = proxy_router.select_server(model_name, rollout_id)
except NoServersError:
raise HTTPException(status_code=503, detail=f"No servers available for model '{model_name}'") from None
prepared_body = proxy_router.prepare_body(body, mode)
# Server endpoint includes the OpenAI base path (e.g., "http://vllm:8000/v1").
return await forward_request(
client=http_client,
server=server,
body=prepared_body,
upstream_path=upstream_path,
rollout_id=rollout_id,
attempt_id=attempt_id,
pause_state=pause_state,
)
# --- Management routes ------------------------------------------------------
class PauseRequest(BaseModel):
retry_after_seconds: int = 5
reason: str | None = None
class PauseStateResponse(BaseModel):
paused: bool
retry_after_seconds: int
reason: str | None
inflight: int
@management_router.post("/pause", response_model=PauseStateResponse)
async def pause_proxy(body: PauseRequest, request: Request) -> PauseStateResponse:
"""Pause new proxy forwarding requests while existing in-flight requests drain."""
state = _get_pause_state(request)
async with state.lock:
state.paused = True
state.retry_after_seconds = body.retry_after_seconds
state.reason = body.reason
return PauseStateResponse(
paused=state.paused,
retry_after_seconds=state.retry_after_seconds,
reason=state.reason,
inflight=state.inflight,
)
@management_router.post("/resume", response_model=PauseStateResponse)
async def resume_proxy(request: Request) -> PauseStateResponse:
"""Resume proxy forwarding after a pause."""
state = _get_pause_state(request)
async with state.lock:
state.paused = False
state.reason = None
return PauseStateResponse(
paused=state.paused,
retry_after_seconds=state.retry_after_seconds,
reason=state.reason,
inflight=state.inflight,
)
@management_router.get("/state", response_model=PauseStateResponse)
async def proxy_state(request: Request) -> PauseStateResponse:
"""Return the proxy pause state and in-flight request count."""
state = _get_pause_state(request)
async with state.lock:
return PauseStateResponse(
paused=state.paused,
retry_after_seconds=state.retry_after_seconds,
reason=state.reason,
inflight=state.inflight,
)
+220
View File
@@ -0,0 +1,220 @@
# Copyright (c) Microsoft. All rights reserved.
"""Rollout API routes."""
from __future__ import annotations
import time
import uuid
from typing import Annotated
from fastapi import APIRouter, Query
from fastapi.exceptions import HTTPException
from pydantic import BaseModel
from agentlightning.schemas import (
TERMINAL_STATES,
VALID_TRANSITIONS,
Rollout,
RolloutConfig,
RolloutCreate,
RolloutLifecycleStatus,
RolloutMetadata,
RolloutPatch,
RolloutState,
)
from agentlightning.server.store import _events, _rollouts, _terminal_order
router = APIRouter(tags=["rollouts"])
class RolloutDetail(BaseModel):
"""Rollout with attempt list."""
rollout: Rollout
attempts: list[str]
class TerminalRolloutItem(BaseModel):
"""Lightweight projection of a terminal rollout (no input/config payload)."""
rollout_id: str
state: RolloutState
data_id: str
is_train: bool
class TerminalRolloutsPage(BaseModel):
"""A page of terminal rollouts plus the cursor to fetch the next page."""
items: list[TerminalRolloutItem]
next_after: int
total_terminal: int
def _not_found(rollout_id: str) -> HTTPException:
return HTTPException(status_code=404, detail=f"Rollout not found: {rollout_id}")
def _invalid_transition(rollout_id: str, from_status: str, to_status: str) -> HTTPException:
return HTTPException(
status_code=409,
detail=f"Rollout {rollout_id}: cannot transition {from_status} -> {to_status}",
)
def _get_rollout(rollout_id: str) -> Rollout:
try:
return _rollouts[rollout_id]
except KeyError:
raise _not_found(rollout_id) from None
def _metadata_from_request(req: RolloutCreate) -> RolloutMetadata:
if isinstance(req.metadata, dict):
return RolloutMetadata(**req.metadata)
if req.metadata is not None:
return req.metadata
return RolloutMetadata()
def _list_attempts(rollout_id: str) -> list[str]:
if rollout_id not in _rollouts:
raise _not_found(rollout_id)
rid_events = _events.get(rollout_id, {})
if not rid_events:
return []
return sorted(
rid_events.keys(),
key=lambda attempt_id: rid_events[attempt_id][0].timestamp if rid_events[attempt_id] else float("inf"),
)
@router.post("/rollouts", status_code=201, response_model=list[Rollout])
async def enqueue_rollouts(body: list[RolloutCreate]) -> list[Rollout]:
"""Enqueue rollouts. Each item in the list is self-contained.
If a request carries a `rollout_id` that already exists, the existing
rollout is returned unchanged (its events are left intact), making creation
idempotent so callers can pre-assign ids and retry safely.
"""
results: list[Rollout] = []
for req in body:
if req.rollout_id is not None and req.rollout_id in _rollouts:
results.append(_rollouts[req.rollout_id])
continue
now = time.time()
rollout_id = req.rollout_id or uuid.uuid4().hex
metadata = _metadata_from_request(req)
rollout = Rollout(
rollout_id=rollout_id,
input=req.input,
is_train=req.is_train,
config=req.config or RolloutConfig(),
metadata=metadata,
status=RolloutLifecycleStatus(created_at=now, updated_at=now),
)
_rollouts[rollout_id] = rollout
_events[rollout_id] = {}
results.append(rollout)
return results
@router.get("/rollouts", response_model=list[Rollout])
async def list_rollouts(
state_in: Annotated[list[RolloutState], Query()],
limit: int = 500,
) -> list[Rollout]:
"""List rollouts by lifecycle states."""
states = set(state_in)
matches = [rollout for rollout in _rollouts.values() if rollout.status.state in states]
return matches[:limit]
def _data_id_of(rollout: Rollout) -> str:
inp = rollout.input
if isinstance(inp, dict):
return str(inp.get("data_id") or inp.get("instance_id") or "")
return ""
@router.get("/rollouts/terminal", response_model=TerminalRolloutsPage)
async def list_terminal_rollouts(after: int = 0, limit: int = 1000) -> TerminalRolloutsPage:
"""Cursor-paginate terminal rollouts in completion order (lightweight projection).
`after` is an index into the append-only completion log; pass back `next_after`
to fetch only rollouts that completed since the last call. Out-of-order
completions are never missed because the log is append-on-terminal-transition.
Returns only id/state/data_id/is_train — fetch events per rollout for details.
"""
if after < 0:
after = 0
if limit < 1:
limit = 1
total = len(_terminal_order)
slice_ids = _terminal_order[after : after + limit]
items: list[TerminalRolloutItem] = []
for rid in slice_ids:
rollout = _rollouts.get(rid)
if rollout is None:
continue
items.append(
TerminalRolloutItem(
rollout_id=rid,
state=rollout.status.state,
data_id=_data_id_of(rollout),
is_train=rollout.is_train,
)
)
return TerminalRolloutsPage(items=items, next_after=after + len(slice_ids), total_terminal=total)
@router.get("/rollouts/{rollout_id}", response_model=RolloutDetail)
async def get_rollout(rollout_id: str) -> RolloutDetail:
"""Get a single rollout with its attempt list."""
rollout = _get_rollout(rollout_id)
attempts = _list_attempts(rollout_id)
return RolloutDetail(rollout=rollout, attempts=attempts)
@router.patch("/rollouts/{rollout_id}", response_model=Rollout)
async def patch_rollout(rollout_id: str, body: RolloutPatch) -> Rollout:
"""Patch the lifecycle status of a rollout."""
rollout = _get_rollout(rollout_id)
updates = body.status.model_dump(exclude_unset=True) if body.status is not None else {}
if not updates:
return rollout
if "state" in updates:
new_state = updates["state"]
if new_state not in VALID_TRANSITIONS[rollout.status.state]:
raise _invalid_transition(rollout_id, rollout.status.state, str(new_state))
updated_status = rollout.status.model_copy(
update={
**updates,
"version": rollout.status.version + 1,
"updated_at": time.time(),
}
)
updated = rollout.model_copy(
update={
"status": updated_status,
}
)
_rollouts[rollout_id] = updated
if "state" in updates and updated_status.state in TERMINAL_STATES:
# One-way terminal transition (guarded above) => append exactly once.
_terminal_order.append(rollout_id)
return updated
@router.delete("/rollouts/{rollout_id}", status_code=204)
async def delete_rollout(rollout_id: str) -> None:
"""Delete a rollout and its events. Idempotent: missing id is a no-op."""
_rollouts.pop(rollout_id, None)
_events.pop(rollout_id, None)
+18
View File
@@ -0,0 +1,18 @@
# Copyright (c) Microsoft. All rights reserved.
"""In-memory server state — single-threaded, no locks, plain dict/list.
Route handlers mutate these module-level dictionaries directly on the event loop
thread. See docs/dev_guidelines.md § Concurrency Model.
"""
from __future__ import annotations
from agentlightning.schemas import Event, Model, Rollout
_rollouts: dict[str, Rollout] = {}
_events: dict[str, dict[str, list[Event]]] = {}
_models: dict[str, dict[str, Model]] = {}
# Completion-ordered ids enable cursor pagination without rescanning rollouts.
_terminal_order: list[str] = []
-3
View File
@@ -1,3 +0,0 @@
from .base import BaseTracer
from .agentops import AgentOpsTracer
from .triplet import TripletExporter
-240
View File
@@ -1,240 +0,0 @@
from __future__ import annotations
import logging
import os
from contextlib import contextmanager
from typing import List, Optional, TYPE_CHECKING
import agentops.sdk.core
import agentops
from agentops.sdk.core import TracingCore
from agentops.sdk.processors import SpanProcessor
from opentelemetry.sdk.trace import ReadableSpan
from agentlightning.instrumentation.agentops import AgentOpsServerManager
from agentlightning.instrumentation import instrument_all, uninstrument_all
from .base import BaseTracer
if TYPE_CHECKING:
from agentops.integration.callbacks.langchain import LangchainCallbackHandler
logger = logging.getLogger(__name__)
class AgentOpsTracer(BaseTracer):
"""Traces agent execution using AgentOps.
This tracer provides functionality to capture execution details using the
AgentOps library. It manages the AgentOps client initialization, server setup,
and integration with the OpenTelemetry tracing ecosystem.
Attributes:
agentops_managed: Whether to automatically manage `agentops`.
When set to true, tracer calls `agentops.init()`
automatically and launches an agentops endpoint locally.
If not, you are responsible for calling and using it
before using the tracer.
instrument_managed: Whether to automatically manage instrumentation.
When set to false, you will manage the instrumentation
yourself and the tracer might not work as expected.
daemon: Whether the AgentOps server runs as a daemon process.
Only applicable if `agentops_managed` is True.
"""
def __init__(self, *, agentops_managed: bool = True, instrument_managed: bool = True, daemon: bool = True):
super().__init__()
self._lightning_span_processor: Optional[LightningSpanProcessor] = None
self.agentops_managed = agentops_managed
self.instrument_managed = instrument_managed
self.daemon = daemon
self._agentops_server_manager = AgentOpsServerManager(self.daemon)
self._agentops_server_port_val: Optional[int] = None
if not self.agentops_managed:
logger.warning("agentops_managed=False. You are responsible for AgentOps setup.")
if not self.instrument_managed:
logger.warning("instrument_managed=False. You are responsible for all instrumentation.")
def __getstate__(self):
state = self.__dict__.copy()
state["_agentops_server_manager"] = None # Exclude the unpicklable server manager
# _agentops_server_port_val (int) is inherently picklable and will be included.
logger.debug(f"Getting state for pickling Trainer (PID {os.getpid()}). _agentops_server_manager excluded.")
return state
def __setstate__(self, state):
self.__dict__.update(state)
# In child process, self._agentops_server_manager will be None.
logger.debug(f"Setting state for unpickled Trainer (PID {os.getpid()}). _agentops_server_manager is None.")
def init(self, *args, **kwargs):
if self.agentops_managed and self._agentops_server_manager:
self._agentops_server_manager.start()
self._agentops_server_port_val = self._agentops_server_manager.get_port()
if self._agentops_server_port_val is None:
if (
self._agentops_server_manager.server_process is not None
and self._agentops_server_manager.server_process.is_alive()
):
raise RuntimeError("AgentOps server started but port is None. Check server manager logic.")
elif (
self._agentops_server_port_val is None and self._agentops_server_manager.server_process is None
): # Server failed to start
raise RuntimeError("AgentOps server manager indicates server is not running and port is None.")
def teardown(self):
if self.agentops_managed:
self._agentops_server_manager.stop()
logger.info("AgentOps server stopped.")
def instrument(self, worker_id: int):
instrument_all()
def uninstrument(self, worker_id: int):
uninstrument_all()
def init_worker(self, worker_id: int):
super().init_worker(worker_id)
logger.info(f"[Worker {worker_id}] Setting up tracer...") # worker_id included in process name
if self.instrument_managed:
self.instrument(worker_id)
logger.info(f"[Worker {worker_id}] Instrumentation applied.")
if self.agentops_managed:
if self._agentops_server_port_val: # Use the stored, picklable port value
base_url = f"http://localhost:{self._agentops_server_port_val}"
env_vars_to_set = {
"AGENTOPS_API_KEY": "dummy",
"AGENTOPS_API_ENDPOINT": base_url,
"AGENTOPS_APP_URL": f"{base_url}/notavailable",
"AGENTOPS_EXPORTER_ENDPOINT": f"{base_url}/traces",
}
for key, value in env_vars_to_set.items():
os.environ[key] = value
logger.info(f"[Worker {worker_id}] Env var set: {key}={value}")
else:
logger.warning(
f"[Worker {worker_id}] AgentOps managed, but local server port is not available. Client may not connect as expected."
)
if not agentops.get_client().initialized:
agentops.init()
logger.info(f"[Worker {worker_id}] AgentOps client initialized.")
else:
logger.warning(f"[Worker {worker_id}] AgentOps client was already initialized.")
self._lightning_span_processor = LightningSpanProcessor()
try:
# new versions
instance = agentops.sdk.core.tracer
instance.provider.add_span_processor(self._lightning_span_processor)
except AttributeError:
# old versions
instance = TracingCore.get_instance()
instance._provider.add_span_processor(self._lightning_span_processor)
def teardown_worker(self, worker_id: int) -> None:
super().teardown_worker(worker_id)
if self.instrument_managed:
self.uninstrument(worker_id)
logger.info(f"[Worker {worker_id}] Instrumentation removed.")
@contextmanager
def trace_context(self, name: Optional[str] = None):
"""
Starts a new tracing context. This should be used as a context manager.
Args:
name: Optional name for the tracing context.
Yields:
The LightningSpanProcessor instance to collect spans.
"""
if not self._lightning_span_processor:
raise RuntimeError("LightningSpanProcessor is not initialized. Call init_worker() first.")
with self._lightning_span_processor:
yield self._lightning_span_processor
def get_last_trace(self) -> List[ReadableSpan]:
"""
Retrieves the raw list of captured spans from the most recent trace.
Returns:
A list of OpenTelemetry `ReadableSpan` objects.
"""
if not self._lightning_span_processor:
raise RuntimeError("LightningSpanProcessor is not initialized. Call init_worker() first.")
return self._lightning_span_processor.spans()
def get_langchain_callback_handler(self, tags: List[str] | None = None) -> LangchainCallbackHandler:
"""
Get the Langchain callback handler for integrating with Langchain.
Args:
tags: Optional list of tags to apply to the Langchain callback handler.
Returns:
An instance of the Langchain callback handler.
"""
import agentops
from agentops.integration.callbacks.langchain import LangchainCallbackHandler
tags = tags or []
client_instance = agentops.get_client()
api_key = None
if client_instance.initialized:
api_key = client_instance.config.api_key
else:
logger.warning(
"AgentOps client not initialized when creating LangchainCallbackHandler. API key may be missing."
)
return LangchainCallbackHandler(api_key=api_key, tags=tags)
class LightningSpanProcessor(SpanProcessor):
_spans: List[ReadableSpan] = []
def __enter__(self):
self._last_trace = None
self._spans = []
return self
def __exit__(self, exc_type, exc_val, exc_tb):
pass
def spans(self) -> List[ReadableSpan]:
"""
Get the list of spans collected by this processor.
This is useful for debugging and testing purposes.
Returns:
List of ReadableSpan objects collected during tracing.
"""
return self._spans
def on_end(self, span: ReadableSpan) -> None:
"""
Process a span when it ends.
Args:
span: The span that has ended.
"""
# Skip if span is not sampled
if not span.context or not span.context.trace_flags.sampled:
return
self._spans.append(span)
def shutdown(self) -> None:
pass
def force_flush(self, timeout_millis: int = 30000) -> bool:
return True
-95
View File
@@ -1,95 +0,0 @@
from contextlib import contextmanager
from typing import Iterator, List, Optional, Callable, Any, Awaitable
from opentelemetry.sdk.trace import ReadableSpan
from agentlightning.types import ParallelWorkerBase
class BaseTracer(ParallelWorkerBase):
"""
An abstract base class for tracers.
This class defines a standard interface for tracing code execution,
capturing the resulting spans, and providing them for analysis. It is
designed to be backend-agnostic, allowing for different implementations
(e.g., for AgentOps, OpenTelemetry, Docker, etc.).
The primary interaction pattern is through the `trace_context`
context manager, which ensures that traces are properly started and captured,
even in the case of exceptions.
A typical workflow:
```python
tracer = YourTracerImplementation()
try:
with tracer.trace_context(name="my_traced_task"):
# ... code to be traced ...
run_my_agent_logic()
except Exception as e:
print(f"An error occurred: {e}")
# Retrieve the trace data after the context block
spans: list[ReadableSpan] = tracer.get_last_trace()
# Process the trace data
if trace_tree:
rl_triplets = TripletExporter().export(spans)
# ... do something with the triplets
```
"""
@contextmanager
def trace_context(self, name: Optional[str] = None) -> Iterator[Any]:
"""
Starts a new tracing context. This should be used as a context manager.
The implementation should handle the setup and teardown of the tracing
for the enclosed code block. It must ensure that any spans generated
within the `with` block are collected and made available via
`get_last_trace`.
Args:
name: The name for the root span of this trace context.
"""
raise NotImplementedError()
def get_last_trace(self) -> List[ReadableSpan]:
"""
Retrieves the raw list of captured spans from the most recent trace.
Returns:
A list of OpenTelemetry `ReadableSpan` objects.
"""
raise NotImplementedError()
def trace_run(self, func: Callable, *args, **kwargs) -> Any:
"""
A convenience wrapper to trace the execution of a single synchronous function.
Args:
func: The synchronous function to execute and trace.
*args: Positional arguments to pass to the function.
**kwargs: Keyword arguments to pass to the function.
Returns:
The return value of the function.
"""
with self.trace_context(name=func.__name__):
return func(*args, **kwargs)
async def trace_run_async(self, func: Callable[..., Awaitable], *args, **kwargs) -> Any:
"""
A convenience wrapper to trace the execution of a single asynchronous function.
Args:
func: The asynchronous function to execute and trace.
*args: Positional arguments to pass to the function.
**kwargs: Keyword arguments to pass to the function.
Returns:
The return value of the function.
"""
with self.trace_context(name=func.__name__):
return await func(*args, **kwargs)
-366
View File
@@ -1,366 +0,0 @@
from contextlib import contextmanager
from typing import Iterator, List, Optional, Any, Dict, Callable, Awaitable
import logging
import uuid
import pickle
import multiprocessing
import asyncio
import queue
from urllib.parse import urlparse
from .base import BaseTracer
from httpdbg.hooks.all import httprecord
from httpdbg.records import HTTPRecords
from opentelemetry.sdk.trace import ReadableSpan
from opentelemetry.trace import StatusCode, SpanKind, Status
from opentelemetry.trace.span import (
SpanContext,
TraceFlags,
TraceState,
)
logger = logging.getLogger(__name__)
class HttpTracer(BaseTracer):
"""
A tracer implementation that captures HTTP requests using httpdbg.
This tracer hooks into the Python HTTP libraries and captures all
HTTP requests and responses made during the traced code execution.
The captured requests are converted to OpenTelemetry spans for
compatibility with the rest of the tracing ecosystem.
Caution: The current implementation of HttpTracer is very fragile,
and we do not recommend using it in production.
It is primarily for demonstration and testing purposes.
Attributes:
include_headers: Whether to include HTTP headers in the spans.
Headers may contain sensitive information. Use with caution.
include_body: Whether to include HTTP request and response bodies in the spans.
Bodies may be large and contain sensitive information. Use with caution.
include_agentlightning_requests: Whether to include requests initiated by AgentLightning itself.
subprocess_mode: Whether to run trace_run and trace_run_async in subprocesses for isolation.
subprocess_timeout: Timeout for subprocess execution in seconds.
"""
AGENTLIGHTNING_HEADERS = {"x-agentlightning-client"}
def __init__(
self,
include_headers: bool = False,
include_body: bool = False,
include_agentlightning_requests: bool = False,
subprocess_mode: bool = True,
subprocess_timeout: float = 3600.0,
):
super().__init__()
self._last_records = None
self.include_headers = include_headers
self.include_body = include_body
self.include_agentlightning_requests = include_agentlightning_requests
self.subprocess_mode = subprocess_mode
self.subprocess_timeout = subprocess_timeout
def init_worker(self, worker_id: int):
"""
Initialize the tracer in a worker process.
Args:
worker_id: The ID of the worker process.
"""
super().init_worker(worker_id)
logger.info(f"[Worker {worker_id}] HttpTracer initialized.")
@contextmanager
def trace_context(self, name: Optional[str] = None) -> Iterator[HTTPRecords]:
"""
Starts a new HTTP tracing context. This should be used as a context manager.
Args:
name: Optional name for the tracing context.
Yields:
The HTTPRecords instance containing traced HTTP activities.
"""
records = HTTPRecords()
with httprecord(records):
self._last_records = records
yield records
def get_last_trace(self) -> List[ReadableSpan]:
"""
Retrieves the raw list of captured spans from the most recent trace.
Returns:
A list of OpenTelemetry `ReadableSpan` objects converted from HTTP records.
"""
if self._last_records is None:
return []
return self._convert_to_spans(self._last_records)
def _convert_to_spans(self, records: HTTPRecords) -> List[ReadableSpan]:
"""
Convert HTTPRecords to OpenTelemetry spans.
Args:
records: The HTTPRecords instance containing HTTP traces.
Returns:
A list of ReadableSpan objects representing the HTTP activities.
"""
spans = []
# Create a trace ID that will be shared by all spans in this trace
trace_id = int(uuid.uuid4().hex[:16], 16)
for record in records.requests.values():
# Skip AgentLightning requests if include_agentlightning_requests is False
should_skip = False
if not self.include_agentlightning_requests and record.request and record.request.headers:
for header in record.request.headers:
if header.name.lower() in self.AGENTLIGHTNING_HEADERS and header.value.lower() == "true":
should_skip = True
break
if should_skip:
continue
# Create a span ID for this specific HTTP request
span_id = int(uuid.uuid4().hex[:8], 16)
# Create a span context
span_context = SpanContext(
trace_id=trace_id,
span_id=span_id,
is_remote=False,
trace_flags=TraceFlags(TraceFlags.SAMPLED),
trace_state=TraceState(),
)
# Extract important information from the HTTP record
method = record.method
url = record.url
parsed_url = urlparse(url)
status_code = record.status_code
# Create attributes dictionary
attributes: Dict[str, Any] = {
"http.method": method,
"http.url": url,
"http.target": parsed_url.path,
"http.host": parsed_url.netloc,
}
if status_code is not None and status_code > 0:
attributes["http.status_code"] = status_code
# Calculate duration - from begin time to last update
duration = None
if hasattr(record, "last_update") and record.last_update and record.tbegin:
duration = (record.last_update - record.tbegin).total_seconds()
attributes["http.duration_ms"] = duration * 1000 # Convert to ms
# Optionally include headers
if self.include_headers and record.request and record.request.headers:
for header in record.request.headers:
header_name = header.name.lower()
attributes[f"http.request.header.{header_name}"] = header.value
if self.include_headers and record.response and record.response.headers:
for header in record.response.headers:
header_name = header.name.lower()
attributes[f"http.response.header.{header_name}"] = header.value
# Optionally include body - preserve complete content for analysis
if self.include_body and record.request:
body_content = record.request.content
if body_content:
# Store raw body content for later parsing/analysis
attributes["http.request.body"] = body_content
if self.include_body and record.response:
body_content = record.response.content
if body_content:
# Store raw body content for later parsing/analysis
attributes["http.response.body"] = body_content
# Determine span status
span_status = StatusCode.OK
if status_code and status_code >= 400 or record.exception:
span_status = StatusCode.ERROR
# Create start and end timestamps in nanoseconds
# If we have duration, use it, otherwise default to current time - 1ms
start_time_ns = int(record.tbegin.timestamp() * 1e9)
if duration:
end_time_ns = int((record.tbegin.timestamp() + duration) * 1e9)
else:
end_time_ns = int(record.last_update.timestamp() * 1e9)
span = ReadableSpan(
name=f"HTTP {method} {url}",
context=span_context,
parent=None,
kind=SpanKind.CLIENT,
status=Status(span_status),
start_time=start_time_ns,
end_time=end_time_ns,
attributes=attributes,
events=[],
links=[],
resource=None,
)
spans.append(span)
return spans
def trace_run(self, func: Callable, *args, **kwargs) -> Any:
"""
A convenience wrapper to trace the execution of a single synchronous function.
If subprocess_mode is enabled, the function will be executed in an isolated subprocess
to prevent HTTP hooks from affecting the parent process.
Args:
func: The synchronous function to execute and trace.
*args: Positional arguments to pass to the function.
**kwargs: Keyword arguments to pass to the function.
Returns:
The return value of the function.
"""
if self.subprocess_mode:
return self._trace_run_subprocess(func, args, kwargs)
else:
return super().trace_run(func, *args, **kwargs)
async def trace_run_async(self, func: Callable[..., Awaitable], *args, **kwargs) -> Any:
"""
A convenience wrapper to trace the execution of a single asynchronous function.
If subprocess_mode is enabled, the function will be executed in an isolated subprocess
to prevent HTTP hooks from affecting the parent process.
Args:
func: The asynchronous function to execute and trace.
*args: Positional arguments to pass to the function.
**kwargs: Keyword arguments to pass to the function.
Returns:
The return value of the function.
"""
if self.subprocess_mode:
loop = asyncio.get_event_loop()
return await loop.run_in_executor(
None, self._trace_run_subprocess, func, args, kwargs, True # True for async
)
else:
return await super().trace_run_async(func, *args, **kwargs)
def _trace_run_subprocess(self, func: Callable, args=None, kwargs=None, is_async: bool = False) -> Any:
"""
Execute a function in a subprocess with HTTP tracing.
Args:
func: The function to execute.
args: Positional arguments to pass to the function.
kwargs: Keyword arguments to pass to the function.
is_async: Whether the function is asynchronous.
Returns:
The return value of the function.
"""
if args is None:
args = ()
if kwargs is None:
kwargs = {}
# Create a queue to receive results from the subprocess
result_queue = multiprocessing.Queue()
# Create and start the subprocess
process = multiprocessing.Process(
target=self._subprocess_worker, args=(func, args, kwargs, result_queue, is_async)
)
process.start()
try:
# Wait for the process to complete and get the result
process.join(timeout=self.subprocess_timeout)
result = result_queue.get_nowait()
if result["success"]:
# Store the captured records for get_last_trace()
self._last_records = result["records"]
return result["return_value"]
else:
if "records" in result:
self._last_records = result["records"]
# Re-raise the exception that occurred in the subprocess
raise result["exception"]
except multiprocessing.TimeoutError:
process.terminate()
process.join()
raise TimeoutError(f"Subprocess execution timed out after {self.subprocess_timeout} seconds.")
except queue.Empty:
logger.error("Traced result is empty. This may indicate a timeout or an issue with the subprocess.")
finally:
if process.is_alive():
process.terminate()
process.join()
def _subprocess_worker(self, func: Callable, args, kwargs, result_queue: multiprocessing.Queue, is_async: bool):
"""
Worker function that runs in the subprocess to execute the traced function.
Args:
func: The function to execute.
args: Positional arguments.
kwargs: Keyword arguments.
result_queue: Queue to send results back to parent process.
is_async: Whether the function is asynchronous.
"""
# Create a new tracer instance in the subprocess (without subprocess mode to avoid recursion)
subprocess_tracer = HttpTracer(
include_headers=self.include_headers,
include_body=self.include_body,
include_agentlightning_requests=self.include_agentlightning_requests,
subprocess_mode=False, # Disable subprocess mode in the worker
)
try:
if is_async:
# Run async function in new event loop
import asyncio
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
try:
return_value = loop.run_until_complete(subprocess_tracer.trace_run_async(func, *args, **kwargs))
finally:
loop.close()
else:
# Run sync function
return_value = subprocess_tracer.trace_run(func, *args, **kwargs)
# Get the captured records
records = subprocess_tracer._last_records
# Send success result back to parent
result_queue.put({"success": True, "return_value": return_value, "records": records})
except Exception as e:
# Log the exception
logger.exception(f"Error in subprocess worker in http tracer: {e}")
# Get the captured records even when there's an exception
records = subprocess_tracer._last_records
# Send error result back to parent
result_queue.put({"success": False, "exception": e, "records": records})
-539
View File
@@ -1,539 +0,0 @@
import json
import re
from enum import Enum
from typing import List, Dict, Tuple, Optional, Any
from pydantic import BaseModel
from opentelemetry import trace as trace_api
from opentelemetry.sdk.trace import ReadableSpan
from agentlightning.types import Triplet
class Transition(BaseModel):
"""
Transition class representing one transition in a trajectory.
State and action are a list of token IDs.
"""
state: List[int]
action: List[int]
response_id: Optional[str]
# action_logprobs: List[float]
agent_name: str
reward: Optional[float]
class RewardMatchPolicy(str, Enum):
"""How to find the reward for each transition from the trace.
In all cases, the reward must have data `{"type": "reward", "value": <float>|None}`,
as defined in `reward.py`.
"""
FIRST_SIBLING = "first_sibling"
"""Use the first sibling in the current trace subtree as the reward, except another LLM call match is found."""
FIRST_OCCURRENCE = "first_occurrence"
"""Use the first occurrence of the reward (in start time order) that occur after the current LLM call match.
"""
class TraceTree:
"""
A trace item, along with its span and children.
"""
def __init__(
self,
id: str,
span: ReadableSpan,
children: Optional[List["TraceTree"]] = None,
):
self.id = id
self.span = span
self.children = children or []
@property
def start_time(self):
return self.span.start_time
@property
def end_time(self):
return self.span.end_time
def find_id(self, id: str) -> "TraceTree | None":
if self.id == id:
return self
for child in self.children:
found = child.find_id(id)
if found:
return found
return None
def add_child(self, child: "TraceTree") -> None:
self.children.append(child)
def visualize(self, filename: str, interested_span_match: str | None = None) -> None:
"""
Visualize the trace tree using graphviz.
For debugging purposes only.
Use `interested_span_match` to filter the spans (and its ancesters) to be visualized.
"""
import graphviz
dot = graphviz.Digraph(comment="Trace Tree")
should_visit_cache = {}
def should_visit(node: "TraceTree") -> bool:
if node.id in should_visit_cache:
return should_visit_cache[node.id]
if interested_span_match is not None:
if re.search(interested_span_match, node.span.name):
should_visit_cache[node.id] = True
return True
else:
should_visit_cache[node.id] = False
for child in node.children:
if should_visit(child):
should_visit_cache[node.id] = True
return should_visit_cache[node.id]
else:
return True
def visit(node: "TraceTree") -> bool:
if not should_visit(node):
return False
agent_name = node.agent_name()
vis_name = node.id[:8] + " (" + node.span.name + ")"
if agent_name is not None:
vis_name += " [" + agent_name + "]"
dot.node(node.id, vis_name)
for child in node.children:
if visit(child):
dot.edge(node.id, child.id)
return True
visit(self)
dot.render(filename, format="png", cleanup=True)
def names_tuple(self) -> Tuple[str, List[Any]]:
"""Return the span name, and a list of children.
Each child is also a tuple of span name and a list of children.
Useful for debugging and testing.
"""
name = self.span.name
agent_name = self.agent_name()
if agent_name is not None:
name += " [" + agent_name + "]"
children_names = []
for child in self.children:
child_name, child_children = child.names_tuple()
children_names.append((child_name, child_children))
return name, children_names
def traverse(self) -> List["TraceTree"]:
"""
Traverse the trace tree and return a list of all spans.
"""
spans: List["TraceTree"] = [self]
for child in self.children:
spans.extend(child.traverse())
return spans
def to_json(self) -> dict[str, Any]:
return {
"id": self.id,
"span": self.span.to_json(),
"children": [child.to_json() for child in self.children],
}
@classmethod
def from_spans(cls, spans: List[ReadableSpan]) -> "TraceTree":
"""
Create a TraceTree from a list of spans.
All spans without parents found will be considered as candidate root spans.
If multiple root spans are found, a virtual root span will be created as the parent of all root spans.
"""
if not spans:
raise ValueError("No spans provided to create TraceTree.")
# Process trace items in topological order
id_to_span = {span.get_span_context().span_id: span for span in spans}
forward_graph: dict[int, list[int]] = {}
root_ids: list[int] = []
for span in spans:
if span.parent is None:
root_ids.append(span.get_span_context().span_id)
else:
if span.parent.span_id not in forward_graph:
forward_graph[span.parent.span_id] = []
forward_graph[span.parent.span_id].append(span.get_span_context().span_id)
# Diff between span with data and forward_graph keys
# Sometimes the top-level session span is lost.
unfound_roots = set(forward_graph.keys()) - set(id_to_span.keys())
for unfound_root in unfound_roots:
root_ids.append(unfound_root)
def visit(node_id):
children: list[TraceTree] = []
if node_id in forward_graph:
for child_id in forward_graph[node_id]:
children.append(visit(child_id))
if node_id not in id_to_span:
assert len(children) > 0
virtual_span = ReadableSpan(
context=trace_api.SpanContext(
trace_id=children[0].span.get_span_context().trace_id,
span_id=node_id,
is_remote=False,
),
name="virtual-node",
kind=trace_api.SpanKind.INTERNAL,
attributes={},
start_time=min(child.start_time for child in children),
end_time=max(child.end_time for child in children),
)
return cls(trace_api.format_span_id(node_id), virtual_span, children=children)
else:
return cls(
trace_api.format_span_id(node_id),
id_to_span[node_id],
children=children,
)
# Create a virtual root span if multiple root spans are found
if len(root_ids) > 1:
root_spans = [visit(root_id) for root_id in root_ids]
virtual_root = TraceTree(
id="virtual-root",
span=ReadableSpan(
context=trace_api.SpanContext(
trace_id=root_spans[0].span.get_span_context().trace_id,
span_id=0,
is_remote=False,
),
name="virtual-root",
kind=trace_api.SpanKind.INTERNAL,
attributes={},
start_time=root_spans[0].start_time,
end_time=root_spans[-1].end_time,
),
children=root_spans,
)
return virtual_root
elif len(root_ids) == 0:
# No root spans found
raise ValueError("No root spans found in the trace.")
else:
root_span = visit(root_ids[0])
return root_span
def agent_name(self) -> Optional[str]:
"""Return the name of agent span. Return the agent or None (not an agent at all).
Extend this function to support more agent frameworks."""
# Case 1: OpenAI Agent SDK
agent_name = self.span.attributes.get("agent.name")
if agent_name is not None:
return agent_name
# Case 2: Agentops decorator @agent
is_agent = self.span.attributes.get("agentops.span.kind") == "agent"
if is_agent:
agent_name = self.span.attributes.get("operation.name")
if agent_name is not None:
return agent_name
# Case 3: Autogen team
agent_name = self.span.attributes.get("recipient_agent_type")
if agent_name is not None:
return agent_name
# Case 4: LangGraph
agent_name = self.span.attributes.get("langchain.chain.type")
if agent_name is not None:
return agent_name
def maybe_reward_dict(self) -> dict[str, Any]:
for key in [
"agentops.task.output", # newer versions of agentops
"agentops.entity.output",
]:
output = self.span.attributes.get(key)
if output:
if isinstance(output, dict):
return output
elif isinstance(output, str):
try:
return json.loads(output)
except json.JSONDecodeError:
return {}
return {}
def is_reward_span(self) -> bool:
maybe_reward = self.maybe_reward_dict()
return maybe_reward and maybe_reward.get("type") == "reward"
def find_llm_calls(
self,
*,
llm_call_match: str,
agent_match: Optional[str],
within_matching_subtree: str | None = None,
within_reward: Optional[bool] = None,
within_llm_call: Optional[bool] = None,
existing_llm_call_response_ids: Optional[set[str]] = None,
) -> List[Tuple["TraceTree", str]]:
"""Find all LLM calls in the trace tree.
The LLM call is defined as a span with type = request and name matching `llm_call_match`.
If `agent_match` is not None, it must also reside in an agent span (type = agent) with name matched.
Return a list of traces and the agent names (why it's selected).
"""
llm_calls: List[Tuple[TraceTree, str]] = []
is_llm_call = True
if within_matching_subtree is None or within_reward is True:
# We must be in an interesting agent subtree, and not in a reward span.
is_llm_call = False
if re.search(llm_call_match, self.span.name) is None:
# The span name does not match the LLM call match.
is_llm_call = False
if is_llm_call:
# Check the response id
response_id = self.span.attributes.get("gen_ai.response.id")
if response_id is None and within_llm_call is True:
is_llm_call = False
if (
response_id is not None
and existing_llm_call_response_ids is not None
and response_id in existing_llm_call_response_ids
):
is_llm_call = False
if is_llm_call:
llm_calls.append((self, within_matching_subtree))
existing_llm_call_response_ids = existing_llm_call_response_ids or set()
if response_id is not None:
existing_llm_call_response_ids.add(response_id)
if within_llm_call is not None:
within_llm_call = True
agent_name = self.agent_name()
if agent_name is not None:
if agent_match is None or re.search(agent_match, agent_name):
within_matching_subtree = agent_name
else:
within_matching_subtree = None
if within_reward is not None and self.is_reward_span():
within_reward = True
for child in self.children:
llm_calls.extend(
child.find_llm_calls(
llm_call_match=llm_call_match,
agent_match=agent_match,
within_matching_subtree=within_matching_subtree,
within_reward=within_reward,
within_llm_call=within_llm_call,
existing_llm_call_response_ids=existing_llm_call_response_ids,
)
)
return llm_calls
def repair_hierarchy(self) -> None:
"""
We find that sometimes the hierarchy is not correct, due to the way the spans are created.
The spans within the agent frameworks (e.g., OpenAI Agent SDK) and spans within the LLM frameworks
(e.g., Anthropic) are created in two systems.
So the inner LLM completion span does not necessarily have an agent span as a parent.
Rather they sometimes directly become children of the root span.
This becomes a problem when we want to select the LLM completion span with agent as filter.
To repair the hierarchy, for each children of the root span, we find a span over the whole tree,
with duration covering the current span and being closest to the current span.
This function modifies the tree in place.
"""
nodes_to_repair = list(self.children)
for repair_node in nodes_to_repair:
if len(self.children) == 1:
# If there is only one child, we don't need to repair the hierarchy.
break
# Find the closest parent span (but not the root itself)
closest_parent = None
closest_duration = float("inf")
for node in self.traverse():
if node.id == repair_node.id:
continue
if node is self:
continue
if node.start_time <= repair_node.start_time and node.end_time >= repair_node.end_time:
duration_delta = node.end_time - repair_node.end_time + repair_node.start_time - node.start_time
if duration_delta > 0 and duration_delta < closest_duration:
closest_duration = duration_delta
closest_parent = node
# Repair the hierarchy
if closest_parent is not None:
self.children.remove(repair_node)
closest_parent.children.append(repair_node)
def match_rewards(self, reward_match: str, llm_calls: List["TraceTree"]) -> dict[str, Optional[float]]:
"""Match the rewards to the LLM calls."""
llm_call_ids = set([llm_call.id for llm_call in llm_calls])
rewards: dict[str, Optional[float]] = {}
if reward_match == RewardMatchPolicy.FIRST_OCCURRENCE:
time_sorted: List[TraceTree] = sorted(self.traverse(), key=lambda x: x.start_time)
assign_to: List[Tuple[str, int]] = []
for item in time_sorted:
if item.id in llm_call_ids:
assign_to.append((item.id, item.end_time))
# get reward
agentops_output = item.maybe_reward_dict()
if agentops_output and agentops_output.get("type") == "reward":
for assign_to_id, assign_to_end_time in reversed(assign_to):
# This reward happens before the end of the LLM call.
if assign_to_end_time > item.start_time:
continue
# Ok, we found someone to assign to
if assign_to_id in rewards:
# If the reward is already set, skip
continue
rewards[assign_to_id] = agentops_output.get("value", None)
break
elif reward_match == RewardMatchPolicy.FIRST_SIBLING:
for item in self.traverse():
assign_to: List[Tuple[str, int]] = []
for child in item.children:
if child.id in llm_call_ids:
assign_to.append(child.id)
agentops_output = item.maybe_reward_dict()
if agentops_output and agentops_output.get("type") == "reward":
for assign_to_id, assign_to_end_time in reversed(assign_to):
if assign_to_end_time > item.start_time:
# This reward happens before the end of the LLM call.
continue
if assign_to_id in rewards:
continue
rewards[assign_to_id] = agentops_output.get("value", None)
break
return rewards
def to_trajectory(
self,
llm_call_match: str = r"openai\.chat\.completion",
agent_match: Optional[str] = None,
exclude_llm_call_in_reward: bool = True,
dedup_llm_call: bool = True,
reward_match: RewardMatchPolicy = RewardMatchPolicy.FIRST_OCCURRENCE,
final_reward: Optional[float] = None,
) -> List[Triplet]:
"""Convert the trace tree to a trajectory.
First, we find all the LLM calls (span type = request, `llm_call_match` matching the span name).
If the agent match is set, we check, for each LLM call,
if it resides in an agent (span type = agent, `agent_match` matching the span name).
The above sets the basis for the trajectory, as we use the prompt token IDs and response token IDs for each LLM call,
as the state and action of each transition.
Then, we find the reward for each transition.
The reward is searched on the trace tree, after the LLM call,
until the next LLM call or the end of the tree depending on the policy.
It can be enforced to a sibling or the first occurrence in the time order, depending on the policy.
If a reward is never found for a transition, it is set to None.
"""
# Find all LLM calls
llm_calls = self.find_llm_calls(
llm_call_match=llm_call_match,
agent_match=agent_match,
within_matching_subtree="*" if agent_match is None else None,
within_reward=False if exclude_llm_call_in_reward else None,
within_llm_call=False if dedup_llm_call else None,
existing_llm_call_response_ids=set(),
)
id_transitions = [
(
llm_call.id,
Triplet(
prompt={"token_ids": llm_call.span.attributes.get("prompt_token_ids", [])},
response={"token_ids": llm_call.span.attributes.get("response_token_ids", [])},
reward=None,
metadata=dict(
response_id=llm_call.span.attributes.get(
"gen_ai.response.id", None
), # it works at least for OpenAI
agent_name=agent_name,
),
),
)
for llm_call, agent_name in llm_calls
]
rewards = self.match_rewards(reward_match, [call for call, _ in llm_calls])
transitions = [
transition.model_copy(update={"reward": rewards.get(id, None)}) for id, transition in id_transitions
]
if final_reward is not None and len(transitions) > 0:
# Add the final reward to the last transition
transitions[-1] = transitions[-1].model_copy(update={"reward": final_reward})
return transitions
def __repr__(self):
return (
f"TraceTree(id={self.id}, span={self.span}, start_time={self.start_time}, "
+ f"end_time={self.end_time}, children={self.children})"
)
class TripletExporter:
"""
A class to export triplet data from OpenTelemetry spans.
Attributes:
repair_hierarchy: When `repair_hierarchy` is set to True, the trace will be repaired with the time information.
See `TraceTree.repair_hierarchy` for more details.
llm_call_match: Regular expression pattern to match LLM call span names.
agent_match: Optional regular expression pattern to match agent span names. If None, all agents are matched.
exclude_llm_call_in_reward: Whether to exclude LLM calls that occur within reward spans.
reward_match: Policy for matching rewards to LLM calls.
"""
def __init__(
self,
repair_hierarchy: bool = True,
llm_call_match: str = r"openai\.chat\.completion",
agent_match: Optional[str] = None,
exclude_llm_call_in_reward: bool = True,
reward_match: RewardMatchPolicy = RewardMatchPolicy.FIRST_OCCURRENCE,
):
self.repair_hierarchy = repair_hierarchy
self.llm_call_match = llm_call_match
self.agent_match = agent_match
self.exclude_llm_call_in_reward = exclude_llm_call_in_reward
self.reward_match = reward_match
def export(self, spans: List[ReadableSpan]) -> List[Triplet]:
"""Convert OpenTelemetry spans to a list of Triplet objects."""
trace_tree = TraceTree.from_spans(spans)
if self.repair_hierarchy:
trace_tree.repair_hierarchy()
trajectory = trace_tree.to_trajectory(
llm_call_match=self.llm_call_match,
agent_match=self.agent_match,
exclude_llm_call_in_reward=self.exclude_llm_call_in_reward,
reward_match=self.reward_match,
)
return trajectory
-311
View File
@@ -1,311 +0,0 @@
import asyncio
import logging
import multiprocessing
import os
import signal
import time
from typing import List, Optional, Union
import importlib
import agentops
from .client import AgentLightningClient
from .litagent import LitAgent
from .runner import AgentRunner
from .types import ParallelWorkerBase
from .tracer.base import BaseTracer
from .tracer.agentops import AgentOpsTracer
from .tracer.triplet import TripletExporter
logger = logging.getLogger(__name__)
class Trainer(ParallelWorkerBase):
"""Orchestrates the distributed execution of agent rollouts.
The Trainer is responsible for launching one or more worker processes
that run the agent's execution loop. It manages multiprocessing,
handles graceful shutdown, and serves as the main entry point for
running a client-side agent fleet.
Attributes:
dev: If True, rollouts are run against the dev endpoint provided in `fit`.
n_workers: Number of agent workers (processes) to run in parallel.
max_tasks: Maximum number of tasks to process per worker. If None,
workers run until no more tasks are available.
daemon: Whether worker processes should be daemons. Daemon processes
are terminated automatically when the main process exits.
tracer: A tracer instance, or a string pointing to the class full name or a dictionary with a 'type' key
that specifies the class full name and other initialization parameters.
If None, a default `AgentOpsTracer` will be created with the current settings.
triplet_exporter: An instance of `TripletExporter` to export triplets from traces,
or a dictionary with the initialization parameters for the exporter.
"""
def __init__(
self,
*,
dev: bool = False,
n_workers: int = 1,
max_tasks: Optional[int] = None,
daemon: bool = True,
tracer: Union[BaseTracer, str, dict, None] = None,
triplet_exporter: Union[TripletExporter, dict, None] = None,
):
super().__init__()
self.n_workers = n_workers
self.max_tasks = max_tasks
self.daemon = daemon
self.dev = dev
self._client: AgentLightningClient | None = None # Will be initialized in fit method
self.tracer = self._make_tracer(tracer)
if isinstance(triplet_exporter, TripletExporter):
self.triplet_exporter = triplet_exporter
elif isinstance(triplet_exporter, dict):
self.triplet_exporter = TripletExporter(**triplet_exporter)
elif triplet_exporter is None:
self.triplet_exporter = TripletExporter()
else:
raise ValueError(
f"Invalid triplet_exporter type: {type(triplet_exporter)}. Expected TripletExporter, dict, or None."
)
if not self.daemon:
logger.warning(
"daemon=False. Worker processes are non-daemonic. "
"The worker processes will NOT be terminated when the main process exits. "
"The cleanup must be handled manually."
)
def _make_tracer(self, tracer: Union[BaseTracer, str, dict, None]) -> BaseTracer:
"""Creates a tracer instance based on the provided configuration."""
if isinstance(tracer, BaseTracer):
return tracer
if isinstance(tracer, str):
module_name, class_name = tracer.rsplit(".", 1)
module = importlib.import_module(module_name)
tracer_cls = getattr(module, class_name)
return tracer_cls()
if isinstance(tracer, dict):
tracer_type = tracer.get("type")
if tracer_type is None:
raise ValueError("tracer dict must have a 'type' key with the class full name")
module_name, class_name = tracer_type.rsplit(".", 1)
module = importlib.import_module(module_name)
tracer_cls = getattr(module, class_name)
# Remove 'type' key and pass remaining keys as kwargs
tracer_kwargs = {k: v for k, v in tracer.items() if k != "type"}
return tracer_cls(**tracer_kwargs)
if tracer is None:
return AgentOpsTracer(agentops_managed=True, instrument_managed=True, daemon=self.daemon)
raise ValueError(f"Invalid tracer type: {type(tracer)}. Expected BaseTracer, str, dict, or None.")
def init(self, backend: Union[str, AgentLightningClient]) -> None:
logger.info(f"Initializing Trainer...")
self._init_client(backend)
self.tracer.init()
logger.info(f"Trainer main initialization complete.")
def teardown(self) -> None:
logger.info(f"Cleaning up Trainer...")
self.tracer.teardown()
self._client = None
logger.info(f"Trainer main cleanup complete.")
def client(self) -> AgentLightningClient:
"""Returns the AgentLightningClient instance."""
if self._client is None:
raise RuntimeError("AgentLightningClient has not been initialized. Call `init` first.")
return self._client
def _init_client(self, backend: Union[str, AgentLightningClient]) -> AgentLightningClient:
if self._client is None:
if isinstance(backend, AgentLightningClient):
logger.info("Using provided AgentLightningClient instance.")
self._client = backend
else:
logger.info(f"Initializing AgentLightningClient with endpoint: {backend}")
if not isinstance(backend, str):
raise ValueError("backend must be a string URL or an AgentLightningClient instance.")
if not backend.startswith("http://") and not backend.startswith("https://"):
raise ValueError("backend must be a valid URL starting with http:// or https://")
# Initialize the client with the provided backend URL
self._client = AgentLightningClient(endpoint=backend)
else:
logger.warning("AgentLightningClient already initialized. Returning existing instance.")
return self._client
def _worker_main_loop(self, agent: LitAgent, worker_id: int, is_async: bool):
"""The main function for each worker process.
This function initializes the client and the loop, then starts the
execution. It also configures process-specific settings like the
process title and signal handling.
Args:
agent: The `LitAgent` instance to run.
worker_id: The unique ID for this worker.
is_async: A boolean indicating if the async loop should be run.
"""
if self.n_workers > 1:
import setproctitle
# Ignore Ctrl+C in worker processes; the main process handles it
signal.signal(signal.SIGINT, signal.SIG_IGN)
setproctitle.setproctitle(multiprocessing.current_process().name)
# Now we are in child processes, so we can safely set up the environment.
agent.set_trainer(self)
# TODO: this should be set elsewhere
if agent.trained_agents:
self.triplet_exporter.agent_match = agent.trained_agents
self._initialize_worker_env(worker_id)
mode = "Async" if is_async else "Sync"
logger.info(f"[Worker {worker_id}] {mode} worker process started.")
num_processed = 0
try:
client = self.client()
loop = AgentRunner(
agent=agent,
client=client,
tracer=self.tracer,
triplet_exporter=self.triplet_exporter,
max_tasks=self.max_tasks,
worker_id=worker_id,
)
loop.init_worker(worker_id)
if is_async:
num_processed = asyncio.run(loop.iter_async())
else:
num_processed = loop.iter()
except Exception:
logger.exception(f"[Worker {worker_id}] Unhandled exception in worker loop.")
finally:
self._teardown_worker_env(worker_id)
return num_processed
def _initialize_worker_env(self, worker_id: int):
logger.info(f"[Worker {worker_id}] Setting up trainer environment...") # worker_id included in process name
self.tracer.init_worker(worker_id)
def _teardown_worker_env(self, worker_id: int):
logger.info(f"[Worker {worker_id}] Cleaning up trainer environment...")
self.tracer.teardown_worker(worker_id)
logger.info(f"[Worker {worker_id}] Environment cleanup complete.")
@staticmethod
def kill_orphaned_processes() -> None:
"""
Kill any orphaned processes that may have been left behind by previous runs.
This is useful for cleaning up after crashes or unexpected exits.
"""
import psutil
for proc in psutil.process_iter():
# check whether the process name matches
if proc.name().startswith("AgentLightning-"):
proc.kill()
def fit(
self,
agent: LitAgent,
backend: Union[str, AgentLightningClient],
dev_backend: Union[str, AgentLightningClient, None] = None,
):
if self.dev:
if dev_backend is None:
raise ValueError("dev_backend must be provided when dev=True.")
logger.warning(f"Running in dev mode. Using dev backend: {dev_backend}")
self.init(dev_backend)
else:
logger.debug(f"Running in non-dev mode. Using backend: {backend}")
self.init(backend)
processes: List[multiprocessing.Process] = []
# Determine if the agent is asynchronous.
is_async = (
hasattr(agent, "training_rollout_async")
and agent.__class__.training_rollout_async is not LitAgent.training_rollout_async
)
mode = "asynchronous" if is_async else "synchronous"
try:
if self.n_workers == 1:
logger.info(f"Running with n_workers=1 ({mode} in main process).")
num_tasks = self._worker_main_loop(agent, 0, is_async)
logger.info(f"Single worker mode finished. Tasks processed: {num_tasks}")
else:
logger.info(f"Running with n_workers={self.n_workers} ({mode} multiprocessing).")
for i in range(self.n_workers):
process_name = f"AgentLightning-Worker-{i}"
p = multiprocessing.Process(
target=self._worker_main_loop,
args=(agent, i, is_async),
daemon=self.daemon,
name=process_name,
)
processes.append(p)
logger.info(f"Starting worker process {i} (name: {process_name})...")
p.start()
if self.daemon:
for i, p in enumerate(processes):
p.join() # Wait for the process to complete
logger.info(
f"Worker process {i} (name: {p.name}, PID: {p.pid}) joined with exit code {p.exitcode}."
)
if p.exitcode != 0:
logger.warning(
f"Worker process {i} (name: {p.name}, PID: {p.pid}) exited with non-zero code: {p.exitcode}."
)
logger.info(f"All {self.n_workers} worker processes have completed.")
else:
logger.info("All worker processes started. Main process will not wait.")
# A hack to stop the main process from waiting for child processes to finish.
time.sleep(1) # Give workers time to start
import multiprocessing.process as multiprocessing_process
multiprocessing_process._children.clear() # type: ignore
except KeyboardInterrupt:
if self.n_workers > 1 and len(processes) > 0:
logger.info(f"KeyboardInterrupt received. Terminating workers...")
for i, p in enumerate(processes):
if p.is_alive():
logger.info(f"Terminating worker {i} (name: {p.name}, PID: {p.pid})...")
p.terminate()
else:
logger.info(
f"Worker {i} (name: {p.name}, PID: {p.pid}) is not alive or has already terminated."
)
for i, p in enumerate(processes):
if p.is_alive():
p.join(timeout=10) # Give some time to terminate
if p.is_alive(): # If still alive, kill
logger.warning(
f"Worker {i} (name: {p.name}, PID: {p.pid}) did not terminate gracefully, killing..."
)
p.kill()
p.join(timeout=10) # Ensure it's reaped
logger.info(f"Workers terminated or single worker interrupted.")
except Exception as e:
logger.exception(f"Unhandled exception in fit method.")
finally:
if self.daemon:
self.teardown()
else:
logger.info("Main process exiting. Please use Trainer.kill_orphaned_processes() for cleanup.")
-204
View File
@@ -1,204 +0,0 @@
from typing import Any, Dict, List, Optional, Union, Literal, Annotated
from pydantic import BaseModel, Field, Discriminator
from opentelemetry.sdk.trace import ReadableSpan
__all__ = [
"Triplet",
"Rollout",
"Task",
"TaskInput",
"TaskIfAny",
"RolloutRawResult",
"Resource",
"LLM",
"PromptTemplate",
"ResourceUnion",
"NamedResources",
"ResourcesUpdate",
"GenericResponse",
"ParallelWorkerBase",
]
class Triplet(BaseModel):
"""A standard structure for a single turn in a trajectory."""
prompt: Any
response: Any
reward: Optional[float] = None
metadata: Dict[str, Any] = Field(default_factory=dict)
class Rollout(BaseModel):
"""The standard reporting object from client to server."""
rollout_id: str
# Primary, high-level feedback
final_reward: Optional[float] = None
# Structured, sequential feedback for RL-style optimization
triplets: Optional[List[Triplet]] = None
# Optional, rich-context data for deep analysis
trace: Optional[List[Dict[str, Any]]] = Field(
default=None,
description="A list of spans that conform to the OpenTelemetry JSON format. "
"Users of the opentelemetry-sdk can generate this by calling "
"json.loads(readable_span.to_json()).",
)
logs: Optional[List[str]] = None
# A bucket for any other relevant information
metadata: Dict[str, Any] = Field(default_factory=dict)
TaskInput = Any
class Task(BaseModel):
"""A task (rollout request) to be processed by the client agent."""
rollout_id: str
input: TaskInput
mode: Optional[Literal["train", "val", "test"]] = None
resources_id: Optional[str] = None
# Optional fields for tracking task lifecycle
create_time: Optional[float] = None
last_claim_time: Optional[float] = None
num_claims: Optional[int] = None
# Allow additional metadata fields
metadata: Dict[str, Any] = Field(default_factory=dict)
class TaskIfAny(BaseModel):
is_available: bool
task: Optional[Task] = None
RolloutRawResult = Union[None, float, List[Triplet], List[Dict[str, Any]], List[ReadableSpan], Rollout]
class Resource(BaseModel):
"""
Base class for all tunable resources.
"""
resource_type: Any
class LLM(Resource):
"""
Provide an LLM endpoint and model name as a resource.
Attributes:
endpoint (str): The URL of the LLM API endpoint.
model (str): The identifier for the model to be used (e.g., 'gpt-4o').
sampling_parameters (SamplingParameters): A dictionary of hyperparameters
for model inference, such as temperature, top_p, etc.
"""
resource_type: Literal["llm"] = "llm"
endpoint: str
model: str
sampling_parameters: Dict[str, Any] = Field(default_factory=dict)
class PromptTemplate(Resource):
"""
A prompt template as a resource.
Attributes:
template (str): The template string. The format depends on the engine.
engine (Literal['jinja', 'f-string', 'poml']): The templating engine
to use for rendering the prompt. I imagine users can use their own
customized engines, but algos can only well operate on a subset of them.
"""
resource_type: Literal["prompt_template"] = "prompt_template"
template: str
engine: Literal["jinja", "f-string", "poml"]
# Use discriminated union for proper deserialization
ResourceUnion = Annotated[Union[LLM, PromptTemplate], Field(discriminator="resource_type")]
NamedResources = Dict[str, ResourceUnion]
"""
A dictionary-like class to hold named resources.
Example:
resources: NamedResources = {
'main_llm': LLM(
endpoint="http://localhost:8080",
model="llama3",
sampling_parameters={'temperature': 0.7, 'max_tokens': 100}
),
'system_prompt': PromptTemplate(
template="You are a helpful assistant.",
engine='f-string'
)
}
"""
class ResourcesUpdate(BaseModel):
"""
A resource update message to be sent from the server to clients.
This message contains a dictionary of resources that clients should use
for subsequent tasks. It is used to update the resources available to
clients dynamically.
"""
resources_id: str
resources: NamedResources
class GenericResponse(BaseModel):
"""
A generic response message that can be used for various purposes.
"""
status: str = "success"
message: Optional[str] = None
data: Optional[Dict[str, Any]] = None
class ParallelWorkerBase:
"""Base class for objects that can be parallelized across multiple worker processes.
This class defines the standard lifecycle for parallel processing:
Main Process:
1. init() - Initialize the object in the main process
2. spawn workers and call init_worker() in each worker
3. run() - Execute the main workload in parallel across workers
4. teardown_worker() - Clean up resources in each worker
5. teardown() - Final cleanup in the main process
Subclasses should implement the run() method and optionally override
the lifecycle methods for custom initialization and cleanup behavior.
"""
def __init__(self) -> None:
"""Initialize the base class. This method can be overridden by subclasses."""
self.worker_id: Optional[int] = None
def init(self, *args: Any, **kwargs: Any) -> None:
pass
def init_worker(self, worker_id: int, *args: Any, **kwargs: Any) -> None:
self.worker_id = worker_id
def run(self, *args: Any, **kwargs: Any) -> Any:
pass
def teardown_worker(self, worker_id: int, *args: Any, **kwargs: Any) -> None:
pass
def teardown(self, *args: Any, **kwargs: Any) -> None:
pass
+3 -3
View File
@@ -1,3 +1,3 @@
from .trainer import *
from .daemon import *
from .dataset import *
# Copyright (c) Microsoft. All rights reserved.
"""VERL integration for Agent Lightning."""
-4
View File
@@ -1,4 +0,0 @@
from .entrypoint import main
if __name__ == "__main__":
main()
+543
View File
@@ -0,0 +1,543 @@
# Copyright (c) Microsoft. All rights reserved.
"""Rollout managers for Agent Lightning VERL training."""
from __future__ import annotations
import time
import traceback
import uuid
from collections import defaultdict
from collections.abc import Mapping
from dataclasses import dataclass
from pathlib import Path
from typing import TYPE_CHECKING, Any, cast
import numpy as np
from httpx_retries import Retry, RetryTransport
from pydantic import BaseModel, Field
from agentlightning.client import AgentLightningSyncClient
from agentlightning.schemas import (
TERMINAL_STATES,
Event,
EventCreate,
Model,
Rollout,
RolloutCreate,
RolloutState,
)
try:
import torch
except ImportError: # pragma: no cover - torch is optional outside VERL installs.
torch = None
if TYPE_CHECKING:
from agentlightning.hooks import RolloutHooks
class Triplet(BaseModel):
"""Single prompt-response-reward turn."""
prompt: Any
response: Any
reward: float | None = None
metadata: dict[str, Any] = Field(default_factory=dict)
class EnqueuedRollout(BaseModel):
"""Enqueued rollout request metadata."""
data_id: str
rollout_id: str
step: int
sample_idx_in_step: int
enqueue_time: float
input: Any = None
# Server timestamps expose pod queue time and completion time.
running_at: float | None = None
finished_at: float | None = None
class CompletedRollout(BaseModel):
"""Completed rollout result."""
rollout_id: str
data_id: str
step: int
sample_idx_in_step: int
enqueue_time: float
input: Any = None
running_at: float | None = None
finished_at: float | None = None
final_reward: float | None = None
triplets: list[Triplet] | None = None
metadata: dict[str, Any] = Field(default_factory=dict)
events: list[dict[str, Any]] = Field(default_factory=list)
triplet_events: list[dict[str, Any]] = Field(default_factory=list)
rollout_state: RolloutState | None = None
error_message: str | None = None
@dataclass
class _TraceEvent:
rollout_id: str
attempt_id: str
event_type: str
data: dict[str, Any]
class _TraceEventHelper:
"""Queues hook events before HTTP flush."""
def __init__(self) -> None:
self._queued: list[_TraceEvent] = []
def add_event(self, rollout_id: str, attempt_id: str, event_type: str, data: dict[str, Any]) -> None:
self._queued.append(_TraceEvent(rollout_id=rollout_id, attempt_id=attempt_id, event_type=event_type, data=data))
def flush(self, manager: AglRolloutManagerBase) -> None:
for event in self._queued:
manager._post_event(
event.rollout_id,
event.attempt_id,
EventCreate(event_type=event.event_type, data=event.data),
)
def _as_reward_value(value: Any) -> float | None:
if isinstance(value, bool):
return None
if isinstance(value, int | float | np.number):
return float(value)
return None
def _to_native(obj: Any) -> Any:
"""Convert numpy/torch values for JSON serialization."""
if isinstance(obj, np.ndarray):
return _to_native(obj.tolist())
if isinstance(obj, np.generic):
return _to_native(obj.item())
if isinstance(obj, Mapping):
return {_to_native(key): _to_native(value) for key, value in obj.items()}
if isinstance(obj, (list, tuple, set)):
return [_to_native(item) for item in obj]
if torch is not None and isinstance(obj, torch.Tensor):
return obj.item() if obj.ndim == 0 else obj.tolist()
return obj
class AglRolloutManagerBase:
"""Base manager for Agent Lightning rollout HTTP operations."""
def __init__(
self,
*,
agl_base_url: str,
agl_key: str,
model: str,
step: int,
train_rollout_n: int = 1,
rollout_timeout_seconds: float = 1200.0,
poll_interval_seconds: float = 1.0,
hooks: RolloutHooks | None = None,
local_agent_class: str | None = None,
local_env_map: dict[str, str] | None = None,
k8s_job_template_path: str | None = None,
) -> None:
self._model = model
self._step = step
self._train_rollout_n = train_rollout_n
self._poll_interval_seconds = poll_interval_seconds
self._hooks = hooks
self._rollout_config: dict[str, Any] = {"timeout_seconds": int(rollout_timeout_seconds)}
if local_agent_class:
self._rollout_config["local"] = {
"agent_class": local_agent_class,
"env_map": local_env_map or {},
}
if k8s_job_template_path:
self._rollout_config["k8s"] = {"job_template": Path(k8s_job_template_path).read_text()}
self.client = AgentLightningSyncClient(
base_url=agl_base_url,
key=agl_key,
timeout=120.0,
transport=RetryTransport(retry=Retry(total=10, allowed_methods=["GET"])),
)
def register_model(self, server_addresses: list[str]) -> list[Model]:
"""Register model server endpoints."""
models: list[Model] = []
for address in server_addresses:
endpoint = address if address.startswith("http") else f"http://{address}/v1"
models.append(Model(model=self._model, endpoint=endpoint))
# Model registration is idempotent, so transient failures are safe to retry.
payload = [model.model_dump(mode="json") for model in models]
response = self.client.post_with_retry("/api/models", json=payload)
return [Model.model_validate(item) for item in response.json()]
def delete_model(self) -> dict[str, Any]:
"""Delete registered model endpoints. Best-effort: ignore errors."""
try:
response = self.client.delete("/api/models")
response.raise_for_status()
return response.json()
except Exception as exc:
print(f"RolloutManager: failed to delete models: {exc}")
return {}
def _get_rollout(self, rollout_id: str) -> Rollout:
response = self.client.get(f"/api/rollouts/{rollout_id}")
response.raise_for_status()
payload = response.json()
item = payload["rollout"] if isinstance(payload, dict) and "rollout" in payload else payload
return Rollout.model_validate(item)
def _delete_rollout(self, rollout_id: str) -> None:
try:
self.client.delete(f"/api/rollouts/{rollout_id}")
except Exception as exc:
print(f"RolloutManager: failed to delete rollout {rollout_id}: {exc}")
@staticmethod
def _record_lifecycle_timestamps(enqueued_rollout: EnqueuedRollout, rollout: Rollout) -> None:
"""Capture server-authoritative running/finished timestamps in place.
Pods are launched in CPU-limited batches, so a rollout can sit QUEUING
well after it was submitted; status.updated_at at the queuing->running
flip is the moment its pod actually started. We record it the first time
we observe RUNNING (or, if we polled too slowly and skipped straight to a
terminal state, the terminal updated_at) so running_at - enqueue_time
reflects the real queue/startup wait.
"""
state = rollout.status.state
updated_at = rollout.status.updated_at
if enqueued_rollout.running_at is None and state in (
RolloutState.RUNNING,
RolloutState.SUCCEEDED,
RolloutState.FAILED,
):
enqueued_rollout.running_at = updated_at
if state in TERMINAL_STATES:
enqueued_rollout.finished_at = updated_at
def _get_events(self, rollout_id: str, *, event_type: str | None = None, format: str | None = None) -> list[Event]:
params = {
key: value for key, value in {"event_type": event_type, "format": format}.items() if value is not None
}
response = self.client.get(f"/api/rollouts/{rollout_id}/events", params=params)
response.raise_for_status()
return [Event.model_validate(item) for item in response.json()]
def _post_event(self, rollout_id: str, attempt_id: str, event: EventCreate) -> Event:
response = self.client.post(
f"/api/rollouts/{rollout_id}/attempt/{attempt_id}/events",
json=event.model_dump(mode="json"),
)
response.raise_for_status()
return Event.model_validate(response.json())
def _create_rollouts(self, data: dict[str, Any], *, is_train: bool) -> list[EnqueuedRollout]:
keys = list(data.keys())
if not keys:
return []
num_samples = len(data[keys[0]])
rollouts_per_sample = self._train_rollout_n if is_train else 1
rollout_requests: list[RolloutCreate] = []
enqueued_rollouts: list[EnqueuedRollout] = []
for sample_idx in range(num_samples):
original = {key: _to_native(data[key][sample_idx]) for key in keys}
data_id = str(uuid.uuid4())
for _ in range(rollouts_per_sample):
request = RolloutCreate(
input=_to_native(original),
is_train=is_train,
config=cast(Any, self._rollout_config), # pydantic coerces the dict
metadata={},
)
if self._hooks is not None:
request = self._hooks.on_enqueue(request)
# Assign the id after hooks so creation remains idempotent.
rollout_id = uuid.uuid4().hex
request = request.model_copy(update={"rollout_id": rollout_id})
enqueued_rollouts.append(
EnqueuedRollout(
data_id=data_id,
input=request.input,
rollout_id=rollout_id,
step=self._step,
sample_idx_in_step=sample_idx,
enqueue_time=time.time(),
)
)
rollout_requests.append(request)
if not rollout_requests:
return []
# Preassigned ids make batch creation safe to retry without duplicates.
payload = [request.model_dump(mode="json", exclude_none=True) for request in rollout_requests]
response = self.client.post_with_retry("/api/rollouts", json=payload)
created = [Rollout.model_validate(item) for item in response.json()]
assert len(created) == len(rollout_requests), (
f"Agent Lightning returned {len(created)} rollouts, expected {len(rollout_requests)}"
)
return [
enqueued_rollout.model_copy(update={"rollout_id": rollout.rollout_id})
for enqueued_rollout, rollout in zip(enqueued_rollouts, created, strict=True)
]
def _fetch_rollout_events(self, rollout_id: str) -> tuple[list[Event], list[Event]]:
raw_events = self._get_events(rollout_id)
triplet_events = self._get_events(rollout_id, format="triplet")
return raw_events, triplet_events
@staticmethod
def _events_by_attempt(raw_events: list[Event], fallback_attempt_id: str) -> dict[str, list[Event]]:
grouped: dict[str, list[Event]] = defaultdict(list)
for event in raw_events:
grouped[event.attempt_id or fallback_attempt_id].append(event)
if not grouped:
grouped[fallback_attempt_id] = []
return dict(grouped)
def _run_succeeded_hook(self, rollout: Rollout) -> None:
if self._hooks is None:
return
attempt_id = rollout.status.last_attempt_id or "unknown"
trace_event_helper = _TraceEventHelper()
raw_events = self._get_events(rollout.rollout_id)
events_by_attempt = self._events_by_attempt(raw_events, attempt_id)
try:
self._hooks.on_succeeded(rollout, events_by_attempt, trace_event_helper)
trace_event_helper.flush(self)
except Exception:
traceback.print_exc()
print(f"RolloutManager: on_succeeded hook failed for rollout {rollout.rollout_id}")
def _run_failed_hook(self, rollout: Rollout) -> None:
if self._hooks is None:
return
trace_event_helper = _TraceEventHelper()
try:
self._hooks.on_failed(rollout, trace_event_helper)
trace_event_helper.flush(self)
except Exception:
traceback.print_exc()
print(f"RolloutManager: on_failed hook failed for rollout {rollout.rollout_id}")
def _build_completed_rollout(self, enqueued_rollout: EnqueuedRollout, rollout: Rollout) -> CompletedRollout:
"""Fetch triplets and reward for a terminal rollout."""
raw_events, triplet_events = self._fetch_rollout_events(enqueued_rollout.rollout_id)
triplets: list[Triplet] = []
for event in triplet_events:
if event.event_type != "model_request":
continue
data = event.data
http_status = data.get("http_status")
response_token_ids = data.get("response_token_ids", [])
if data.get("status") == "error" or (isinstance(http_status, int) and http_status >= 400):
continue
if not response_token_ids:
continue
triplets.append(
Triplet(
prompt={"token_ids": data.get("prompt_token_ids", [])},
response={
"token_ids": response_token_ids,
"log_probs": data.get("response_log_probs"),
},
reward=None,
metadata={"server": data.get("server", {})},
)
)
final_reward: float | None = None
reward_events = [event for event in triplet_events if event.event_type == "reward"]
if reward_events:
reward_data = reward_events[-1].data
final_reward = _as_reward_value(reward_data.get("value"))
if triplets and final_reward is not None:
triplets[-1] = triplets[-1].model_copy(update={"reward": final_reward})
metadata = rollout.metadata.model_dump()
finished_at = enqueued_rollout.finished_at
if finished_at is None:
finished_at = rollout.status.updated_at
return CompletedRollout(
rollout_id=enqueued_rollout.rollout_id,
data_id=enqueued_rollout.data_id,
step=enqueued_rollout.step,
sample_idx_in_step=enqueued_rollout.sample_idx_in_step,
input=enqueued_rollout.input,
enqueue_time=enqueued_rollout.enqueue_time,
running_at=enqueued_rollout.running_at,
finished_at=finished_at,
final_reward=final_reward,
triplets=triplets,
metadata=metadata,
events=[event.model_dump() for event in raw_events],
triplet_events=[event.model_dump() for event in triplet_events],
rollout_state=rollout.status.state,
error_message=rollout.status.error_message,
)
class AglRolloutManager(AglRolloutManagerBase):
def enqueue_and_wait_until_completed(
self,
data: dict[str, Any],
*,
is_train: bool,
) -> list[CompletedRollout]:
"""Create rollouts, wait for completion, and return results."""
enqueued_rollouts = self._create_rollouts(data, is_train=is_train)
pending_rollouts = list(enqueued_rollouts)
completed_rollouts: list[CompletedRollout] = []
num_deleted = 0
num_succeeded = 0
num_failed = 0
while len(completed_rollouts) < len(enqueued_rollouts):
# Delete prior completions before polling to bound server-side state.
for completed_rollout in completed_rollouts[num_deleted:]:
self._delete_rollout(completed_rollout.rollout_id)
num_deleted = len(completed_rollouts)
for enqueued_rollout in list(pending_rollouts):
rollout_id = enqueued_rollout.rollout_id
rollout = self._get_rollout(rollout_id)
state = rollout.status.state
self._record_lifecycle_timestamps(enqueued_rollout, rollout)
if state not in TERMINAL_STATES:
continue
pending_rollouts.remove(enqueued_rollout)
if state == RolloutState.SUCCEEDED:
num_succeeded += 1
self._run_succeeded_hook(rollout)
elif state == RolloutState.FAILED:
num_failed += 1
self._run_failed_hook(rollout)
completed_rollouts.append(self._build_completed_rollout(enqueued_rollout, rollout))
print(
f"AglRolloutManager: completed={len(completed_rollouts)}/{len(enqueued_rollouts)} "
f"succeeded={num_succeeded} failed={num_failed}"
)
if pending_rollouts:
time.sleep(self._poll_interval_seconds)
# Delete whatever completed in the final round.
for completed_rollout in completed_rollouts[num_deleted:]:
self._delete_rollout(completed_rollout.rollout_id)
return completed_rollouts
class AglAsyncRolloutManager(AglRolloutManagerBase):
"""Async rollout manager."""
def enqueue_and_wait_until_group_completed(
self,
data: dict[str, Any],
carry_over_enqueued_rollouts: list[EnqueuedRollout],
*,
is_train: bool,
target_finished_group_num: int,
) -> tuple[list[CompletedRollout], list[EnqueuedRollout]]:
"""Enqueue rollouts and wait for enough completed rollout groups."""
assert is_train is True
enqueued_rollouts = self._create_rollouts(data, is_train=True)
active_rollouts = carry_over_enqueued_rollouts + enqueued_rollouts
if not active_rollouts:
return [], []
grouped_rollouts: dict[str, list[EnqueuedRollout]] = defaultdict(list)
for enqueued_rollout in active_rollouts:
grouped_rollouts[enqueued_rollout.data_id].append(enqueued_rollout)
for group in grouped_rollouts.values():
assert len(group) == self._train_rollout_n
finished_rollout_ids: set[str] = set()
terminal_rollouts: dict[str, Rollout] = {}
completed_group_keys: set[str] = set()
completed_rollouts: list[CompletedRollout] = []
num_succeeded = 0
num_failed = 0
while len(completed_group_keys) < target_finished_group_num:
for data_id, group in grouped_rollouts.items():
if data_id in completed_group_keys:
continue
for enqueued_rollout in group:
if enqueued_rollout.rollout_id in finished_rollout_ids:
continue
rollout = self._get_rollout(enqueued_rollout.rollout_id)
state = rollout.status.state
self._record_lifecycle_timestamps(enqueued_rollout, rollout)
if state not in TERMINAL_STATES:
continue
finished_rollout_ids.add(enqueued_rollout.rollout_id)
terminal_rollouts[enqueued_rollout.rollout_id] = rollout
if state == RolloutState.SUCCEEDED:
num_succeeded += 1
self._run_succeeded_hook(rollout)
elif state == RolloutState.FAILED:
num_failed += 1
self._run_failed_hook(rollout)
if all(enqueued_rollout.rollout_id in finished_rollout_ids for enqueued_rollout in group):
completed_group_keys.add(data_id)
completed_rollouts.extend(
self._build_completed_rollout(
enqueued_rollout,
terminal_rollouts[enqueued_rollout.rollout_id],
)
for enqueued_rollout in group
)
# Free completed group state after reading it.
for enqueued_rollout in group:
self._delete_rollout(enqueued_rollout.rollout_id)
if len(completed_group_keys) >= target_finished_group_num:
break
print(
f"AglAsyncRolloutManager: completed_groups={len(completed_group_keys)}/{target_finished_group_num} "
f"finished_rollouts={len(finished_rollout_ids)}/{len(active_rollouts)} "
f"succeeded={num_succeeded} failed={num_failed}"
)
if len(completed_group_keys) < target_finished_group_num:
time.sleep(self._poll_interval_seconds)
new_carry_over_rollouts = [
enqueued_rollout
for data_id, group in grouped_rollouts.items()
if data_id not in completed_group_keys
for enqueued_rollout in group
]
return completed_rollouts, new_carry_over_rollouts
__all__ = [
"AglAsyncRolloutManager",
"AglRolloutManager",
"AglRolloutManagerBase",
"CompletedRollout",
"EnqueuedRollout",
"Triplet",
]
-41
View File
@@ -1,41 +0,0 @@
import ray
from copy import deepcopy
from agentlightning.instrumentation.vllm import instrument_vllm, ChatCompletionResponsePatched
from starlette.requests import Request
from starlette.responses import JSONResponse, StreamingResponse
from vllm.entrypoints.openai.protocol import ChatCompletionRequest, ErrorResponse
from verl.workers.rollout.vllm_rollout.vllm_async_server import AsyncvLLMServer
def _unwrap_ray_remote(cls):
if hasattr(cls, "__ray_actor_class__"):
cls = cls.__ray_actor_class__
return cls
@ray.remote(num_cpus=1)
class PatchedvLLMServer(_unwrap_ray_remote(AsyncvLLMServer)):
def __init__(self, *args, **kwargs):
instrument_vllm()
super().__init__(*args, **kwargs)
self.config = deepcopy(self.config)
self.config.rollout.multi_turn.tool_config_path = "/dev/null"
async def chat_completion(self, raw_request: Request):
"""OpenAI-compatible HTTP endpoint.
API reference: https://docs.vllm.ai/en/latest/serving/openai_compatible_server.html
"""
request_json = await raw_request.json()
request = ChatCompletionRequest(**request_json)
generator = await self.openai_serving_chat.create_chat_completion(request, raw_request)
if isinstance(generator, ErrorResponse):
return JSONResponse(content=generator.model_dump(), status_code=generator.code)
if request.stream:
return StreamingResponse(content=generator, media_type="text/event-stream")
else:
return JSONResponse(content=generator.model_dump())
+25 -5
View File
@@ -6,16 +6,36 @@ defaults:
- ppo_trainer
- _self_
algorithm:
enable_rollout_level_advantage: true
agentlightning:
port: 9999
agl_base_url: http://localhost:8080
agl_key: ""
hooks: null
rollout_timeout_seconds: 1800
local:
agent_class: null
env_map: {}
k8s:
job_template_path: null
reward_fillna_value: 0.0
max_ppo_update_times: null
trace_aggregator:
level: trajectory # transition | trajectory
trajectory_max_prompt_length: 2048
trajectory_max_response_length: 8192
async_rollout:
enabled: false
async_train_batch_size: null
data:
filter_overlong_prompts: false
actor_rollout_ref:
actor:
calculate_entropy: true
policy_loss:
loss_mode: per_rollout_mean
rollout:
mode: async
agent:
custom_async_server:
path: pkg://agentlightning.verl.async_server
name: PatchedvLLMServer
-516
View File
@@ -1,516 +0,0 @@
import asyncio
import json
import random
import socket
import threading
import time
import uuid
from typing import Dict, List, Optional
import numpy as np
import requests
import torch
from agentlightning import LLM, AgentLightningServer, NamedResources, Rollout, configure_logger
from flask import Flask, Response, abort, request
from openai.types.chat.chat_completion import ChatCompletion
from tensordict import TensorDict
from verl import DataProto
configure_logger()
def get_left_padded_ids_and_attention_mask(ids: List[int], max_length: int, pad_token_id: int):
"""
Left-pad (or truncate) a sequence of token IDs to a fixed length,
and build the corresponding attention mask.
Args:
ids: the original list of token IDs.
max_length: desired total length after padding/truncation.
pad_token_id: ID to use for padding.
Returns:
padded_ids (any): list of length == max_length.
attention_mask (any): list of same length: 1 for non-pad tokens, 0 for pads.
"""
seq_len = len(ids)
if seq_len >= max_length:
# too long → truncate from the left, keep the last max_length tokens
trimmed = ids[-max_length:]
attention_mask = [1] * max_length
return trimmed, attention_mask
# too short → pad on the left
pad_len = max_length - seq_len
padded_ids = [pad_token_id] * pad_len + ids
attention_mask = [0] * pad_len + [1] * seq_len
return padded_ids, attention_mask
def get_right_padded_ids_and_attention_mask(ids: List[int], max_length: int, pad_token_id: int):
"""
Right-pad (or truncate) a sequence of token IDs to a fixed length,
and build the corresponding attention mask.
Args:
ids: the original list of token IDs.
max_length: desired total length after padding/truncation.
pad_token_id: ID to use for padding.
Returns:
padded_ids (any): list of length == max_length.
attention_mask (any): list of same length: 1 for non-pad tokens, 0 for pads.
"""
seq_len = len(ids)
if seq_len >= max_length:
# too long → truncate to the first max_length tokens
trimmed = ids[:max_length]
attention_mask = [1] * max_length
return trimmed, attention_mask
# too short → pad on the right
pad_len = max_length - seq_len
padded_ids = ids + [pad_token_id] * pad_len
attention_mask = [1] * seq_len + [0] * pad_len
return padded_ids, attention_mask
def _find_available_port() -> int:
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
s.bind(("", 0))
return s.getsockname()[1]
class AgentModeDaemon:
"""
AgentModeDaemon using the AgentLightningServer SDK.
This class manages the server lifecycle, task queueing, and results
retrieval, while also running a proxy server for LLM requests. It maintains
the original interface for compatibility with the RayPPOTrainer.
"""
def __init__(
self,
port,
train_rollout_n,
train_information,
tokenizer,
mini_batch_size,
pad_token_id,
reward_fillna_value=0.0,
llm_timeout_seconds=600.0,
):
# Server and Task Configuration
self.server_port = port
self.llm_timeout_seconds = llm_timeout_seconds
self.server = AgentLightningServer(
host="0.0.0.0", port=self.server_port, task_timeout_seconds=self.llm_timeout_seconds
)
self.proxy_port = _find_available_port() # Run proxy on a different port
# Training and Data Configuration
self.train_rollout_n = train_rollout_n
self.train_information = train_information
self.mini_batch_size = mini_batch_size
self.pad_token_id = pad_token_id
self.tokenizer = tokenizer
self.reward_fillna_value = reward_fillna_value
# Internal State
self.backend_llm_server_addresses: List[str] = []
self._total_tasks_queued = 0
self._completed_rollouts: Dict[str, Rollout] = {}
self._task_id_to_original_sample: Dict[str, Dict] = {}
self._server_thread: Optional[threading.Thread] = None
self._proxy_thread: Optional[threading.Thread] = None
self.is_train = True
def _start_proxy_server(self):
"""
Initializes and runs a Flask-based proxy server in a separate thread.
This proxy load-balances requests to the actual backend LLM servers.
"""
app = Flask(__name__)
num_requests = 0
last_request_time = 0
@app.route("/v1/<path:path>", methods=["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD"])
def proxy(path):
if not self.backend_llm_server_addresses:
abort(503, description="No backend LLM servers available.")
# Randomly choose a backend server for load balancing
target_server = random.choice(self.backend_llm_server_addresses)
target_url = f"http://{target_server}/v1/{path}"
# Copy client request headers, removing the Host header
headers = {key: value for key, value in request.headers if key.lower() != "host"}
# Log the request for debugging
nonlocal num_requests, last_request_time
current_time = time.time()
num_requests += 1
if current_time - last_request_time > 60 or num_requests == 1 or num_requests % 100 == 0:
print(f"Proxying {request.method} request to {target_server}. Request data: {request.get_data()}")
last_request_time = current_time
try:
# Forward the request to the target backend
resp = requests.request(
method=request.method,
url=target_url,
headers=headers,
params=request.args,
data=request.get_data(),
cookies=request.cookies,
allow_redirects=False,
timeout=self.llm_timeout_seconds,
)
# Filter out hop-by-hop headers before returning the response
excluded_headers = [
"content-encoding",
"content-length",
"transfer-encoding",
"connection",
"keep-alive",
"proxy-authenticate",
"proxy-authorization",
"te",
"trailers",
"upgrade",
]
response_headers = [
(name, value) for name, value in resp.raw.headers.items() if name.lower() not in excluded_headers
]
if resp.status_code == 200:
# NOTE: from Zhiyuan's code.
# https://github.com/hzy46/verl_agent_mode/blob/2db65ea9858f645a914120357412a7540f8bd82d/verl/trainer/ppo/ray_trainer.py#L692-L711
# request_json = json.loads(request.get_data().decode("utf-8"))
response_json = json.loads(resp.content.decode("utf-8"))
# response_message = ChatCompletion(**response_json).choices[0].message.model_dump(exclude_unset=True, exclude_none=True)
# tool_schemas = request_json.get("tools", None)
# prompt_ids = self.tokenizer.apply_chat_template(request_json["messages"], tools=tool_schemas, add_generation_prompt=True, tokenize=True)
# full_ids = self.tokenizer.apply_chat_template(request_json["messages"] + [response_message], tools=tool_schemas, add_generation_prompt=False, tokenize=True)
# TBD: response_ids sometimes ends with "<eos_id>\n", shall we keep the extra "\n"?
# sometimes it has some differences with the hacky method in the end, but this should align with ToolCompletionCallback
# response_ids = full_ids[len(prompt_ids):]
# NOTE (yuge): They are different. Don't know why.
# assert response_json['prompt_token_ids'] == prompt_ids
# patched_response_ids = response_json['response_token_ids'][0]
# assert patched_response_ids == response_ids[:len(patched_response_ids)], f"{patched_response_ids} != {response_ids[:len(patched_response_ids)]}"
# response_json['prompt_token_ids'] = prompt_ids
# response_json['response_token_ids'] = [response_ids]
replaced_return_content = json.dumps(response_json).encode("utf-8")
return Response(replaced_return_content, status=resp.status_code, headers=response_headers)
return Response(resp.content, resp.status_code, response_headers)
except requests.exceptions.RequestException as e:
abort(500, description=f"Error proxying request: {e}")
def run_app():
app.run(host="0.0.0.0", port=self.proxy_port, threaded=True, debug=False)
self._proxy_thread = threading.Thread(target=run_app, daemon=True)
self._proxy_thread.start()
print(f"Proxy server running on port {self.proxy_port}")
def start(self):
"""Starts the main AgentLightningServer and the proxy server."""
def run_server():
"""Run the AgentLightningServer in a separate thread."""
asyncio.run(self.server.run_forever())
self._server_thread = threading.Thread(target=run_server, daemon=True)
self._server_thread.start()
# Wait for the server's internal startup event to be set.
print("Waiting for AgentLightningServer to start...")
is_ready = self.server.startup_event.wait(timeout=20.0) # Wait up to 20s
if not is_ready:
raise RuntimeError("AgentLightningServer failed to start within the timeout period.")
print(f"AgentLightningServer control plane running on port {self.server_port}")
self._start_proxy_server()
async def _async_set_up(self, data, server_addresses, is_train=True):
"""Async helper to set up data and resources on the server."""
self.clear_data_and_server()
self.backend_llm_server_addresses = server_addresses
self.is_train = is_train
# 1. Update resources on the server for clients to use
llm_resource = LLM(
endpoint=f"http://127.0.0.1:{self.proxy_port}/v1",
model=self.train_information.get("model", "default-model"),
sampling_parameters={"temperature": self.train_information.get("temperature", 0.7)},
)
resources: NamedResources = {"main_llm": llm_resource}
resources_id = await self.server.update_resources(resources)
# 2. Queue tasks for agents to process
keys = list(data.keys())
num_samples = len(data[keys[0]])
rollouts_per_sample = self.train_rollout_n if is_train else 1
for i in range(num_samples):
data_id = str(uuid.uuid4())
original_sample = {key: data[key][i] for key in keys}
original_sample["data_id"] = data_id
# For training, each sample is rolled out multiple times
for j in range(rollouts_per_sample):
task_metadata = {"data_id": data_id, "is_train": is_train}
# Data ID is different from Rollout ID, as one data can have multiple rollouts.
rollout_id = await self.server.queue_task(
sample=original_sample,
mode="train" if is_train else "val",
resources_id=resources_id,
metadata=task_metadata,
)
# Store original sample data to reconstruct batch information later
self._task_id_to_original_sample[rollout_id] = original_sample
self._total_tasks_queued += 1
def set_up_data_and_server(self, data, server_addresses, is_train=True):
"""Synchronous wrapper for setting up data and server resources."""
if not self.server.loop or not self.server.startup_event.is_set():
raise RuntimeError("Server is not running or ready.")
coro = self._async_set_up(data, server_addresses, is_train)
future = asyncio.run_coroutine_threadsafe(coro, self.server.loop)
try:
future.result(timeout=60) # Wait for completion with a timeout
except Exception as e:
print(f"Failed to set up data on server: {e}")
raise
def _validate_data(self, rollout: Rollout):
if rollout.final_reward is None:
print(
f"Warning: Reward is None for rollout {rollout.rollout_id}, will be auto-set to {self.reward_fillna_value}."
)
if rollout.triplets is None:
print(f"Warning: Triplet is None for rollout {rollout.rollout_id}.")
elif len(rollout.triplets) == 0:
print(f"Warning: Length of triplets is 0 for rollout {rollout.rollout_id}.")
elif any(not r.response.get("token_ids", []) for r in rollout.triplets):
print(f"Warning: Rollout {rollout.rollout_id} contains empty response: {rollout.triplets}")
elif any(not r.prompt.get("token_ids", []) for r in rollout.triplets):
print(f"Warning: Rollout {rollout.rollout_id} contains empty prompt: {rollout.triplets}")
async def _async_run_until_finished(self, verbose=True):
"""Async helper to wait for all tasks to complete."""
while len(self._completed_rollouts) < self._total_tasks_queued:
completed_batch = await self.server.retrieve_completed_rollouts()
for rollout in completed_batch:
self._validate_data(rollout)
self._completed_rollouts[rollout.rollout_id] = rollout
if verbose:
print(f"Completed {len(self._completed_rollouts)}/{self._total_tasks_queued} tasks...")
await asyncio.sleep(5)
print("All tasks finished.")
def run_until_all_finished(self, verbose=True):
"""Synchronously waits for all queued tasks to be completed and reported."""
if self._total_tasks_queued == 0:
print("Warning: No tasks were queued.")
return
if not self.server.loop or not self.server.startup_event.is_set():
raise RuntimeError("Server is not running or ready.")
coro = self._async_run_until_finished(verbose)
future = asyncio.run_coroutine_threadsafe(coro, self.server.loop)
try:
future.result() # Wait indefinitely for all tasks to complete
except Exception as e:
print(f"Error while waiting for tasks to finish: {e}")
raise
def get_test_metrics(self):
"""Calculates and returns metrics for a validation run."""
assert not self.is_train, "This method should only be called during validation."
assert len(self._completed_rollouts) == self._total_tasks_queued
sample_stat_list = []
for rollout_id, rollout in self._completed_rollouts.items():
if not rollout.triplets:
continue
response_length_list = [len(triplet.response.get("token_ids", [])) for triplet in rollout.triplets]
final_reward = self._fillna_reward(rollout)
sample_stat_list.append(
{
"sum_response_length": np.sum(response_length_list),
"mean_response_length": np.mean(response_length_list) if response_length_list else 0,
"turn_count": len(rollout.triplets),
"reward": final_reward,
}
)
return {
"val/reward": np.mean([stat["reward"] for stat in sample_stat_list]),
"val/mean_response_length": np.mean([stat["mean_response_length"] for stat in sample_stat_list]),
"val/sum_response_length": np.mean([stat["sum_response_length"] for stat in sample_stat_list]),
"val/turn_count": np.mean([stat["turn_count"] for stat in sample_stat_list]),
}
def get_train_data_batch(self, max_prompt_length, max_response_length, device):
"""
Processes completed rollouts to generate a training data batch.
This function reconstructs the logic from the original AgentModeDaemon,
using data retrieved from the new server architecture. It handles padding,
truncation, and tensor creation for the PPO training loop.
"""
assert self.is_train, "This method should only be called during training."
assert len(self._completed_rollouts) == self._total_tasks_queued
# 1. Reconstruct the `finished_id_to_sample_info` structure from completed rollouts
finished_id_to_sample_info = {}
for rollout_id, rollout in self._completed_rollouts.items():
original_sample = self._task_id_to_original_sample[rollout_id]
if not rollout.triplets:
continue
# The client should report triplets that contain prompt_ids and response_ids.
# Example triplet.prompt: {"token_ids": [...]}
# Example triplet.response: {"token_ids": [...]}
trace_list = [
{"prompt_ids": t.prompt.get("token_ids", []), "response_ids": t.response.get("token_ids", [])}
for t in rollout.triplets
]
final_reward = self._fillna_reward(rollout)
info = {
"reward": final_reward,
"trace_list": trace_list,
"data_id": original_sample["data_id"],
}
finished_id_to_sample_info[rollout_id] = info
#
# --- Data processing and tensor creation logic ---
# Get all the reported data.
# prompt_ids are left-padded.
# response_ids are right-padded.
# They are concatenated in the middle.
# Discard handling:
# - Those exceeding max_prompt_length will be marked for discard, but not
# discarded here. They are only truncated and marked, to be discarded later.
# This is for the correctness of the advantage calculation.
# - The discard for the PPO mini-batch should also be handled this way.
input_ids_list, input_attention_mask_list = [], []
response_ids_list, response_attention_mask_list = [], []
reward_list, data_id_list, rollout_id_list, turn_index_list, is_drop_list = [], [], [], [], []
n_trunc_sample_because_of_response = 0
for rollout_id, sample_info in finished_id_to_sample_info.items():
for turn_index, trace in enumerate(sample_info["trace_list"]):
reward_list.append(sample_info["reward"])
prompt_ids, response_ids = trace["prompt_ids"], trace["response_ids"]
# Mark samples with prompts exceeding max_prompt_length to be dropped later
if len(prompt_ids) > max_prompt_length:
prompt_ids = prompt_ids[:max_prompt_length]
is_drop_list.append(True)
else:
is_drop_list.append(False)
# Truncate responses that exceed max_response_length
if len(response_ids) > max_response_length:
response_ids = response_ids[:max_response_length]
n_trunc_sample_because_of_response += 1
# Pad prompts to the left and responses to the right
one_input_ids, one_input_attention_mask = get_left_padded_ids_and_attention_mask(
prompt_ids, max_prompt_length, self.pad_token_id
)
one_response_ids, one_response_attention_mask = get_right_padded_ids_and_attention_mask(
response_ids, max_response_length, self.pad_token_id
)
input_ids_list.append(one_input_ids)
input_attention_mask_list.append(one_input_attention_mask)
response_ids_list.append(one_response_ids)
response_attention_mask_list.append(one_response_attention_mask)
data_id_list.append(sample_info["data_id"])
rollout_id_list.append(rollout_id)
turn_index_list.append(turn_index)
n_transition = len(input_ids_list)
batch_input_ids = torch.LongTensor(input_ids_list).to(device)
input_attention_mask = torch.LongTensor(input_attention_mask_list).to(device)
batch_response_ids = torch.LongTensor(response_ids_list).to(device)
response_attention_mask = torch.LongTensor(response_attention_mask_list).to(device)
# Concatenate prompts and responses to form the full sequence
batch_seq = torch.cat([batch_input_ids, batch_response_ids], dim=-1)
attention_mask = torch.cat([input_attention_mask, response_attention_mask], dim=-1)
position_ids = torch.clamp(torch.cumsum(attention_mask, dim=-1) - 1, min=0)
is_drop_mask = torch.BoolTensor(is_drop_list).to(device)
scores = torch.tensor(reward_list, dtype=torch.bfloat16).to(device)
# Create token-level scores by placing the final reward at the last token position
token_level_scores = torch.zeros_like(attention_mask, dtype=scores.dtype)
# At the eos_mask_idx position of each sample, fill in the corresponding scores.
# torch.arange(n_transition) generates [0,1,2,...,bsz-1] as indices for the batch dimension.
eos_mask_idx = torch.argmax(position_ids * attention_mask, dim=-1) # (bsz,)
token_level_scores[torch.arange(n_transition), eos_mask_idx] = scores
# Only take the last response_length part of the sequence to get the token-level scores for the model's response part.
token_level_scores = token_level_scores[:, -max_response_length:]
# Form the final batch using TensorDict
batch = TensorDict(
{
"prompts": batch_input_ids,
"responses": batch_response_ids,
"input_ids": batch_seq, # here input_ids become the whole sentences
"attention_mask": attention_mask,
"position_ids": position_ids,
"is_drop_mask": is_drop_mask,
"token_level_scores": token_level_scores.contiguous(),
},
batch_size=n_transition,
)
data_proto = DataProto(batch=batch)
data_metrics = {
"agent_mode/n_trunc_sample_because_of_response": n_trunc_sample_because_of_response,
"agent_mode/n_sample_to_train": n_transition,
}
# Add non-tensor data for advantage calculation and logging
data_proto.non_tensor_batch["data_id_list"] = np.array(data_id_list)
data_proto.non_tensor_batch["rollout_id_list"] = np.array(rollout_id_list)
data_proto.non_tensor_batch["turn_index_list"] = np.array(turn_index_list)
return data_proto, data_metrics
def clear_data_and_server(self):
"""Resets the internal state of the daemon for the next run."""
self.backend_llm_server_addresses = []
self._completed_rollouts.clear()
self._task_id_to_original_sample.clear()
self._total_tasks_queued = 0
# For a true reset, the server's internal queues would also need clearing.
# This implementation assumes that `set_up_data_and_server` is called
# for each new run, effectively starting a fresh batch.
def _fillna_reward(self, rollout):
if rollout.final_reward is None:
if self.reward_fillna_value is not None:
final_reward = self.reward_fillna_value
else:
raise ValueError(f"Reward is None for rollout {rollout.rollout_id}, please check the reward function.")
else:
final_reward = rollout.final_reward
return final_reward
+29 -4
View File
@@ -1,20 +1,45 @@
# Copyright (c) Microsoft. All rights reserved.
# type: ignore
from collections.abc import Sequence
from typing import Any
import torch
from datasets import Dataset as HuggingFaceDataset
from verl.utils.dataset.rl_dataset import RLHFDataset
__all__ = [
"LoadedDataset",
]
class AgentDataset(RLHFDataset):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
class LoadedDataset(RLHFDataset):
"""Dataset wrapper for pre-loaded in-memory data sequences.
Bypasses RLHFDataset's file-based initialization and directly sets
``self.dataframe`` from the provided sequence.
"""
def __init__(self, dataset: Sequence[Any]):
# Skip file-based RLHFDataset initialization; only dataframe behavior is needed.
dataset_copy = [dataset[i] for i in range(len(dataset))]
self.dataframe = HuggingFaceDataset.from_list(dataset_copy)
self.filter_overlong_prompts = False
self.serialize_dataset = True # Tell __getstate__ to serialize inline
self.original_data_files = None # Not file-backed
def __len__(self):
return len(self.dataframe)
def __getitem__(self, item):
row_dict: dict = self.dataframe[item]
# add index for each prompt
index = row_dict.get("extra_info", {}).get("index", 0)
row_dict["index"] = index
# Workaround for data proto. At least one tensor is needed.
row_dict["fake_ids"] = torch.ones(1, dtype=torch.int)
return row_dict
def _read_files_and_tokenize(self):
pass
+104 -117
View File
@@ -1,156 +1,143 @@
import hydra
# Copyright (c) Microsoft. All rights reserved.
"""VERL entrypoint for Agent Lightning — wraps verl's PPO setup with a custom trainer.
Customizations:
1. Use AgentLightningRayPPOTrainer (subclass of RayPPOTrainer) that drives rollouts
through the Agent Lightning HTTP API instead of stock VERL agent loop workers.
2. Support pre-loaded in-memory datasets.
"""
# pyright: reportPrivateImportUsage=false
from __future__ import annotations
import os
import socket
from collections.abc import Sequence
from typing import Any, cast
import ray
from omegaconf import OmegaConf
from .dataset import AgentDataset
from .trainer import AgentLightningTrainer
from verl.trainer.ppo.reward import load_reward_manager
from verl.trainer.main_ppo import create_rl_sampler
from .dataset import LoadedDataset
__all__ = [
"run_ppo",
]
@hydra.main(config_path="pkg://agentlightning/verl", config_name="config", version_base=None)
def main(config):
run_ppo(config)
def run_ppo(
config: Any,
train_dataset: Sequence[Any],
val_dataset: Sequence[Any],
) -> None:
"""Launch VERL PPO training with Agent Lightning agent orchestration.
Datasets must be passed as non-empty in-memory sequences.
"""
from verl.trainer.main_ppo import get_ppo_ray_runtime_env
assert train_dataset is not None and len(train_dataset) > 0, "train_dataset must be non-empty"
assert val_dataset is not None and len(val_dataset) > 0, "val_dataset must be non-empty"
def run_ppo(config) -> None:
if not ray.is_initialized():
# this is for local ray cluster
default_runtime_env = cast(dict[str, Any], get_ppo_ray_runtime_env())
ray_init_config = OmegaConf.to_container(config.ray_kwargs.get("ray_init", OmegaConf.create({})), resolve=True)
ray_init_kwargs: dict[str, Any] = (
{str(key): value for key, value in ray_init_config.items()} if isinstance(ray_init_config, dict) else {}
)
runtime_env_config = ray_init_kwargs.pop("runtime_env", {})
runtime_env_kwargs = dict(runtime_env_config) if isinstance(runtime_env_config, dict) else {}
runtime_env = {**default_runtime_env, **runtime_env_kwargs}
# Register the custom policy loss in each Ray actor process.
runtime_env.setdefault(
"worker_process_setup_hook",
"agentlightning.verl.per_rollout_loss.register_in_worker",
)
_temp_dir = os.environ.get("RAY_TMPDIR")
ray.init(
runtime_env={
"env_vars": {"TOKENIZERS_PARALLELISM": "true", "NCCL_DEBUG": "WARN", "VLLM_LOGGING_LEVEL": "WARN"}
},
num_cpus=config.ray_init.num_cpus,
runtime_env=runtime_env,
**({"_temp_dir": _temp_dir} if _temp_dir else {}),
**ray_init_kwargs,
)
runner = TaskRunner.remote()
ray.get(runner.run.remote(config))
train_ds = LoadedDataset(train_dataset)
val_ds = LoadedDataset(val_dataset)
runner = cast(Any, _AglTaskRunner).remote()
ray.get(runner.run.remote(config, train_ds, val_ds))
@ray.remote(num_cpus=1) # please make sure main_task is not scheduled on head
class TaskRunner:
def run(self, config):
# print initial config
@ray.remote(num_cpus=1)
class _AglTaskRunner:
"""TaskRunner that extends verl's TaskRunner with pre-loaded dataset support."""
def __init__(self):
from verl.trainer.main_ppo import TaskRunner
self._delegate = TaskRunner()
def run(self, config, train_dataset, val_dataset):
from pprint import pprint
from omegaconf import OmegaConf
from verl.trainer.main_ppo import (
create_rl_sampler,
need_critic,
need_reference_policy,
validate_config,
)
from verl.utils.dataset.rl_dataset import collate_fn
from verl.utils.fs import copy_to_local
from verl.utils.tokenizer import hf_processor, hf_tokenizer
pprint(OmegaConf.to_container(config, resolve=True)) # resolve=True will eval symbol values
from agentlightning.verl.trainer import AgentLightningRayPPOTrainer
print(f"AglTaskRunner hostname: {socket.gethostname()}, PID: {os.getpid()}")
pprint(OmegaConf.to_container(config, resolve=True))
OmegaConf.resolve(config)
# download the checkpoint from hdfs
local_path = copy_to_local(config.actor_rollout_ref.model.path)
# Worker setup — delegated to verl's TaskRunner
d = self._delegate
actor_rollout_cls, ray_worker_group_cls = d.add_actor_rollout_worker(config)
d.add_critic_worker(config)
d.add_reward_model_resource_pool(config)
d.add_ref_policy_worker(config, actor_rollout_cls)
# instantiate tokenizer
from verl.utils import hf_processor, hf_tokenizer
validate_config(
config=config,
use_reference_policy=need_reference_policy(config),
use_critic=need_critic(config),
)
local_path = copy_to_local(
config.actor_rollout_ref.model.path,
use_shm=config.actor_rollout_ref.model.get("use_shm", False),
)
trust_remote_code = config.data.get("trust_remote_code", False)
tokenizer = hf_tokenizer(local_path, trust_remote_code=trust_remote_code)
processor = hf_processor(local_path, use_fast=True) # used for multimodal LLM, could be none
processor = hf_processor(local_path, trust_remote_code=trust_remote_code, use_fast=True)
# define worker classes
if config.actor_rollout_ref.actor.strategy in ["fsdp", "fsdp2"]:
assert config.critic.strategy in ["fsdp", "fsdp2"]
from verl.single_controller.ray import RayWorkerGroup
from verl.workers.fsdp_workers import ActorRolloutRefWorker, AsyncActorRolloutRefWorker, CriticWorker
resource_pool_manager = d.init_resource_pool_mgr(config)
actor_rollout_cls = (
AsyncActorRolloutRefWorker
if config.actor_rollout_ref.rollout.mode == "async"
else ActorRolloutRefWorker
)
ray_worker_group_cls = RayWorkerGroup
assert train_dataset is not None and len(train_dataset) > 0, "train_dataset must be non-empty"
assert val_dataset is not None and len(val_dataset) > 0, "val_dataset must be non-empty"
elif config.actor_rollout_ref.actor.strategy == "megatron":
assert config.actor_rollout_ref.actor.strategy == config.critic.strategy
from verl.single_controller.ray.megatron import NVMegatronRayWorkerGroup
from verl.workers.megatron_workers import ActorRolloutRefWorker, CriticWorker
actor_rollout_cls = ActorRolloutRefWorker
ray_worker_group_cls = NVMegatronRayWorkerGroup
else:
raise NotImplementedError
from verl.trainer.ppo.ray_trainer import ResourcePoolManager, Role
role_worker_mapping = {
Role.ActorRollout: ray.remote(actor_rollout_cls),
Role.Critic: ray.remote(CriticWorker),
}
global_pool_id = "global_pool"
resource_pool_spec = {
global_pool_id: [config.trainer.n_gpus_per_node] * config.trainer.nnodes,
}
mapping = {
Role.ActorRollout: global_pool_id,
Role.Critic: global_pool_id,
}
# we should adopt a multi-source reward function here
# - for rule-based rm, we directly call a reward score
# - for model-based rm, we call a model
# - for code related prompt, we send to a sandbox if there are test cases
# - finally, we combine all the rewards together
# - The reward type depends on the tag of the data
if config.reward_model.enable:
if config.reward_model.strategy in ["fsdp", "fsdp2"]:
from verl.workers.fsdp_workers import RewardModelWorker
elif config.reward_model.strategy == "megatron":
from verl.workers.megatron_workers import RewardModelWorker
else:
raise NotImplementedError
role_worker_mapping[Role.RewardModel] = ray.remote(RewardModelWorker)
mapping[Role.RewardModel] = global_pool_id
# use reference model
if config.algorithm.use_kl_in_reward or config.actor_rollout_ref.actor.use_kl_loss:
role_worker_mapping[Role.RefPolicy] = ray.remote(ActorRolloutRefWorker)
mapping[Role.RefPolicy] = global_pool_id
reward_fn = load_reward_manager(
config, tokenizer, num_examine=0, **config.reward_model.get("reward_kwargs", {})
)
val_reward_fn = load_reward_manager(
config, tokenizer, num_examine=1, **config.reward_model.get("reward_kwargs", {})
)
resource_pool_manager = ResourcePoolManager(resource_pool_spec=resource_pool_spec, mapping=mapping)
from verl.utils.dataset.rl_dataset import collate_fn
# Use our special dataset
train_dataset = AgentDataset(
data_files=config.data.train_files,
tokenizer=tokenizer,
processor=processor,
config=config.data,
)
val_dataset = AgentDataset(
data_files=config.data.val_files,
tokenizer=tokenizer,
processor=processor,
config=config.data,
)
train_sampler = create_rl_sampler(config.data, train_dataset)
trainer = AgentLightningTrainer(
trainer = AgentLightningRayPPOTrainer(
config=config,
tokenizer=tokenizer,
processor=processor,
role_worker_mapping=role_worker_mapping,
role_worker_mapping=d.role_worker_mapping,
resource_pool_manager=resource_pool_manager,
ray_worker_group_cls=ray_worker_group_cls,
reward_fn=reward_fn,
val_reward_fn=val_reward_fn,
train_dataset=train_dataset,
val_dataset=val_dataset,
collate_fn=collate_fn,
train_sampler=train_sampler,
)
trainer.init_workers()
trainer.fit()
if __name__ == "__main__":
main()
+93
View File
@@ -0,0 +1,93 @@
# Copyright (c) Microsoft. All rights reserved.
"""Rollout-level mean policy loss for VERL."""
from __future__ import annotations
from typing import Any
import torch
import verl.utils.torch_functional as verl_F
from verl.trainer.ppo.core_algos import register_policy_loss
PER_ROLLOUT_MEAN_LOSS_MODE = "per_rollout_mean"
def normalize_advantages_by_rollout(
advantages: torch.Tensor,
response_mask: torch.Tensor,
rollout_ids: Any,
*,
num_trained_rows: int,
) -> torch.Tensor:
"""Normalize each row by its rollout's token count and batch size."""
if len(rollout_ids) != advantages.shape[0]:
raise ValueError(f"rollout_ids length ({len(rollout_ids)}) must match advantages rows ({advantages.shape[0]})")
if num_trained_rows <= 0:
raise ValueError("num_trained_rows must be positive")
row_token_counts = response_mask.sum(dim=-1).to(dtype=advantages.dtype)
rollout_token_counts: dict[Any, float] = {}
for row_index, rollout_id in enumerate(rollout_ids):
rollout_token_counts[rollout_id] = rollout_token_counts.get(rollout_id, 0.0) + float(
row_token_counts[row_index].item()
)
row_divisors = torch.tensor(
[rollout_token_counts[rollout_id] * num_trained_rows for rollout_id in rollout_ids],
dtype=advantages.dtype,
device=advantages.device,
).clamp_min(1.0)
return advantages / row_divisors.unsqueeze(-1)
@register_policy_loss(PER_ROLLOUT_MEAN_LOSS_MODE)
def compute_policy_loss_per_rollout_mean(
old_log_prob: torch.Tensor,
log_prob: torch.Tensor,
advantages: torch.Tensor,
response_mask: torch.Tensor,
loss_agg_mode: str = "token-mean",
config: Any | None = None,
rollout_is_weights: torch.Tensor | None = None,
) -> tuple[torch.Tensor, dict[str, Any]]:
"""Compute clipped PPO loss from rollout-normalized advantages."""
assert config is not None, "per_rollout_mean loss requires the actor config"
clip_ratio = config.clip_ratio
clip_ratio_low = config.clip_ratio_low if config.clip_ratio_low is not None else clip_ratio
clip_ratio_high = config.clip_ratio_high if config.clip_ratio_high is not None else clip_ratio
clip_ratio_c = config.get("clip_ratio_c", 3.0)
assert clip_ratio_c > 1.0, f"clip_ratio_c must be greater than 1.0, got {clip_ratio_c}"
negative_approx_kl = torch.clamp(log_prob - old_log_prob, min=-20.0, max=20.0)
ratio = torch.exp(negative_approx_kl)
ppo_kl = verl_F.masked_mean(-negative_approx_kl, response_mask)
pg_losses1 = -advantages * ratio
pg_losses2 = -advantages * torch.clamp(ratio, 1 - clip_ratio_low, 1 + clip_ratio_high)
clip_pg_losses1 = torch.maximum(pg_losses1, pg_losses2)
pg_clipfrac = verl_F.masked_mean(torch.gt(pg_losses2, pg_losses1).float(), response_mask)
pg_losses3 = -advantages * clip_ratio_c
clip_pg_losses2 = torch.min(pg_losses3, clip_pg_losses1)
pg_clipfrac_lower = verl_F.masked_mean(
torch.gt(clip_pg_losses1, pg_losses3) * (advantages < 0).float(), response_mask
)
pg_losses = torch.where(advantages < 0, clip_pg_losses2, clip_pg_losses1)
if rollout_is_weights is not None:
pg_losses = pg_losses * rollout_is_weights
dp_size = config.global_batch_info.get("dp_size", 1) if config.global_batch_info else 1
pg_loss = verl_F.masked_sum(pg_losses, response_mask) * (dp_size or 1)
metrics = {
"actor/pg_clipfrac": pg_clipfrac.detach().item(),
"actor/ppo_kl": ppo_kl.detach().item(),
"actor/pg_clipfrac_lower": pg_clipfrac_lower.detach().item(),
}
return pg_loss, metrics
def register_in_worker() -> None:
"""Import hook used by Ray actor processes."""
+558
View File
@@ -0,0 +1,558 @@
# Copyright (c) Microsoft. All rights reserved.
"""Adapters from completed Agent Lightning rollouts to VERL training data."""
from __future__ import annotations
import io
import json
import zipfile
from typing import Any, cast
import numpy as np
import torch
from tensordict import TensorDict
from verl import DataProto
from agentlightning.verl.agl_rollout_manager import CompletedRollout
_TRACE_MERGE_MISMATCH_WANDB_LIMIT = 100
_TRACE_MERGE_MISMATCH_TEXT_LIMIT = 4000
_ROLLOUT_TRAJECTORY_WANDB_LIMIT = 24
_TRACE_MERGE_MISMATCH_COLUMNS = [
"global_steps",
"rollout_id",
"data_id",
"turn_index",
"template_mismatch",
"retoken_mismatch",
"others_mismatch",
"prompt_length",
"response_length",
"previous_trace_length",
"current_trace_length",
"previous_trace",
"current_trace",
]
_ROLLOUT_TRAJECTORY_COLUMNS = [
"global_steps",
"trajectory_artifact",
"trajectory_artifact_path",
"row_count",
]
def ids_startswith(full_ids: list[int], prefix_ids: list[int]) -> bool:
return full_ids[: len(prefix_ids)] == prefix_ids
def _decode_token_ids(tokenizer: Any | None, ids: list[int]) -> str:
if tokenizer is not None:
try:
text = tokenizer.decode(ids, skip_special_tokens=False)
except TypeError:
text = tokenizer.decode(ids)
except Exception:
text = " ".join(str(i) for i in ids)
else:
text = " ".join(str(i) for i in ids)
return text
def _decode_trace_text(tokenizer: Any | None, ids: list[int]) -> str:
text = _decode_token_ids(tokenizer, ids)
if len(text) > _TRACE_MERGE_MISMATCH_TEXT_LIMIT:
truncated = len(text) - _TRACE_MERGE_MISMATCH_TEXT_LIMIT
return text[:_TRACE_MERGE_MISMATCH_TEXT_LIMIT] + f"\n...[truncated {truncated} chars]"
return text
def _token_ids(value: Any) -> list[int]:
if isinstance(value, dict) and isinstance(value.get("token_ids"), list):
return value["token_ids"]
return []
def _artifact_safe_name(value: Any) -> str:
text = str(value)
safe = "".join(char if char.isascii() and (char.isalnum() or char in {"-", "_", "."}) else "_" for char in text)
return safe or "unknown"
def _build_compact_rollout_trajectory_records(
rollouts: list[CompletedRollout],
*,
tokenizer: Any | None,
reward_fillna_value: float,
limit: int | None = None,
) -> list[dict[str, Any]]:
records: list[dict[str, Any]] = []
sorted_rollouts = sorted(rollouts, key=lambda rollout: (rollout.step, rollout.sample_idx_in_step))
for rollout in sorted_rollouts:
if limit is not None and len(records) >= limit:
break
if not rollout.triplets:
continue
last_triplet = rollout.triplets[-1]
records.append(
{
"rollout_id": rollout.rollout_id,
"reward": rollout.final_reward if rollout.final_reward is not None else reward_fillna_value,
"prompt": _decode_token_ids(tokenizer, _token_ids(last_triplet.prompt)),
"response": _decode_token_ids(tokenizer, _token_ids(last_triplet.response)),
}
)
return records
def _build_zipped_jsonl(records: list[dict[str, Any]], jsonl_name: str) -> bytes:
jsonl_text = "".join(json.dumps(record, ensure_ascii=False, separators=(",", ":")) + "\n" for record in records)
buffer = io.BytesIO()
with zipfile.ZipFile(buffer, mode="w", compression=zipfile.ZIP_DEFLATED) as zip_file:
zip_file.writestr(jsonl_name, jsonl_text.encode("utf-8"))
return buffer.getvalue()
def _upload_trace_merge_mismatches_to_wandb(rows: list[dict[str, Any]], global_steps: int) -> None:
try:
import wandb
if wandb.run is None:
return
table = wandb.Table(columns=cast(list[str | int], _TRACE_MERGE_MISMATCH_COLUMNS))
for row in rows:
table.add_data(*(row.get(column) for column in _TRACE_MERGE_MISMATCH_COLUMNS))
wandb.log({"training/trace_merge_mismatches": table}, step=global_steps)
except Exception as exc:
print(f"Warning: failed to upload trace merge mismatches to wandb: {exc}")
def _upload_compact_rollout_trajectories_to_wandb(
records: list[dict[str, Any]],
global_steps: int,
*,
is_validation: bool = False,
) -> None:
split = "validation" if is_validation else "train"
try:
import wandb
if wandb.run is None:
return
run = wandb.run
artifact_type = f"{split}_trajectories"
artifact_path = f"step_{global_steps}/{artifact_type}.jsonl.zip"
artifact_name = (
f"{split}-trajectories-{_artifact_safe_name(getattr(run, 'id', None) or 'run')}-step-{global_steps}"
)
artifact = wandb.Artifact(
name=artifact_name,
type=artifact_type,
metadata={"global_steps": global_steps, "row_count": len(records), "format": "jsonl.zip"},
)
with artifact.new_file(artifact_path, mode="wb") as trajectory_file:
trajectory_file.write(_build_zipped_jsonl(records, f"{artifact_type}.jsonl"))
run.log_artifact(artifact)
table = wandb.Table(columns=cast(list[str | int], _ROLLOUT_TRAJECTORY_COLUMNS))
table.add_data(global_steps, artifact_name, artifact_path, len(records))
table_key = "val/rollout_trajectories" if is_validation else "training/rollout_trajectories"
wandb.log({table_key: table}, step=global_steps)
except Exception as exc:
print(f"Warning: failed to upload {split} trajectories to wandb: {exc}")
def get_left_padded_ids_and_attention_mask(
ids: list[int], max_length: int, pad_token_id: int
) -> tuple[list[int], list[int]]:
seq_len = len(ids)
if seq_len >= max_length:
return ids[-max_length:], [1] * max_length
pad_len = max_length - seq_len
return [pad_token_id] * pad_len + ids, [0] * pad_len + [1] * seq_len
def get_right_padded_ids_and_attention_mask(
ids: list[int], max_length: int, pad_token_id: int
) -> tuple[list[int], list[int]]:
seq_len = len(ids)
if seq_len >= max_length:
return ids[:max_length], [1] * max_length
pad_len = max_length - seq_len
return ids + [pad_token_id] * pad_len, [1] * seq_len + [0] * pad_len
class RolloutAdapter:
"""Convert completed rollout results into VERL data structures."""
def __init__(
self,
*,
max_prompt_length: int,
max_response_length: int,
device: torch.device,
pad_token_id: int,
reward_fillna_value: float = 0.0,
trace_aggregator_level: str = "transition",
tokenizer: Any | None = None,
) -> None:
self.max_prompt_length = max_prompt_length
self.max_response_length = max_response_length
self.device = device
self.pad_token_id = pad_token_id
self.reward_fillna_value = reward_fillna_value
self.trace_aggregator_level = trace_aggregator_level
self.tokenizer = tokenizer
def get_train_data_batch(
self,
completed_rollouts: list[CompletedRollout],
*,
global_steps: int = 0,
) -> tuple[DataProto, dict[str, Any]]:
"""Build a VERL training batch from completed rollouts."""
level = self.trace_aggregator_level
if level not in {"transition", "trajectory"}:
raise ValueError(f"Unknown trace_aggregator_level: {level}")
# Keep rollout randomness within each sample instead of ordering samples by completion time.
sorted_rollouts = sorted(completed_rollouts, key=lambda rollout: (rollout.step, rollout.sample_idx_in_step))
final_rewards: list[float] = []
sample_with_reward_count = 0
sample_with_trace_count = 0
input_ids_list: list[list[int]] = []
input_attention_mask_list: list[list[int]] = []
response_ids_list: list[list[int]] = []
response_attention_mask_list: list[list[int]] = []
response_mask_list: list[list[int]] = []
reward_list: list[float] = []
data_id_list: list[str] = []
rollout_id_list: list[str] = []
turn_index_list: list[int] = []
is_drop_list: list[bool] = []
response_log_probs_list: list[list[float] | None] = []
n_trunc_sample_because_of_response = 0
n_skipped_empty_training_rows = 0
unmerged_count = 0
response_len_per_turn_list: list[int] = []
merge_mismatch_rows: list[dict[str, Any]] = []
def append_training_row(
*,
rollout_id: str,
data_id: str,
turn_index: int,
prompt_ids: list[int],
response_ids: list[int],
reward: float,
response_mask: list[int] | None = None,
response_log_probs: list[float] | None = None,
) -> None:
nonlocal n_skipped_empty_training_rows, n_trunc_sample_because_of_response
if len(prompt_ids) > self.max_prompt_length:
prompt_ids = prompt_ids[: self.max_prompt_length]
is_drop = True
else:
is_drop = False
if len(response_ids) > self.max_response_length:
response_ids = response_ids[: self.max_response_length]
if response_mask is not None:
response_mask = response_mask[: self.max_response_length]
if response_log_probs is not None:
response_log_probs = response_log_probs[: self.max_response_length]
n_trunc_sample_because_of_response += 1
if response_log_probs is not None and len(response_log_probs) != len(response_ids):
response_log_probs = None
train_token_count = sum(response_mask) if response_mask is not None else len(response_ids)
if train_token_count == 0:
n_skipped_empty_training_rows += 1
return
one_input_ids, one_input_attention_mask = get_left_padded_ids_and_attention_mask(
prompt_ids, self.max_prompt_length, self.pad_token_id
)
one_response_ids, one_response_attention_mask = get_right_padded_ids_and_attention_mask(
response_ids, self.max_response_length, self.pad_token_id
)
input_ids_list.append(one_input_ids)
input_attention_mask_list.append(one_input_attention_mask)
response_ids_list.append(one_response_ids)
response_attention_mask_list.append(one_response_attention_mask)
is_drop_list.append(is_drop)
if response_mask is not None:
one_response_mask, _ = get_right_padded_ids_and_attention_mask(
response_mask, self.max_response_length, 0
)
response_mask_list.append(one_response_mask)
response_log_probs_list.append(response_log_probs)
reward_list.append(reward)
data_id_list.append(data_id)
rollout_id_list.append(rollout_id)
if level == "transition":
turn_index_list.append(turn_index)
for rollout in sorted_rollouts:
final_reward = self._fillna_reward(rollout)
final_rewards.append(final_reward)
if rollout.final_reward is not None:
sample_with_reward_count += 1
if not rollout.triplets:
print(f"Warning: No triplets found for training rollout {rollout.rollout_id}, skipping.")
continue
sample_with_trace_count += 1
if level == "transition":
for turn_index, triplet in enumerate(rollout.triplets):
response_ids = triplet.response["token_ids"]
log_probs = triplet.response["log_probs"]
response_len_per_turn_list.append(len(response_ids))
append_training_row(
rollout_id=rollout.rollout_id,
data_id=rollout.data_id,
turn_index=turn_index,
prompt_ids=triplet.prompt["token_ids"],
response_ids=response_ids,
reward=final_reward,
response_log_probs=log_probs,
)
continue
else:
first_triplet = rollout.triplets[0]
group_start_turn_index = 0
current_prompt_ids = list(first_triplet.prompt["token_ids"])
current_response_ids = list(first_triplet.response["token_ids"])
current_context = current_prompt_ids + current_response_ids
current_response_mask = [1] * len(current_response_ids)
current_response_log_probs: list[float] | None = first_triplet.response["log_probs"]
response_len_per_turn_list.append(len(current_response_ids))
merged_group_count = 0
for turn_index, triplet in enumerate(rollout.triplets[1:], start=1):
prompt_ids = triplet.prompt["token_ids"]
response_ids = triplet.response["token_ids"]
log_probs = triplet.response["log_probs"]
response_len_per_turn_list.append(len(response_ids))
next_context = prompt_ids + response_ids
if ids_startswith(prompt_ids, current_context):
if len(prompt_ids) > len(current_context):
observation_ids = prompt_ids[len(current_context) :]
current_response_ids += observation_ids
current_response_mask += [0] * len(observation_ids)
if current_response_log_probs is not None:
current_response_log_probs += [0.0] * len(observation_ids)
current_response_ids += response_ids
current_response_mask += [1] * len(response_ids)
if current_response_log_probs is not None:
if log_probs is None or len(log_probs) != len(response_ids):
current_response_log_probs = None
else:
current_response_log_probs += list(log_probs)
current_context = next_context
continue
if len(merge_mismatch_rows) < _TRACE_MERGE_MISMATCH_WANDB_LIMIT:
merge_mismatch_rows.append(
{
"global_steps": global_steps,
"rollout_id": rollout.rollout_id,
"data_id": rollout.data_id,
"turn_index": turn_index,
# Token-prefix failures are classified as other mismatches.
"template_mismatch": False,
"retoken_mismatch": False,
"others_mismatch": True,
"prompt_length": len(prompt_ids),
"response_length": len(response_ids),
"previous_trace_length": len(current_context),
"current_trace_length": len(next_context),
"previous_trace": _decode_trace_text(self.tokenizer, current_context),
"current_trace": _decode_trace_text(self.tokenizer, next_context),
}
)
append_training_row(
rollout_id=rollout.rollout_id,
data_id=rollout.data_id,
turn_index=group_start_turn_index,
prompt_ids=current_prompt_ids,
response_ids=current_response_ids,
reward=final_reward,
response_mask=current_response_mask,
response_log_probs=current_response_log_probs,
)
merged_group_count += 1
group_start_turn_index = turn_index
current_context = next_context
current_prompt_ids = list(prompt_ids)
current_response_ids = list(response_ids)
current_response_mask = [1] * len(response_ids)
current_response_log_probs = log_probs
append_training_row(
rollout_id=rollout.rollout_id,
data_id=rollout.data_id,
turn_index=group_start_turn_index,
prompt_ids=current_prompt_ids,
response_ids=current_response_ids,
reward=final_reward,
response_mask=current_response_mask,
response_log_probs=current_response_log_probs,
)
merged_group_count += 1
if merged_group_count > 1:
unmerged_count += 1
rollout_trajectory_records = _build_compact_rollout_trajectory_records(
sorted_rollouts,
tokenizer=self.tokenizer,
reward_fillna_value=self.reward_fillna_value,
limit=_ROLLOUT_TRAJECTORY_WANDB_LIMIT,
)
_upload_trace_merge_mismatches_to_wandb(merge_mismatch_rows, global_steps)
_upload_compact_rollout_trajectories_to_wandb(rollout_trajectory_records, global_steps)
n_sample = len(input_ids_list)
if n_sample == 0:
raise RuntimeError("get_train_data_batch emitted zero training rows.")
batch_input_ids = torch.LongTensor(input_ids_list).to(self.device)
input_attention_mask = torch.LongTensor(input_attention_mask_list).to(self.device)
batch_response_ids = torch.LongTensor(response_ids_list).to(self.device)
response_attention_mask = torch.LongTensor(response_attention_mask_list).to(self.device)
batch_response_mask = torch.LongTensor(response_mask_list).to(self.device) if level == "trajectory" else None
batch_seq = torch.cat([batch_input_ids, batch_response_ids], dim=-1)
attention_mask = torch.cat([input_attention_mask, response_attention_mask], dim=-1)
position_ids = torch.clamp(torch.cumsum(attention_mask, dim=-1) - 1, min=0)
row_has_log_probs_list = [log_probs is not None for log_probs in response_log_probs_list]
emit_rollout_log_probs = all(row_has_log_probs_list)
if not emit_rollout_log_probs and any(row_has_log_probs_list):
print("Warning: Mixed rollout log_probs availability, omitting rollout_log_probs from batch.")
is_drop_mask = torch.BoolTensor(is_drop_list).to(self.device)
scores = torch.tensor(reward_list, dtype=torch.bfloat16).to(self.device)
token_level_scores = torch.zeros_like(attention_mask, dtype=scores.dtype)
token_positions = torch.arange(attention_mask.shape[-1], device=attention_mask.device).unsqueeze(0)
eos_mask_idx = torch.argmax(token_positions * attention_mask, dim=-1)
token_level_scores[torch.arange(n_sample), eos_mask_idx] = scores
token_level_scores = token_level_scores[:, -self.max_response_length :]
batch_dict = {
"prompts": batch_input_ids,
"responses": batch_response_ids,
"input_ids": batch_seq,
"attention_mask": attention_mask,
"position_ids": position_ids,
"is_drop_mask": is_drop_mask,
"token_level_scores": token_level_scores.contiguous(),
}
if level == "trajectory":
assert batch_response_mask is not None
batch_dict["response_mask"] = batch_response_mask
if emit_rollout_log_probs:
padded_log_probs_list = [
log_probs + [0.0] * (self.max_response_length - len(log_probs))
for log_probs in response_log_probs_list
if log_probs is not None
]
batch_dict["rollout_log_probs"] = torch.tensor(padded_log_probs_list, dtype=torch.float32).to(self.device)
batch = TensorDict(batch_dict, batch_size=n_sample) # type: ignore[arg-type]
data_proto = DataProto(batch=batch)
data_proto.non_tensor_batch["data_id_list"] = np.array(data_id_list)
data_proto.non_tensor_batch["rollout_id_list"] = np.array(rollout_id_list)
if level == "transition":
data_proto.non_tensor_batch["turn_index_list"] = np.array(turn_index_list)
n_response_turns = len(response_len_per_turn_list)
data_metrics = {
"training/reward": float(np.mean(final_rewards)) if final_rewards else 0.0,
"training/n_sample": n_sample,
"training/n_rollouts": len(sorted_rollouts),
"training/n_rollouts_w_trace": sample_with_trace_count,
"training/n_rollouts_w_reward": sample_with_reward_count,
"training/n_truncated_sample": n_trunc_sample_because_of_response,
"training/n_skipped_empty_rows": n_skipped_empty_training_rows,
"training/n_turns": n_response_turns,
"response_length/training/avg_by_turn": float(np.mean(response_len_per_turn_list)),
"response_length/training/max_by_turn": int(np.max(response_len_per_turn_list)),
"response_length/training/min_by_turn": int(np.min(response_len_per_turn_list)),
}
if level == "trajectory":
data_metrics["training/n_unmerged_rollouts"] = unmerged_count
data_metrics["training/n_trace_merge_mismatch_rows"] = len(merge_mismatch_rows)
return data_proto, data_metrics
def get_test_metrics(self, completed_rollouts: list[CompletedRollout], *, global_steps: int = 0) -> dict[str, Any]:
"""Build validation metrics from completed rollouts."""
sample_stat_list: list[dict[str, Any]] = []
for rollout in completed_rollouts:
final_reward = self._fillna_reward(rollout)
sample_stat: dict[str, Any] = {
"reward": final_reward,
"has_reward": rollout.final_reward is not None,
}
if rollout.triplets:
response_length_list = [len(triplet.response.get("token_ids") or []) for triplet in rollout.triplets]
sample_stat.update(
{
"total_response_length": np.sum(response_length_list),
"mean_response_length": np.mean(response_length_list) if response_length_list else 0,
"turn_count": len(rollout.triplets),
}
)
sample_stat_list.append(sample_stat)
stats_w_trace = [stat for stat in sample_stat_list if "total_response_length" in stat]
if not stats_w_trace:
raise RuntimeError("get_test_metrics received zero completed rollouts with trace.")
validation_trajectory_records = _build_compact_rollout_trajectory_records(
completed_rollouts,
tokenizer=self.tokenizer,
reward_fillna_value=self.reward_fillna_value,
)
_upload_compact_rollout_trajectories_to_wandb(
validation_trajectory_records,
global_steps,
is_validation=True,
)
return {
"val/reward": float(np.mean([stat["reward"] for stat in sample_stat_list])),
"val/n_rollouts": len(sample_stat_list),
"val/n_rollouts_w_trace": len(stats_w_trace),
"val/n_rollouts_w_reward": len([stat for stat in sample_stat_list if stat["has_reward"]]),
"val/mean_response_length_per_turn": float(
np.mean([stat["mean_response_length"] for stat in stats_w_trace])
),
"val/mean_total_response_length_per_rollout": float(
np.mean([stat["total_response_length"] for stat in stats_w_trace])
),
"val/turn_count": float(np.mean([stat["turn_count"] for stat in stats_w_trace])),
}
def _fillna_reward(self, rollout: CompletedRollout) -> float:
if rollout.final_reward is not None:
return rollout.final_reward
return self.reward_fillna_value
__all__ = ["RolloutAdapter"]
@@ -0,0 +1,160 @@
# Copyright (c) Microsoft. All rights reserved.
"""Rollout-level advantage computation for Agent Lightning training batches."""
from __future__ import annotations
from collections.abc import Callable
from typing import Any
import torch
from verl import DataProto
from verl.trainer.ppo.ray_trainer import compute_advantage
def compute_rollout_level_advantage(
batch: DataProto,
*,
adv_estimator: Any,
gamma: float,
lam: float,
num_repeat: int,
norm_adv_by_std_in_grpo: bool = True,
config: Any | None = None,
compute_advantage_fn: Callable[..., DataProto] = compute_advantage,
) -> tuple[DataProto, dict[str, int]]:
"""Compute advantages once per rollout, then broadcast to rollout triplets."""
rollout_ids = _required_non_tensor(batch, "rollout_id_list")
if len(rollout_ids) != len(batch):
raise RuntimeError(f"rollout_id_list length ({len(rollout_ids)}) must match batch length ({len(batch)})")
uid_values = batch.non_tensor_batch.get("uid")
if uid_values is None:
uid_values = batch.non_tensor_batch.get("data_id_list")
if uid_values is None:
raise RuntimeError("rollout-level advantage requires uid or data_id_list in non_tensor_batch")
batch.non_tensor_batch["uid"] = uid_values
response_mask = _required_tensor(batch, "response_mask")
token_level_rewards = _required_tensor(batch, "token_level_rewards")
rollout_to_indices: dict[Any, list[int]] = {}
for row_index, rollout_id in enumerate(rollout_ids):
rollout_to_indices.setdefault(rollout_id, []).append(row_index)
reward_sums = token_level_rewards.sum(dim=-1).detach().float()
representative_indices: list[int] = []
for rollout_id, row_indices in rollout_to_indices.items():
representative_indices.append(row_indices[0])
_validate_same_uid(rollout_id, row_indices, uid_values)
_validate_same_reward(rollout_id, row_indices, reward_sums)
rollout_batch = batch[representative_indices]
rollout_batch = compute_advantage_fn(
rollout_batch,
adv_estimator=adv_estimator,
gamma=gamma,
lam=lam,
num_repeat=num_repeat,
norm_adv_by_std_in_grpo=norm_adv_by_std_in_grpo,
config=config,
)
rollout_scalars = _extract_rollout_scalars(
rollout_batch,
key="advantages",
response_mask=rollout_batch.batch["response_mask"],
)
batch.batch["advantages"] = _broadcast_rollout_scalars(
rollout_ids=rollout_ids,
rollout_to_scalar=rollout_scalars,
response_mask=response_mask,
)
if "returns" in rollout_batch.batch:
return_scalars = _extract_rollout_scalars(
rollout_batch,
key="returns",
response_mask=rollout_batch.batch["response_mask"],
)
batch.batch["returns"] = _broadcast_rollout_scalars(
rollout_ids=rollout_ids,
rollout_to_scalar=return_scalars,
response_mask=response_mask,
)
metrics = {
"training/rollout_level_advantage/n_rows": len(batch),
"training/rollout_level_advantage/n_rollouts": len(rollout_to_indices),
"training/rollout_level_advantage/n_multi_row_rollouts": sum(
1 for row_indices in rollout_to_indices.values() if len(row_indices) > 1
),
"training/rollout_level_advantage/max_rows_per_rollout": max(
(len(row_indices) for row_indices in rollout_to_indices.values()),
default=0,
),
}
return batch, metrics
def _required_non_tensor(batch: DataProto, key: str) -> Any:
values = batch.non_tensor_batch.get(key)
if values is None:
raise RuntimeError(f"rollout-level advantage requires {key} in non_tensor_batch")
return values
def _required_tensor(batch: DataProto, key: str) -> torch.Tensor:
value = batch.batch.get(key)
if value is None:
raise RuntimeError(f"rollout-level advantage requires {key} in batch")
return value
def _validate_same_uid(rollout_id: Any, row_indices: list[int], uid_values: Any) -> None:
first_uid = uid_values[row_indices[0]]
if any(uid_values[row_index] != first_uid for row_index in row_indices[1:]):
raise RuntimeError(f"rollout-level advantage found multiple uid values for rollout_id={rollout_id!r}")
def _validate_same_reward(rollout_id: Any, row_indices: list[int], reward_sums: torch.Tensor) -> None:
rollout_rewards = reward_sums[row_indices]
if not torch.allclose(rollout_rewards, rollout_rewards[0].expand_as(rollout_rewards)):
raise RuntimeError(
"rollout-level advantage requires all triplets for the same rollout_id "
f"to share the same scalar token_level_rewards sum; got rollout_id={rollout_id!r}"
)
def _extract_rollout_scalars(
batch: DataProto,
*,
key: str,
response_mask: torch.Tensor,
) -> dict[Any, torch.Tensor]:
values = _required_tensor(batch, key)
rollout_ids = _required_non_tensor(batch, "rollout_id_list")
scalars: dict[Any, torch.Tensor] = {}
for row_index, rollout_id in enumerate(rollout_ids):
masked_values = values[row_index][response_mask[row_index].bool()]
if masked_values.numel() == 0:
raise RuntimeError(f"rollout-level advantage cannot extract {key} for empty rollout_id={rollout_id!r}")
first_value = masked_values[0]
if not torch.allclose(masked_values, first_value.expand_as(masked_values)):
raise RuntimeError(
f"rollout-level advantage requires scalar outcome-style {key}; "
f"got non-constant token values for rollout_id={rollout_id!r}"
)
scalars[rollout_id] = first_value.detach()
return scalars
def _broadcast_rollout_scalars(
*,
rollout_ids: Any,
rollout_to_scalar: dict[Any, torch.Tensor],
response_mask: torch.Tensor,
) -> torch.Tensor:
row_scalars = torch.stack([rollout_to_scalar[rollout_id] for rollout_id in rollout_ids])
row_scalars = row_scalars.to(device=response_mask.device)
return row_scalars.unsqueeze(-1) * response_mask.to(dtype=row_scalars.dtype)
File diff suppressed because it is too large Load Diff
+41
View File
@@ -0,0 +1,41 @@
# Installation
This guide sets up a single-node environment for Agent Lightning v1.0. After completing it, you can run single-machine training jobs.
Before getting started, install `uv` and NVIDIA CUDA. We support CUDA `12.9` or `13.0`.
#### Step 1: UV Sync
From the project root, run:
```bash
cd <this-repo>
uv sync
```
This installs the base Python environment into `.venv` under the project root.
#### Step 2: Install `verl` and FlashAttention
Agent Lightning uses `verl` as its training backend. The compatible versions of `verl`, `vllm`, and `torch` are tightly coupled, and installing `flash-attn` can also be error-prone. We recommend using `scripts/setup_verl.sh` to install the tested, pinned GPU stack and build `flash-attn` from source.
Pass the `verl` version and CUDA wheel variant explicitly. The script supports `verl==0.7.1` or `verl==0.8.0`, and CUDA wheel variant `cu129` or `cu130`. We recommend CUDA `13.0` with `verl==0.8.0`:
```bash
source .venv/bin/activate
bash scripts/setup_verl.sh 0.8.0 cu130
# or
bash scripts/setup_verl.sh 0.7.1 cu129
```
For `verl==0.7.1`, the script installs `vllm==0.12.0`. For `verl==0.8.0`, it installs `vllm==0.20.2` first, then installs `verl==0.8.0`. Both paths build `flash-attn==2.8.3` locally against the selected environment. Depending on the number of CPU cores available, the script can take 10-30 minutes to complete.
#### Step 3: W&B Login
By default, all tasks upload logs and trajectories to Weights & Biases. Log in to W&B before running a task:
```bash
uv run wandb login
```
+55
View File
@@ -0,0 +1,55 @@
# Quick Start
This quick start requires only one machine with one A100 GPU. It runs Agent Lightning v1.0 with the **local controller** and provides the shortest path from an installed repository to a real rollout-driven training job.
## Before you start
Complete [Installation](00-installation.md), including the `verl` GPU stack.
> AGL v1.0 itself is lightweight, but policy inference and GRPO updates still require the GPU stack used by `verl` and vLLM.
## 1. Prepare the example
Download the Calc-X dataset from [Google Drive](https://drive.google.com/file/d/1FQMyKLLd6hP9dw9rfZn1EZOWNvKaDsqw/view?usp=sharing), then extract it and place these files under `examples/calc_x/data/`:
```text
train.parquet
test.parquet
test_mini.parquet
sample.jsonl
```
Activate the project environment and install the dependencies:
```bash
source .venv/bin/activate
uv pip install openai httpx sympy \
"autogen-agentchat" "autogen-ext[openai]" \
"mcp>=1.11.0,<2" mcp-server-calculator
```
## 2. Start one local run
From the repository root:
```bash
examples/calc_x/run_local.sh
```
The launcher performs four operations:
1. starts Ray and the `verl`/vLLM model backend;
2. starts `agl-server` on port `8181`;
3. starts `agl-controller runner_type=local`;
4. runs the Calc-X training entrypoint.
Service logs are written under `/tmp/`.
Once the task is running, you can view the training results in W&B.
When you want to stop the run, press `Ctrl+C` once and wait for the script to exit. Do not press `Ctrl+C` repeatedly, as the cleanup process takes some time to stop all resources and processes safely.
## What's Next
1. Read [Basics](05-basics.md) to learn the core Agent Lightning >= v1.0 concepts.
2. Read the complete [Calc-X example](50-example-calc-x.md), which also covers the Kubernetes controller mode.
+96
View File
@@ -0,0 +1,96 @@
# Basics
Agent Lightning v1.0 consists of three main components: the **API Gateway**, the **Rollout Controller**, and the **Customized Trainer**. Together, they connect existing agents to reinforcement learning through an OpenAI-compatible endpoint, without requiring changes to the agent's interaction loop.
## Overview
<p align="center">
<img src="../images/architecture.jpg" alt="Agent Lightning v1.0 architecture" width="75%">
</p>
The API Gateway stores the core rollouts, model endpoints, and events and provides an OpenAI-compatible model proxy for agent requests. The Rollout Controller launches and manages agent executions as local processes or Kubernetes Jobs. Finally, the Customized Trainer runs model inference and optimization on the GPU side and turns the rollout data collected by the Gateway into policy updates.
This separation provides several practical advantages:
- **Zero-code-change agent integration:** an existing agent connects by redirecting its OpenAI-compatible model endpoint to the Gateway.
- **Independent resources:** model training and agent execution can run on separate machines or clusters and scale independently.
- **Open infrastructure:** agents can run on a self-hosted Kubernetes cluster instead of requiring a commercial sandbox service.
Below, we briefly introduce each component.
## API Gateway
The API Gateway is a lightweight service at the center of Agent Lightning. It stores rollouts, model endpoints, and events. It also provides an OpenAI-compatible proxy for agents to access model inference.
<p align="center">
<img src="../images/agentlightning-schema.jpg" alt="API Gateway objects and rollout state transitions" width="50%">
</p>
### Rollout API
A **rollout** is one execution of an agent on one input. It has a globally unique ID, an input, user-defined metadata, execution configuration, and a status:
- `QUEUING`: waiting for the Controller to start the agent;
- `RUNNING`: the agent is executing;
- `SUCCEEDED`: the execution completed successfully;
- `FAILED`: the execution ended with an error or timeout.
A rollout is not the same as a training example. Algorithms such as GRPO may create several independent rollouts from the same example so that the trainer can compare their rewards.
The trainer creates rollouts through the Rollout API. The Controller reads queued rollouts and updates their status as execution progresses. Each rollout can also contain append-only events, including:
- `model_request`, recorded automatically for each model call;
- `reward`, normally reported by the agent at the end of execution;
- custom events for diagnostics and monitoring.
Every event is associated with a specific rollout ID and is later exported as training data.
### OpenAI-compatible proxy
The Gateway also acts as a reverse proxy. The trainer registers one or more model inference endpoints, and the agent sends its model requests to a rollout-specific Gateway URL. The Gateway forwards each request to the registered model endpoint and records its prompt token IDs, response token IDs, and chosen-token log probabilities as a `model_request` event.
For example, an OpenAI Chat Completions request for a training rollout is sent to:
```text
POST /proxy/rollout/{rollout_id}/attempt/{attempt_id}/mode/train/openai/v1/chat/completions
```
The corresponding validation path uses `mode/val`. OpenAI-compatible clients can use the path through `/openai/v1` as their base URL and append `/chat/completions` normally.
Because the rollout ID is part of the proxy URL, every model call is automatically associated with the correct execution. An existing agent only needs to use the provided endpoint; it does not need to implement Agent Lightning's rollout or training logic.
## Rollout Controller
The Rollout Controller turns queued rollouts into real agent executions. It continuously reconciles rollout state in the API Gateway with the processes or Jobs it manages, and reports execution progress back to the Gateway.
<p align="center">
<img src="../images/controller-reconciliation.jpg" alt="Controller reconciliation" width="75%">
</p>
The Controller supports two modes:
- **Local mode:** starts each rollout as a short-lived local subprocess. This mode is convenient for development and debugging when the agent and trainer dependencies can share one machine.
- **Kubernetes mode:** creates one Kubernetes Job for each rollout from a user-provided template. This mode isolates agent dependencies and supports concurrent execution on a self-hosted or on-premises cluster.
The API Gateway remains the source of truth for rollout status. If a process, Kubernetes watch, or network update is interrupted, the Controller retries reconciliation until the execution state converges.
## Customized Trainer
The Customized Trainer sits on top of `verl` and connects the training backend to the API Gateway. During each training step, it:
1. registers the current model inference endpoints;
2. creates one or more rollouts for each training input;
3. waits for enough rollouts to finish;
4. retrieves model requests, rewards, and other events;
5. converts the captured calls into `verl` training samples;
6. computes advantages and updates the policy.
The trainer also handles Agent Lightning-specific data processing. It merges consecutive model calls only when their token histories are exactly continuous, computes advantages at the rollout level, and supports rollout-level loss normalization.
## Configure the components
The following chapters describe the settings for each component. Start with the trainer to define how rollouts are created and converted into training samples, then configure the server and the Controller that execute them:
1. [Trainer Configuration](20-trainer-configuration.md)
2. [API Gateway Configuration](25-api-gateway-configuration.md)
3. [Controller Configuration](30-controller-configuration.md)
+215
View File
@@ -0,0 +1,215 @@
# Trainer Configuration
Agent Lightning v1.0 adds its configuration on top of `verl`'s `ppo_trainer` Hydra configuration. The complete default configuration from `agentlightning/verl/config.yaml` is shown below. The following sections explain these settings in detail.
Complete default configuration added by Agent Lightning:
```yaml
algorithm:
enable_rollout_level_advantage: true
agentlightning:
agl_base_url: http://localhost:8080
agl_key: ""
hooks: null
rollout_timeout_seconds: 1800
local:
agent_class: null
env_map: {}
k8s:
job_template_path: null
reward_fillna_value: 0.0
max_ppo_update_times: null
trace_aggregator:
level: trajectory # transition | trajectory
trajectory_max_prompt_length: 2048
trajectory_max_response_length: 8192
async_rollout:
enabled: false
async_train_batch_size: null
actor_rollout_ref:
actor:
policy_loss:
loss_mode: per_rollout_mean
```
The configuration above shows the Agent Lightning settings. At runtime, these settings are merged with the original `verl` `ppo_trainer` configuration, whose existing options remain available and take effect as usual.
## Connect to the API Gateway
The first group of settings connects the trainer to the Agent Lightning API Gateway:
| Key | Default | Description |
|---|---:|---|
| `agentlightning.agl_base_url` | `http://localhost:8080` | Gateway URL used by the rollout manager. |
| `agentlightning.agl_key` | `""` | Bearer key; must match the API Gateway and Controller. |
Make sure the machine running the trainer can reach the Gateway at `agentlightning.agl_base_url`. The Hydra `agl_key` value must be identical in the trainer, API Gateway, and Controller configurations.
## Model and Data
Model configuration follows the standard `verl` `actor_rollout_ref.model` settings. Set `actor_rollout_ref.model.path` to a Hugging Face model name or local model path:
```yaml
actor_rollout_ref:
model:
path: Qwen/Qwen2.5-1.5B-Instruct
```
In upstream `verl`, dataset paths are normally configured with `data.train_files` and `data.val_files`. Agent Lightning instead loads the files first and passes the resulting datasets directly to `run_ppo`. This provides additional flexibility: users can pass any dataset as long as it can be represented as a list of JSON objects.
```python
from datasets import Dataset
from agentlightning.verl.entrypoint import run_ppo
train_dataset = Dataset.from_parquet("data/train.parquet").to_list()
val_dataset = Dataset.from_parquet("data/test.parquet").to_list()
run_ppo(config, train_dataset=train_dataset, val_dataset=val_dataset)
```
`run_ppo` accepts non-empty in-memory sequences as `train_dataset` and `val_dataset`. Each element is read as a JSON-like object. When the trainer creates a rollout, each element in the list becomes the rollout's `input` field. The Controller can then map fields from `input` into the agent's environment or Kubernetes Job template.
## Rollout execution
The Controller has two execution modes: `local` and `k8s`. Configure the matching section below, and the Controller reads that section according to its running mode.
| Key | Default | Description |
|---|---:|---|
| `agentlightning.local.agent_class` | `null` | Fully qualified Python class imported and started by the Controller in local mode. |
| `agentlightning.local.env_map` | `{}` | Maps environment variable names to fields in the rollout `input`. |
| `agentlightning.k8s.job_template_path` | `null` | Path to the Jinja Kubernetes Job template used by the Controller in K8s mode. |
For local execution, set the agent class and map fields from each dataset row into environment variables. For example:
```yaml
agentlightning:
local:
agent_class: examples.search_r1.agents.search_r1_agent.SearchR1Agent
env_map:
QUESTION: input.question
GOLDEN_ANSWERS: input.golden_answers
```
Here, the Controller imports `SearchR1Agent`, starts one local subprocess for each rollout, and sets `QUESTION` and `GOLDEN_ANSWERS` from that rollout's `input` object.
In K8s mode, provide a Jinja template that renders to a Kubernetes Job YAML manifest:
```yaml
agentlightning:
k8s:
job_template_path: examples/calc_x/job-template.yaml
```
The template can use values from the rollout `input`. For example, this fragment replaces the environment-variable values with fields from the current dataset row:
```yaml
env:
- name: QUESTION
value: {% raw %}{{ input.question | yaml_escape }}{% endraw %}
- name: RESULT
value: {% raw %}{{ input.result | yaml_escape }}{% endraw %}
```
The trainer reads the Jinja template and includes its text in each rollout. The Controller renders it with that rollout's `input`, then creates one Kubernetes Job per rollout.
Finally, `agentlightning.rollout_timeout_seconds` sets the maximum execution time for each rollout in both modes. The Controller uses this value and marks a rollout as failed if it does not finish within the configured number of seconds. The default is `1800`.
## Trace aggregator
<p align="center">
<img src="../images/trajectory-aggregation.jpg" alt="Trajectory aggregation" width="80%">
</p>
The left side of the diagram shows traditional agentic RL, where each rollout corresponds to one training sample. The right side shows Agent Lightning, where one rollout can correspond to multiple training samples. During a rollout, the Gateway collects all raw LLM calls as prompt-response pairs, and the trace aggregator assembles them into training samples using one of the following two modes.
### Trajectory mode
`trajectory` is the default and recommended mode:
```yaml
agentlightning:
trace_aggregator:
level: trajectory
trajectory_max_prompt_length: 2048
trajectory_max_response_length: 8192
```
The aggregator automatically merges consecutive calls when the next prompt starts with the exact token sequence of the previous prompt and response. Tokens added between calls, such as tool observations, are retained as context but masked from the policy loss. If exact token-prefix continuity is broken, the aggregator starts a new training row instead of merging incompatible calls.
In this mode:
- `trajectory_max_prompt_length` limits the initial prompt in each merged training row;
- `trajectory_max_response_length` limits all content after the initial prompt. This includes the prompts and responses from later turns, which are merged into the trajectory response sequence.
We recommend setting `trajectory_max_response_length` relatively high so it can hold multiple turns without truncation. Choose a value that covers the expected combined length of later-turn prompts and responses while fitting the model context window and available GPU memory.
Training rows whose initial prompt exceeds `trajectory_max_prompt_length` are marked and dropped from the policy-update batch. Content beyond `trajectory_max_response_length`, on the other hand, is truncated to the configured response length.
The number of dropped and truncated rows is reported to W&B with these metrics:
- `training/n_sample_dropped/marked` — rows dropped because their prompts exceeded the configured prompt limit;
- `training/n_truncated_sample` — rows whose responses were truncated to the configured response limit.
### Transition mode
In `transition` mode, every model call becomes an independent training row and no calls are merged:
```yaml
agentlightning:
trace_aggregator:
level: transition
data:
max_prompt_length: 4096
max_response_length: 2048
```
Transition mode does not use `trajectory_max_prompt_length` or `trajectory_max_response_length`. It uses the same standard `verl` data limits used for individual vLLM rollout calls:
- `data.max_prompt_length` limits each call's prompt;
- `data.max_response_length` limits each call's response.
Use transition mode when every request-response call should remain a separate training sample.
## Algorithm correctness
The following settings control how rollout data contributes to optimization:
```yaml
algorithm:
enable_rollout_level_advantage: true
actor_rollout_ref:
actor:
policy_loss:
loss_mode: per_rollout_mean
agentlightning:
max_ppo_update_times: 2
```
### Rollout-level advantage
`algorithm.enable_rollout_level_advantage: true` computes the advantage at the rollout level rather than independently at the training-sample level. This is important because one rollout can produce a variable number of training rows after trace aggregation.
### Per-rollout mean loss
`actor_rollout_ref.actor.policy_loss.loss_mode: per_rollout_mean` normalizes the policy loss at the rollout level. It prevents a rollout from receiving more optimization weight only because it produced more training rows.
For the motivation and detailed formulation of rollout-level advantage and loss normalization, see the [Agent Lightning v1.0 technical report](https://arxiv.org/pdf/2608.17528).
### Maximum PPO update times
In extreme cases, trace aggregation may produce too many training samples from one collected batch, which can increase the number of PPO updates and affect training stability. `agentlightning.max_ppo_update_times` limits the maximum number of PPO mini-batch updates performed for one batch.
The default value is `null`, which applies no explicit update cap. In this case, the trainer uses all complete PPO mini-batches collected for the step; only samples that do not fill a complete mini-batch are dropped for alignment.
For additional training stability, we recommend setting it to `2`. Samples beyond this limit are dropped before the policy update. The number of samples dropped for mini-batch alignment or this update cap is reported in W&B through `training/n_sample_dropped/same_reward` and `training/n_sample_dropped/random`.
## Asynchronous training
Agent Lightning supports collocated asynchronous rollout collection through `agentlightning.async_rollout`. For configuration, behavior, and constraints, see [Asynchronous Training](35-asynchronous-training.md).
+60
View File
@@ -0,0 +1,60 @@
# API Gateway Configuration
Start the API Gateway with `agl-server`. It uses Hydra configuration, and the complete default configuration is located at `agentlightning/config/server.yaml`:
```yaml
host: 0.0.0.0
port: 8080
key: ""
default_proxy:
model_name: "Qwen/Qwen2.5-7B-Instruct"
include_log_probs: true
train:
temperature: 1
val:
temperature: 0.7
```
## Override configuration
Override any setting with a Hydra command-line argument when starting the server. For example:
```bash
agl-server \
host=0.0.0.0 \
port=8080 \
key="$AGL_KEY" \
default_proxy.model_name=Qwen/Qwen3-8B
```
## Top-level settings
| Key | Default | Description |
|---|---:|---|
| `host` | `0.0.0.0` | Uvicorn bind address. |
| `port` | `8080` | Uvicorn listen port. |
| `key` | `""` | Bearer key for API and proxy routes. Empty disables authentication and logs a warning. |
Use the same non-empty key in the trainer and Controller.
## Proxy settings
| Key | Default | Description |
|---|---:|---|
| `default_proxy.model_name` | `Qwen/Qwen2.5-7B-Instruct` | Registered model name selected for forwarded requests. |
| `default_proxy.include_log_probs` | `true` | Ask the train backend for chosen-token log probabilities and token IDs. |
| `default_proxy.train.temperature` | `1` | Temperature forced for training rollouts. |
| `default_proxy.val.temperature` | `0.7` | Temperature forced for validation rollouts. |
`default_proxy.model_name` must match the model configured in `verl` at `actor_rollout_ref.model.path`:
```text
server default_proxy.model_name
= trainer actor_rollout_ref.model.path
```
A mismatch produces a “model not found” error even if the vLLM endpoint itself is healthy.
The train and validation temperatures configured here are the values actually used for model requests. Note that `verl` has similar temperature settings, but those values are not used for proxied requests because the proxy replaces them automatically.
We recommend keeping `default_proxy.include_log_probs: true`. This records rollout log probabilities and allows `verl` to report rollout-correction metrics. Some rollout-correction features also require these log probabilities.
+93
View File
@@ -0,0 +1,93 @@
# Controller Configuration
Start the Controller with `agl-controller`. It translates declarative rollouts into real agent executions, uses Hydra configuration, and loads its complete default configuration from `agentlightning/config/controller.yaml`:
<p align="center">
<img src="../images/controller-reconciliation.jpg" alt="Controller reconciliation" width="80%">
</p>
```yaml
runner_type: k8s
agl_server:
url: http://localhost:8080
agent_url: null
key: ""
k8s_runner:
namespace: default
ttl_after_finished: 1200
max_jobs_per_minute: 100
poll_interval: 5
local_runner:
maximum_size: 50
poll_interval: 10
```
## Override configuration
Override any setting with a Hydra command-line argument when starting the Controller. For example:
```bash
agl-controller \
runner_type=local \
agl_server.url=http://localhost:8080 \
agl_server.key="$AGL_KEY" \
local_runner.maximum_size=32
```
## Runner type
The Controller supports one runner type at a time. Set `runner_type` to either `k8s` or `local`:
| Key | Default | Description |
|---|---:|---|
| `runner_type` | `k8s` | The single execution backend used by this Controller: `k8s` or `local`. |
One Controller instance cannot run both modes simultaneously.
In `k8s` mode, every rollout runs as a Kubernetes Job. The Controller uses the default Kubernetes configuration at `~/.kube/config` on its machine to access the cluster. In `local` mode, every rollout runs as a local subprocess on the Controller machine, with multiple rollouts managed through a local process pool.
## Connect to the API Gateway
The Controller configuration contains two API Gateway URLs for two different network paths:
| Key | Default | Description |
|---|---:|---|
| `agl_server.url` | `http://localhost:8080` | API Gateway URL used by the Controller itself. |
| `agl_server.agent_url` | `null` | API Gateway URL used by the Agent. When `null`, it falls back to `agl_server.url`. |
| `agl_server.key` | `""` | Bearer key used by the Controller and agents. |
`agl_server.url` must be reachable from the Controller process. `agl_server.agent_url` must be reachable from the Agent process or pod because it is used to build the Gateway proxy and event URLs injected into that Agent.
In most cases, `agl_server.agent_url` does not need to be set separately. Leave it as `null`, and Agents automatically use `agl_server.url` to access the API Gateway.
Set `agl_server.agent_url` only when Agents cannot reach the API Gateway through `agl_server.url`, usually because the Controller and Agents are in different networks. For example, when using the Minikube Docker driver, the Controller runs locally while Agents run inside Minikube, so they do not share the same network. The Controller may use `http://localhost:8080`, while Agents inside Minikube need `http://host.minikube.internal:8080` to access the same API Gateway.
## K8s runner limits
The K8s runner provides settings that limit Job creation and clean up completed Jobs:
| Key | Default | Description |
|---|---:|---|
| `k8s_runner.max_jobs_per_minute` | `100` | Maximum number of Kubernetes Jobs the Controller can create per minute. |
| `k8s_runner.ttl_after_finished` | `1200` | Number of seconds a completed Job is retained before Kubernetes removes it automatically. |
`max_jobs_per_minute` prevents the Controller from creating too many Jobs in a short period. `ttl_after_finished` prevents completed Jobs from accumulating and overloading the Kubernetes API server.
## Local runner limits
The local runner limits concurrent processes and periodically synchronizes their state:
| Key | Default | Description |
|---|---:|---|
| `local_runner.maximum_size` | `50` | Maximum number of Agent subprocesses managed concurrently on the Controller machine. |
| `local_runner.poll_interval` | `10` | Number of seconds between automatic synchronization checks for local process and rollout state. |
When the process pool reaches `maximum_size`, queued rollouts wait until capacity becomes available.
## How agents are launched
In `k8s` mode, the Controller reads the Jinja Job template stored in each rollout. The template originates from `agentlightning.k8s.job_template_path` in the Trainer configuration. The Controller renders the template with the rollout's `input`, applies the Controller settings such as namespace, timeout, and cleanup TTL, and submits the resulting Kubernetes Job. It also injects rollout-specific `AGL_OPENAI_BASE_URL`, `AGL_EVENT_URL`, and `AGL_KEY` values into every container. See [Trainer Configuration](20-trainer-configuration.md#rollout-execution) for the template configuration and Jinja examples, and `agentlightning/controller/k8s_reconciler.py` for the implementation.
In `local` mode, the Controller reads `agent_class` and `env_map` from the rollout. It imports the Agent class, starts it in a local subprocess, and uses `env_map` to replace environment-variable values with fields from the rollout's `input`. The same rollout-specific Gateway URL, event URL, and key are injected automatically.
+73
View File
@@ -0,0 +1,73 @@
# Asynchronous Training
Long-running agents can have very different rollout durations. In synchronous training, one slow rollout can delay the whole update step. Agent Lightning v1.0 supports **collocated asynchronous training**, where rollout generation and model updates share the same GPU pool while unfinished rollout groups carry over to later steps.
![Collocated asynchronous training](images/collocated-async.jpg)
## Enable asynchronous training
Enable Agent Lightning asynchronous collection with `agentlightning.async_rollout.enabled`:
```yaml
agentlightning:
async_rollout:
enabled: true
async_train_batch_size: 64
```
You must also set `async_train_batch_size`. It is the number of prompt groups kept active for rollout collection and must be strictly greater than `data.train_batch_size`, which is the number of completed groups consumed by one update:
```yaml
data:
train_batch_size: 32
agentlightning:
async_rollout:
enabled: true
async_train_batch_size: 64
```
A useful starting point is:
$$B_{async} = 2 B_{train}.$$
Increase `async_train_batch_size` when rollout durations vary significantly and the resource for running agents has enough capacity. Reduce it when active processes or Kubernetes Jobs consume too many CPU or memory resources.
## How it works
The asynchronous collection process is:
1. The trainer keeps up to `async_train_batch_size` prompt groups active.
2. The Controller starts their Agent executions in local processes or Kubernetes Jobs.
3. When `data.train_batch_size` complete groups are available, the trainer selects them for the next update instead of waiting for every active group.
4. Unfinished groups remain active and carry over to the next collection step.
5. Before updating model weights, the Gateway pauses new model requests and waits for requests already in flight to finish.
6. The shared GPUs perform the model update, then inference resumes for the next rollout phase.
Each prompt group remains intact. For example, when `actor_rollout_ref.rollout.n` is `4`, all four sibling rollouts must finish before that group can be used by the optimizer. This preserves GRPO/RLOO group statistics.
Agents should use a retrying OpenAI or HTTP client. A request arriving while the Gateway is paused receives a retryable response and can continue after inference resumes.
## Monitoring
The trainer reports asynchronous collection metrics to W&B:
| Metric | Interpretation |
|---|---|
| `training/async/n_prev_carry_over_rollouts` | Rollouts inherited from the previous step. |
| `training/async/n_completed_rollouts` | Rollouts consumed by the current step. |
| `training/async/n_new_carry_over_rollouts` | Unfinished rollouts carried into the next step. |
| `training/async/new_carry_over_age_max_steps` | Oldest carry-over age in optimizer steps. |
| `training/async/proxy_inflight_at_pause` | Requests still running when the Gateway pause begins. |
| `training/async/proxy_drain_seconds` | Time spent waiting for in-flight requests to finish. |
## Handle staleness
Asynchronous rollouts may be generated by an older model version and become stale before they are used for training. To correct this policy mismatch, enable `verl`'s [rollout correction](https://verl.readthedocs.io/en/latest/algo/rollout_corr.html). We recommend token-level importance sampling (TIS) with a clipping threshold of `2`:
```yaml
algorithm:
rollout_correction:
rollout_is: token
rollout_is_threshold: 2
```
+73
View File
@@ -0,0 +1,73 @@
# Calc-X
| GPU | Model | Controller Mode | Trainer Mode | Code |
|---|---|---|---|---|
| 1× A100 80GB | `Qwen/Qwen2.5-1.5B-Instruct` | K8s or local | Sync and async | [Source](https://github.com/microsoft/agent-lightning/tree/main/examples/calc_x) |
Calc-X is a proof-of-concept (POC) example that trains a mathematical reasoning agent on the Calc-X dataset with `verl` and Agent Lightning >=v1.0. It is intentionally lightweight and requires only one GPU. The agent uses AutoGen + MCP calculator tools to solve math problems.
The example supports two controller modes:
- **K8s mode:** Minikube provides a minimal Kubernetes environment, and agent rollouts run as Kubernetes Jobs.
- **Local mode:** Agent rollouts run directly as local processes without Kubernetes.
Both synchronous and asynchronous trainer modes are supported.
## Data Preparation
Download the Calc-X dataset from [Google Drive](https://drive.google.com/file/d/1FQMyKLLd6hP9dw9rfZn1EZOWNvKaDsqw/view?usp=sharing), then extract it into `examples/calc_x/data/`:
```bash
cd examples/calc_x
unzip data/calc-x-data.zip -d data/
```
The expected dataset files are:
- `data/train.parquet`
- `data/test.parquet`
- `data/test_mini.parquet`
- `data/sample.jsonl`
## Local Mode
Make sure you have activated the project environment and installed the following package in Python:
```bash
source .venv/bin/activate
uv pip install \
openai \
httpx \
sympy \
"autogen-agentchat" \
"autogen-ext[openai]" \
"mcp>=1.11.0,<2" \
mcp-server-calculator
```
Then start training:
```bash
source .venv/bin/activate
cd examples/calc_x
bash run_local.sh
```
`run_local.sh` starts `agl-server` and `agl-controller`, and writes their logs under `/tmp/`. The script starts the agent in multi-process mode.
When `run_local.sh` exits, it automatically cleans up the server, controller, and agent it started.
## K8s Mode
This example uses Minikube to demonstrate the minimal Kubernetes workflow. For production deployments, replace Minikube with a production-grade Kubernetes cluster.
Make sure you have installed `docker` and `minikube`, then start training by:
```bash
source .venv/bin/activate
cd examples/calc_x
bash run_minikube.sh
```
`run_minikube.sh` starts `agl-server` and `agl-controller`, and writes their logs under `/tmp/`. The script also starts a new local Minikube single-node K8s cluster, and the agent runs in this cluster as Kubernetes Jobs.
When `run_minikube.sh` exits, it automatically cleans up the server, controller, and Minikube it started.
Minikube needs at least 64 GB of memory; otherwise, it may be killed due to insufficient memory.
+63
View File
@@ -0,0 +1,63 @@
# GSM8K
| GPU | Model | Controller Mode | Trainer Mode | Code |
|---|---|---|---|---|
| 1× A100 80GB | `Qwen/Qwen2.5-1.5B-Instruct` | Local | Sync only | [Source](https://github.com/microsoft/agent-lightning/tree/main/examples/gsm8k) |
GSM8K trains a grade-school math reasoning agent on the `openai/gsm8k` dataset with `verl` and Agent Lightning >=v1.0.
This example runs in local mode and demonstrates support for two API styles:
1. **Chat Completions API:** the commonly used text-in/text-out API, where the agent sends structured chat messages and receives generated text.
2. **Token-in/token-out Completions API:** the agent sends prompt token IDs directly and receives generated token IDs.
## Data Preparation
Download the dataset into `~/dataset/gsm8k`:
```bash
hf download openai/gsm8k --repo-type dataset --local-dir ~/dataset/gsm8k
```
The example reads these files by default:
- `~/dataset/gsm8k/main/train-00000-of-00001.parquet`
- `~/dataset/gsm8k/main/test-00000-of-00001.parquet`
Training uses all samples from `main/train`. Validation uses 100 random samples from `main/test` with seed `42` by default.
## Training
Make sure you have activated the project environment and installed the example dependencies:
```bash
source .venv/bin/activate
uv pip install \
datasets \
openai \
httpx
```
Then start training:
```bash
source .venv/bin/activate
cd examples/gsm8k
bash run_local.sh
```
You can change the validation sample count or seed with:
```bash
bash run_local.sh --val-size 100 --seed 42
```
The local example uses `ChatAgent` with the standard Chat Completions API by default. To demonstrate the token-in/token-out Completions API, use `CompletionAgent` instead:
```bash
bash run_local.sh --api completion
```
In token-in/token-out mode, the agent tokenizes the prompt with the configured model tokenizer, sends prompt token IDs to the OpenAI-compatible Completions endpoint, receives response token IDs, and decodes them locally for answer evaluation.
`run_local.sh` starts `agl-server`, `agl-controller`, and Ray locally, and writes server/controller logs under `/tmp/`.
When the script exits, it cleans up the local server, controller, and Ray process it started.
+49
View File
@@ -0,0 +1,49 @@
# ScienceWorld
| GPU | Model | Controller Mode | Trainer Mode | Code |
|---|---|---|---|---|
| 8× A100 40GB | `Qwen/Qwen2.5-7B-Instruct` | Local | Async only | [Source](https://github.com/microsoft/agent-lightning/tree/main/examples/science_world) |
ScienceWorld trains an agent with `verl` and Agent Lightning >=v1.0 to solve text-based science tasks from AllenAI's [ScienceWorld](https://github.com/allenai/ScienceWorld).
This example uses the local controller in asynchronous trainer mode. Each rollout runs as a local process that interacts with a ScienceWorld environment, calls the model through the AGL Gateway, and reports the final reward. It does not require K8s, Docker, or Minikube.
## Environment Preparation
Install Java and the example dependencies:
```bash
sudo apt-get install -y default-jre
uv pip install scienceworld openai
```
ScienceWorld starts a JVM for each rollout, so Java 1.8 or later is required.
## Training
Start local training from the repository root:
```bash
examples/science_world/run_local.sh
```
`run_local.sh` starts `agl-server`, the local `agl-controller`, and the `verl` trainer. The controller launches each rollout as a local process, and the script cleans up the server, controller, and Ray processes when it exits.
The training dataset is generated automatically from ScienceWorld task names and variation indices. To train on selected tasks or change the number of variations per task:
```bash
examples/science_world/run_local.sh \
--task-names find-non-living-thing,find-living-thing \
--variations-per-task 50
```
Available runtime settings include:
| Setting | Default | Description |
|---|---|---|
| `--task-names` | `all` | Comma-separated task names, or all ScienceWorld tasks |
| `--variations-per-task` | `50` | Maximum variations per task |
| `--simplification` | `easy` | ScienceWorld simplification preset |
| `SW_MAX_STEPS` | `30` | Maximum model turns per rollout |
| `SW_ENV_STEP_LIMIT` | `100` | ScienceWorld environment step limit |
| `AGL_MAX_TOKENS` | `256` | Maximum tokens per model completion |
+89
View File
@@ -0,0 +1,89 @@
# Search-R1
| GPU | Model | Controller Mode | Trainer Mode | Code |
|---|---|---|---|---|
| 8× A100 40GB | `meta-llama/Llama-3.2-3B-Instruct` | Local | Sync only | [Source](https://github.com/microsoft/agent-lightning/tree/main/examples/search_r1) |
Search-R1 trains a retrieval-augmented question-answering agent with `verl` and Agent Lightning >=v1.0. During each multi-turn rollout, the agent alternates between model responses and Wikipedia searches before producing a final answer.
This example is based on [*Search-R1: Training LLMs to Reason and Leverage Search Engines with Reinforcement Learning*](https://arxiv.org/abs/2503.09516) by Jin et al. (2025).
This example uses the local controller in synchronous trainer mode. Each rollout runs as a local process, calls the policy model through the AGL Gateway, and queries a separate FAISS retrieval service.
The example supports two API styles:
1. **Chat Completions API:** the standard text-in/text-out API used by default.
2. **Token-in/token-out Completions API:** the agent sends prompt token IDs and receives generated token IDs while preserving the multi-turn token sequence.
## Data Preparation
Prepare the Wikipedia corpus, E5 FAISS index, training data, and retriever environment from the repository root:
```bash
examples/search_r1/data_process.sh
```
The script creates a Conda environment named `retriever` and prepares these files:
- `examples/search_r1/data/wiki-18.jsonl`
- `examples/search_r1/data/e5_Flat.index`
- `examples/search_r1/data/train.parquet`
- `examples/search_r1/data/test.parquet`
Set `SEARCH_R1_DATA_DIR` before running the script to use a different data directory.
## Retrieval Service
Start the retrieval service in a separate terminal and keep it running during training:
```bash
examples/search_r1/retrieval_launch.sh
```
The service listens at `http://127.0.0.1:8000/retrieve` by default. Check that it is ready with:
```bash
curl http://127.0.0.1:8000/healthz
```
Common retrieval settings include:
| Setting | Default | Description |
|---|---|---|
| `SEARCH_R1_DATA_DIR` | `examples/search_r1/data` | Corpus and FAISS index directory |
| `SEARCH_R1_RETRIEVAL_PORT` | `8000` | Retrieval service port |
| `SEARCH_R1_TOPK` | `3` | Documents returned for each search |
| `SEARCH_R1_RETRIEVER_DEVICE` | `auto` | Retriever device: `auto`, `cuda`, `cuda:0`, or `cpu` |
## Training
With the retrieval service running, start local training from the repository root:
```bash
examples/search_r1/run.sh
```
`run.sh` starts `agl-server`, the local `agl-controller`, and the `verl` trainer. The script cleans up the server, controller, and Ray processes when it exits.
The default agent uses the Chat Completions API. To use the token-in/token-out Completions API instead:
```bash
examples/search_r1/run.sh --api-type completion
```
To use different dataset files:
```bash
examples/search_r1/run.sh \
--train-file /path/to/train.parquet \
--val-file /path/to/test.parquet
```
Agent runtime settings include:
| Setting | Default | Description |
|---|---|---|
| `SEARCH_R1_RETRIEVAL_URL` | `http://127.0.0.1:8000/retrieve` | Retrieval endpoint used by rollout agents |
| `SEARCH_R1_MAX_TURNS` | `4` | Maximum model/search turns per rollout |
| `SEARCH_R1_MAX_TOKENS` | `500` | Maximum generated tokens per model response |
| `SEARCH_R1_TEMPERATURE` | `1.0` | Sampling temperature |
+87
View File
@@ -0,0 +1,87 @@
# LLM-in-Sandbox
| GPU | Model | Controller Mode | Trainer Mode | Code |
|---|---|---|---|---|
| 4× A100 80GB | `Qwen/Qwen3-4B-Instruct-2507` | K8s | Sync only | [Source](https://github.com/microsoft/agent-lightning/tree/main/examples/llm-in-sandbox) |
LLM-in-Sandbox trains a general instruction-following agent with `verl` and Agent Lightning >=v1.0. The agent can manage files, execute code, and use external resources inside an isolated container sandbox.
This example is based on [*Computer Environments Elicit General Agentic Intelligence in LLMs*](https://arxiv.org/abs/2601.16206) by Cheng et al. (2026).
This example uses the K8s controller in synchronous trainer mode. Each rollout runs as a Kubernetes Job, while model calls pass through the AGL Gateway to the `verl`-managed vLLM server. The agent dependencies remain isolated from the trainer environment.
## Environment Preparation
Use Python 3.12 and install the project environment before running the example. You also need:
- Docker
- Minikube
- `kubectl`
- Image build support inside Minikube
The bundled Minikube setup is intended for testing only. For production deployments, replace it with a production-grade Kubernetes cluster.
## Data Preparation
The public training and validation data is hosted in the [`daixuancheng/llm-in-sandbox-rl`](https://huggingface.co/datasets/daixuancheng/llm-in-sandbox-rl) dataset on Hugging Face. The upstream [`llm-in-sandbox-rl`](https://github.com/llm-in-sandbox/llm-in-sandbox-rl) repository provides the conversion script used to generate the JSON files expected by this example.
From the repository root, clone the upstream repository and convert all dataset configurations:
```bash
git clone --depth 1 https://github.com/llm-in-sandbox/llm-in-sandbox-rl.git /tmp/llm-in-sandbox-rl
python /tmp/llm-in-sandbox-rl/examples/llm_in_sandbox/convert_llm_sandbox_dataset.py \
--all \
--output-dir examples/llm-in-sandbox/data
```
The converter downloads the following Hugging Face configurations:
- Training: `instruct_pretrain` (`train` split, 3,600 samples)
- Validation: `math_mini`, `biomed_mini`, and `long_context_mini` (`test` splits)
The default files used by this example are:
| Split | Path |
|---|---|
| Training | `examples/llm-in-sandbox/data/llm_sandbox_instruct_pretrain/train_verl.json` |
| Validation | `examples/llm-in-sandbox/data/llm_sandbox_math_mini/test_verl.json` |
| Validation | `examples/llm-in-sandbox/data/llm_sandbox_biomed_mini/test_verl.json` |
| Validation | `examples/llm-in-sandbox/data/llm_sandbox_long_context_mini/test_verl.json` |
The command above creates these directories directly; no manual file move is needed. If you generate or download the files separately, place `train_verl.json` and `test_verl.json` in their corresponding directories, or pass those directories to the launcher.
For validation, select any one or more of `math_mini`, `biomed_mini`, and `long_context_mini`. Separate multiple directories with commas:
```bash
examples/llm-in-sandbox/run.sh \
--train-data-dir /path/to/train-data \
--val-data-dir /path/to/math-data,/path/to/biomed-data,/path/to/long-context-data
```
## Training
Start training from the repository root:
```bash
examples/llm-in-sandbox/run.sh
```
The launcher:
1. creates a local Minikube cluster;
2. builds the `llm-in-sandbox-agent:dev` image;
3. starts `agl-server` and the K8s `agl-controller`;
4. starts the `verl` trainer;
5. cleans up the server, controller, and Ray processes when it exits.
The controller creates one Kubernetes Job for each rollout. Inside the Job, the adapter runs the sandbox agent, routes model calls through the AGL Gateway, evaluates the final answer, and reports the reward.
Additional `verl` settings can be passed as dotlist overrides:
```bash
examples/llm-in-sandbox/run.sh \
trainer.total_epochs=2 \
actor_rollout_ref.rollout.n=2
```
Use `Ctrl+C` to stop training and clean up the processes started by the launcher.
+118
View File
@@ -0,0 +1,118 @@
# Coding Agent
| GPU | Model | Controller Mode | Trainer Mode | Code |
|---|---|---|---|---|
| 4× B200 | `Qwen/Qwen3.5-9B` | K8s | Sync and async | [Source](https://github.com/microsoft/agent-lightning/tree/main/examples/swe_smith) |
The Coding Agent example trains a software-engineering agent on SWE-smith tasks with `verl` and Agent Lightning >=v1.0. Each rollout runs as a Kubernetes Job inside a repository-specific image, edits an isolated checkout, executes tests, and reports the resulting reward to the AGL Gateway.
This example uses two machines:
- **Machine A — Kubernetes Controller machine:** connects to the Kubernetes cluster, prepares repository images in the node-accessible Docker runtime, and runs `agl-controller` to create rollout Jobs.
- **Machine B — GPU training machine:** provides the GPUs and runs both `agl-server` (the AGL Gateway) and the `verl` trainer with its model backend.
Machine B's AGL Gateway address must be reachable from Machine A and from the rollout pods in the Kubernetes cluster.
## Environment Preparation
On **Machine A (Kubernetes Controller machine)**, activate the project environment and install the dependency used to prepare repository images:
```bash
source .venv/bin/activate
uv pip install -r examples/swe_smith/requirements.txt
```
Machine A also requires Docker, `kubectl`, and access to the Kubernetes cluster.
On **Machine B (GPU training machine)**, install the project and GPU training environment described in the project installation guide. The SWE-smith image-preparation requirements above are not needed on Machine B.
## Data Preparation
The provided splits are derived from the original SWE-smith dataset, which contains 59,136 executable software-engineering tasks from 128 Python repositories. We build the training data with the following filtering pipeline:
1. Remove tasks with an empty problem statement. The original release contains 18,033 such records.
2. Remove tasks whose corresponding problem branch is missing from the provided repository image. This affects 1,265 records.
3. Remove tasks requiring more than 200 tests, which avoids examples with prohibitively expensive test suites.
4. Run Qwen3.5-9B four times on every remaining candidate as a difficulty probe.
5. Remove tasks solved in all four probe rollouts because they provide little learning signal.
6. Retain tasks with a mixture of successful and failed probe rollouts, yielding approximately 5,000 examples.
7. Add a sample of 1,000 tasks that fail all four probes so the training set is not biased toward easier tasks.
The resulting data contains approximately 6,000 training examples and 400 validation examples. `train_dataset_mixed.jsonl` contains the mixed-difficulty training set, while `val_dataset_filtered.jsonl` contains the filtered validation set.
Download the pre-split dataset archive from [Google Drive](https://drive.google.com/file/d/1q19DP53l4rldvBR2dkUhbaPI_mHVBVL1/view?usp=drive_link) on **both machines**, then extract it into `examples/swe_smith/`:
- **Machine A** reads the datasets to determine which repository images must be prepared.
- **Machine B** reads the datasets to construct the training and validation inputs.
The example reads these files by default:
- `examples/swe_smith/train_dataset_mixed.jsonl`
- `examples/swe_smith/val_dataset_filtered.jsonl`
When using `run.sh`, custom paths can be selected with the `AGL_TRAIN_DATASET_PATH` and `AGL_VAL_DATASET_PATH` environment variables read by the launcher.
## Repository Image Preparation
On Machine A, prepare the repository images in the Docker daemon used by the Kubernetes nodes before starting the Controller:
```bash
python examples/swe_smith/pull_images.py \
--dataset examples/swe_smith/train_dataset_mixed.jsonl \
--dataset examples/swe_smith/val_dataset_filtered.jsonl
```
This command installs the OpenAI client into each required SWE-smith base image and creates the `:openai` tags expected by `job-template-openai.yaml`. Run it again if the datasets introduce new repository images.
## Training
The distributed launcher has three roles and must be started in this order:
```text
server → controller → trainer
```
On **Machine B (GPU training machine)**, start the Gateway:
```bash
export AGL_SERVER_PUBLIC_HOST=<address-reachable-from-controller-and-pods>
export AGL_KEY=<shared-secret>
export AGL_MODEL_NAME=Qwen/Qwen3.5-9B
examples/swe_smith/run.sh server
```
On **Machine A (Kubernetes Controller machine)**, start the Controller:
```bash
export AGL_SERVER_PUBLIC_HOST=<gateway-address>
export AGL_KEY=<same-shared-secret>
export AGL_NAMESPACE=agents
examples/swe_smith/run.sh controller
```
After the Gateway and Controller are ready, start the trainer on **Machine B (GPU training machine)**:
```bash
export AGL_KEY=<same-shared-secret>
export AGL_MODEL_NAME=Qwen/Qwen3.5-9B
examples/swe_smith/run.sh trainer
```
The launcher passes additional arguments to `train_smith_agent.py`, including `verl` dotlist overrides:
```bash
examples/swe_smith/run.sh trainer \
trainer.total_training_steps=100 \
actor_rollout_ref.rollout.n=4
```
## Preventing Reward Hacking
A coding agent may obtain the reference fix without solving the task, for example by inspecting Git history, downloading upstream source code with `curl` or `wget`, installing the original package with `pip`, or using Python networking libraries such as `urllib`.
The SWE agent limits these reward-hacking paths in two ways:
- **Repository isolation:** before the agent starts, the harness checks out the task branch and moves `.git` outside the visible testbed. Agent commands that invoke Git, access the hidden Git metadata, install packages, download files, or modify the test harness are blocked.
- **Network isolation:** we strongly recommend adding a Kubernetes network policy that denies all outbound traffic from agent pods except connections to the AGL Gateway. Without this restriction, an agent may retrieve upstream source code or other external information and obtain reward without solving the task as intended.
The final reward is computed by running the task-specific `FAIL_TO_PASS` and `PASS_TO_PASS` tests inside the isolated repository environment. These controls are part of the training setup: weakening them can allow the agent to recover reference code and corrupt the reward signal.
+44
View File
@@ -0,0 +1,44 @@
# Agent Lightning Documentation
<p align="center">
<img src="images/agl-v1.0.svg" alt="Agent Lightning v1.0" width="500">
</p>
Welcome to the Agent Lightning v1.0 documentation. Start with the installation and quick-start guides, then use the configuration guides and examples below to build and train your own agents.
Agent Lightning v1.0 is a completely redesigned and reimplemented version with the following key features:
- 🪶 **~3,500 lines of core Python:** Simplicity is the first principle.
- 🧩 **Training with real agent harnesses:** Agents interact with the model through the Agent Lightning v1.0 proxy with zero changes while keeping tools, context, control flow, and environments in the loop.
- ☸️ **Native Kubernetes support:** Agents run directly as Kubernetes Jobs without relying on external sandbox services.
- 💻 **A complete coding-agent training example:** The released pipeline covers data cleaning, reward-hacking prevention, and training scripts.
For the legacy Agent Lightning releases earlier than v1.0, see the [`v0.x` code branch](https://github.com/microsoft/agent-lightning/tree/v0.x) and the [v0.3.0 documentation](https://microsoft.github.io/agent-lightning/0.3.0/).
## Getting Started
| Guide | Description |
|---|---|
| [Installation](00-installation.md) | Set up the base environment and the tested `verl` GPU stack. |
| [Quick Start](01-quick-start.md) | Run a local end-to-end rollout-driven training job. |
| [Basics](05-basics.md) | Learn the core components, rollouts, events, and trajectories. |
## Configuration
| Guide | Description |
|---|---|
| [Trainer Configuration](20-trainer-configuration.md) | Configure `verl` integration, rollout collection, and trace aggregation. |
| [API Gateway Configuration](25-api-gateway-configuration.md) | Configure the API Gateway and model proxy. |
| [Controller Configuration](30-controller-configuration.md) | Configure local and Kubernetes rollout runners. |
| [Asynchronous Training](35-asynchronous-training.md) | Configure collocated asynchronous collection and pause/drain behavior. |
## Examples
| Example | Description |
|---|---|
| [Calc-X](50-example-calc-x.md) | Train a math reasoning agent with AutoGen and MCP calculator tools. |
| [GSM8K](55-example-gsm8k.md) | Train an agent on grade-school math reasoning tasks. |
| [ScienceWorld](60-example-science-world.md) | Train an agent on interactive science tasks in a text environment. |
| [Search-R1](65-example-search-r1.md) | Train a multi-turn retrieval and reasoning agent. |
| [LLM-in-Sandbox](70-example-llm-in-sandbox.md) | Train a general agent with computer and code execution tools. |
| [Coding Agent](75-example-coding-agent.md) | Train a coding agent using repository tests as feedback. |
+4
View File
@@ -0,0 +1,4 @@
<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M8.06935 0.740967C8.46471 0.740967 8.78513 1.06143 8.78513 1.45675C8.78513 1.73028 8.6317 1.96783 8.40619 2.08833V2.6357C8.60265 2.66378 9.18471 2.67955 9.92197 3.01465C10.8483 3.4357 11.121 3.77803 11.4378 4.2357C11.6095 4.48376 11.7205 4.74914 11.7909 5.0357H11.9009C12.273 5.0357 12.5746 5.33732 12.5746 5.70938V6.38307C12.5746 6.75514 12.273 7.05675 11.9009 7.05675H11.8192C11.7591 7.40026 11.6762 7.69328 11.6062 7.85675C11.413 8.30755 11.129 8.48833 10.9746 8.53044C11.0869 8.57254 11.4395 8.67604 11.6483 8.82517C11.943 9.0357 12.2378 9.39174 12.2378 9.75149C12.2378 10.0462 12.1957 10.4673 11.9851 10.6778C11.7074 10.9556 11.2272 11.4778 10.9746 11.6883L6.34303 15.8568L7.35356 13.4989L10.3851 9.54096H8.02724L8.86934 6.59359L8.19658 7.34393L8.19567 7.35149L5.2483 10.762H7.6904L7.10093 12.7831L5.62724 11.8989L4.91146 11.4357C4.53251 11.1831 4.32198 11.0989 4.06935 10.6778C3.91617 10.4225 3.90093 10.0462 3.90093 9.75149C3.90093 9.39174 4.19567 9.0357 4.4904 8.82517C4.69915 8.67604 4.78514 8.61465 4.99567 8.53044C4.82724 8.44623 4.7257 8.30755 4.53251 7.85675C4.46245 7.69328 4.37956 7.40026 4.31951 7.05675H4.23777C3.8657 7.05675 3.56409 6.75514 3.56409 6.38307V5.70938C3.56409 5.33732 3.8657 5.0357 4.23777 5.0357H4.34788C4.41815 4.74914 4.5292 4.48376 4.70093 4.2357C5.01778 3.77803 5.2904 3.4357 6.21672 3.01465C6.95396 2.67955 7.53602 2.66378 7.73251 2.6357V2.08833C7.50704 1.96783 7.35356 1.73028 7.35356 1.45675C7.35356 1.06143 7.67403 0.740967 8.06935 0.740967ZM6.80619 5.0357C6.50389 5.0357 6.25882 5.28077 6.25882 5.58307C6.25882 5.88538 6.50389 6.13044 6.80619 6.13044C7.1085 6.13044 7.35356 5.88538 7.35356 5.58307C7.35356 5.28077 7.1085 5.0357 6.80619 5.0357ZM9.3325 5.0357C9.03018 5.0357 8.78513 5.28077 8.78513 5.58307C8.78513 5.88538 9.03018 6.13044 9.3325 6.13044C9.63481 6.13044 9.87987 5.88538 9.87987 5.58307C9.87987 5.28077 9.63481 5.0357 9.3325 5.0357Z" fill="white"/>
<path d="M12.2279 9.63738C12.2342 9.67527 12.2378 9.71342 12.2378 9.75165C12.2378 10.0464 12.1957 10.4674 11.9851 10.678C11.7074 10.9558 11.2272 11.478 10.9746 11.6885L6.34305 15.8569L7.35357 13.499L7.9831 12.677C8.20912 12.6273 8.41543 12.5774 8.57462 12.5306C9.29041 12.3201 10.1325 11.6885 10.7641 11.099C11.2418 10.6531 11.9076 9.97136 12.2279 9.63738ZM9.62725 3.77271C10.3248 3.77271 10.8904 4.33825 10.8904 5.03586V6.80428C10.8904 7.50191 10.3248 8.06744 9.62725 8.06744H8.4483L8.86935 6.59376L8.19659 7.34409L8.19568 7.35165L7.57479 8.06744H6.59568C5.89805 8.06744 5.33252 7.50191 5.33252 6.80428V5.03586C5.33252 4.33825 5.89805 3.77271 6.59568 3.77271H9.62725ZM6.8062 5.03586C6.5039 5.03586 6.25884 5.28093 6.25884 5.58323C6.25884 5.88554 6.5039 6.1306 6.8062 6.1306C7.10851 6.1306 7.35357 5.88554 7.35357 5.58323C7.35357 5.28093 7.10851 5.03586 6.8062 5.03586ZM9.33251 5.03586C9.0302 5.03586 8.78514 5.28093 8.78514 5.58323C8.78514 5.88554 9.0302 6.1306 9.33251 6.1306C9.63483 6.1306 9.87988 5.88554 9.87988 5.58323C9.87988 5.28093 9.63483 5.03586 9.33251 5.03586Z" fill="white"/>
</svg>

After

Width:  |  Height:  |  Size: 3.0 KiB

+4
View File
@@ -0,0 +1,4 @@
<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M8.06935 0.740967C8.46471 0.740967 8.78513 1.06143 8.78513 1.45675C8.78513 1.73028 8.6317 1.96783 8.40619 2.08833V2.6357C8.60265 2.66378 9.18471 2.67955 9.92197 3.01465C10.8483 3.4357 11.121 3.77803 11.4378 4.2357C11.6095 4.48376 11.7205 4.74914 11.7909 5.0357H11.9009C12.273 5.0357 12.5746 5.33732 12.5746 5.70938V6.38307C12.5746 6.75514 12.273 7.05675 11.9009 7.05675H11.8192C11.7591 7.40026 11.6762 7.69328 11.6062 7.85675C11.413 8.30755 11.129 8.48833 10.9746 8.53044C11.0869 8.57254 11.4395 8.67604 11.6483 8.82517C11.943 9.0357 12.2378 9.39174 12.2378 9.75149C12.2378 10.0462 12.1957 10.4673 11.9851 10.6778C11.7074 10.9556 11.2272 11.4778 10.9746 11.6883L6.34303 15.8568L7.35356 13.4989L10.3851 9.54096H8.02724L8.86934 6.59359L8.19658 7.34393L8.19567 7.35149L5.2483 10.762H7.6904L7.10093 12.7831L5.62724 11.8989L4.91146 11.4357C4.53251 11.1831 4.32198 11.0989 4.06935 10.6778C3.91617 10.4225 3.90093 10.0462 3.90093 9.75149C3.90093 9.39174 4.19567 9.0357 4.4904 8.82517C4.69915 8.67604 4.78514 8.61465 4.99567 8.53044C4.82724 8.44623 4.7257 8.30755 4.53251 7.85675C4.46245 7.69328 4.37956 7.40026 4.31951 7.05675H4.23777C3.8657 7.05675 3.56409 6.75514 3.56409 6.38307V5.70938C3.56409 5.33732 3.8657 5.0357 4.23777 5.0357H4.34788C4.41815 4.74914 4.5292 4.48376 4.70093 4.2357C5.01778 3.77803 5.2904 3.4357 6.21672 3.01465C6.95396 2.67955 7.53602 2.66378 7.73251 2.6357V2.08833C7.50704 1.96783 7.35356 1.73028 7.35356 1.45675C7.35356 1.06143 7.67403 0.740967 8.06935 0.740967ZM6.80619 5.0357C6.50389 5.0357 6.25882 5.28077 6.25882 5.58307C6.25882 5.88538 6.50389 6.13044 6.80619 6.13044C7.1085 6.13044 7.35356 5.88538 7.35356 5.58307C7.35356 5.28077 7.1085 5.0357 6.80619 5.0357ZM9.3325 5.0357C9.03018 5.0357 8.78513 5.28077 8.78513 5.58307C8.78513 5.88538 9.03018 6.13044 9.3325 6.13044C9.63481 6.13044 9.87987 5.88538 9.87987 5.58307C9.87987 5.28077 9.63481 5.0357 9.3325 5.0357Z" fill="#F69047"/>
<path d="M12.2279 9.63738C12.2342 9.67527 12.2378 9.71342 12.2378 9.75165C12.2378 10.0464 12.1957 10.4674 11.9851 10.678C11.7074 10.9558 11.2272 11.478 10.9746 11.6885L6.34305 15.8569L7.35357 13.499L7.9831 12.677C8.20912 12.6273 8.41543 12.5774 8.57462 12.5306C9.29041 12.3201 10.1325 11.6885 10.7641 11.099C11.2418 10.6531 11.9076 9.97136 12.2279 9.63738ZM9.62725 3.77271C10.3248 3.77271 10.8904 4.33825 10.8904 5.03586V6.80428C10.8904 7.50191 10.3248 8.06744 9.62725 8.06744H8.4483L8.86935 6.59376L8.19659 7.34409L8.19568 7.35165L7.57479 8.06744H6.59568C5.89805 8.06744 5.33252 7.50191 5.33252 6.80428V5.03586C5.33252 4.33825 5.89805 3.77271 6.59568 3.77271H9.62725ZM6.8062 5.03586C6.5039 5.03586 6.25884 5.28093 6.25884 5.58323C6.25884 5.88554 6.5039 6.1306 6.8062 6.1306C7.10851 6.1306 7.35357 5.88554 7.35357 5.58323C7.35357 5.28093 7.10851 5.03586 6.8062 5.03586ZM9.33251 5.03586C9.0302 5.03586 8.78514 5.28093 8.78514 5.58323C8.78514 5.88554 9.0302 6.1306 9.33251 6.1306C9.63483 6.1306 9.87988 5.88554 9.87988 5.58323C9.87988 5.28093 9.63483 5.03586 9.33251 5.03586Z" fill="#C45259"/>
</svg>

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 598 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 166 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 310 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 235 KiB

@@ -1,31 +0,0 @@
# Server-client Architecture
Article to be written.
```mermaid
sequenceDiagram
participant RL as RL Framework
participant TS as Training Server
participant AC as Agent Client
participant AG as Agent
AC->>TS: Upload Dataset (1)
RL->>TS: Start RL Server (2)
TS->>RL: Latest Model (3)
loop for each batch of tasks
loop for each task in the batch
AC->>TS: Request Task (4)
TS->>AC: Send Task & Model API (5)
AC->>AG: Run Agent with Task & Model API (6)
loop for each LLM call
AC->>AG: Prompt (7)
AG->>AC: Response (8)
end
AG->>AC: Rewarded Trace (9)
AC->>TS: Send Rewarded Trace (10)
end
TS->>RL: Send Batch of Traces (11)
RL->>TS: Return Updated Model (12)
end
```
-184
View File
@@ -1,184 +0,0 @@
# SQL Agent with Agent Lightning
> This tutorial is tested with `verl==0.5.0` and `vllm==0.10.0`.
This example demonstrates how to build and train a self-correcting SQL agent. It leverages [Agent Lightning]({{ config.repo_url }}) and the `verl` framework for Reinforcement Learning (RL) based training, and LangGraph to define the agent's complex, cyclical reasoning workflow. The goal is to fine-tune a Large Language Model (LLM) to accurately convert natural language questions into executable SQL queries.
## SQL Agent Implementation
The design of Agent-lightning **allows flexible integration with various agent frameworks**, including AutoGen, CrewAI, OpenAI Agent SDK, LangGraph, and more. It can also work without agent frameworks, allowing you to train an agent built from scratch with Python code. See [our example gallery]({{ config.repo_url }}/tree/{{ config.extra.source_commit }}/examples) for more details.
The core of the agent is a state machine built with LangGraph, which allows for a robust and transparent workflow. The agent's logic, as visualized below, starts by writing a query, executes it, and then enters a refinement loop where it checks and rewrites the query until it is deemed correct or a turn limit is reached.
```mermaid
---
config:
flowchart:
curve: linear
---
graph LR;
__start__([<p>__start__</p>]):::first
write_query(write_query)
execute_query(execute_query)
check_query(check_query)
rewrite_query(rewrite_query)
__end__([<p>__end__</p>]):::last
__start__ --> write_query;
check_query -.-> __end__;
check_query -.-> rewrite_query;
execute_query --> check_query;
rewrite_query --> execute_query;
write_query --> execute_query;
classDef default fill:#f2f2f2,line-height:1.2
classDef first fill-opacity:0
classDef last fill:#cccccc
```
This workflow is implemented in the `SQLAgent` class within `sql_agent.py`. It consists of the following key steps:
1. **write_query**: Given a user's question and database schema, the agent makes an initial attempt to write a SQL query.
2. **execute_query**: The generated query is run against the target database.
3. **check_query**: The agent analyzes the original query and its execution result (or error) to check for mistakes. It uses a specific prompt (`CHECK_QUERY_PROMPT`) to determine if the query is correct.
4. **rewrite_query**: If the `check_query` step finds errors, the agent enters this step. It uses the feedback from the previous step to generate a corrected SQL query. The process then loops back to `check_query` for re-evaluation.
5. **END**: The loop terminates when `check_query` confirms the query is correct or the maximum number of turns (`max_turns`) is exceeded. One turn corresponds to a complete cycle of `write_query` (if first round), `execute_query`, `check_query`, and potentially `rewrite_query`.
We aim to train **write_query** and **rewrite_query** step in the setup of this example. The **check_query** step is not trained but will share the same LLM weights as the other steps.
## Client-Server Training with Agent Lightning
The training process uses a distributed client-server architecture designed by Agent Lightning to efficiently fine-tune the underlying LLM. This separation allows for scalable data generation across multiple clients while centralizing the computationally intensive model training on a dedicated server with GPUs, and also provides opportunities for customizing algorithms and training strategies (like [prompt optimization]({{ config.repo_url }}/tree/{{ config.extra.source_commit }}/examples/apo)) with minimal code changes.
* **Training Server (`agentlightning.verl`)**: The server, launched with the first command below, manages the core training loop. It runs an RL algorithm (with `verl` of course) and hosts an OpenAI-compatible LLM endpoint (with `verl`'s async server). The server's sole purpose is to receive interaction data from clients and update the LLM's weights to improve its performance. [This link]({{ config.repo_url }}/tree/{{ config.extra.source_commit }}/agentlightning/verl) points to the implementation of the server, which is built upon `verl`.
* **Agent Clients (`sql_agent.py`)**: The clients run the LangGraph agent logic described above. They connect to the server to fetch tasks (natural language questions) and use the server's **OpenAI-compatible endpoint** for all generation steps (`write_query`, `check_query`, `rewrite_query`). After completing a task, the client exports its interaction traces (traced by [AgentOps](https://www.agentops.ai/) and filtered by trace hierarchy), evaluates its correctness to calculate a reward, and sends the entire interaction history (the "trajectory") back to the server for training. To adapt any agent to an "agent client", you do not need to change the agent logic, but only need to invoke the client's `run` method with `agentlightning.trainer`.
![Difference between the original agent and modified agent client](../assets/sql-agent-diff.png)
## Running the Example
1. Prepare the dataset: download from [here](https://drive.google.com/file/d/1oi9J1jZP9TyM35L85CL3qeGWl2jqlnL6/view) and unzip it to the `data` folder. It's basically a [Spider V1](https://yale-lily.github.io/spider) dataset converted to Parquet format. The dataset contains about 8000 training samples and about 2000 test samples, from which we sampled 500 samples for evaluation.
```bash
pip install gdown
gdown --fuzzy https://drive.google.com/file/d/1oi9J1jZP9TyM35L85CL3qeGWl2jqlnL6/view
unzip -q spider-data.zip -d data
rm spider-data.zip
```
2. Install the required dependencies:
```bash
pip install -r requirements.txt
```
3. Launch the training server:
```bash
python -m agentlightning.verl \
agentlightning.port=9997 \
algorithm.adv_estimator=grpo \
data.train_files=data/train_spider.parquet \
data.val_files=data/test_dev_500.parquet \
actor_rollout_ref.rollout.tensor_model_parallel_size=1 \
trainer.n_gpus_per_node=1 \
data.train_batch_size=32 \
actor_rollout_ref.rollout.n=4 \
actor_rollout_ref.actor.ppo_mini_batch_size=32 \
actor_rollout_ref.actor.ppo_micro_batch_size_per_gpu=4 \
actor_rollout_ref.rollout.log_prob_micro_batch_size_per_gpu=4 \
actor_rollout_ref.rollout.multi_turn.format=hermes \
actor_rollout_ref.model.path=meta-llama/Llama-3.2-3B-Instruct \
data.max_prompt_length=4096 \
data.max_response_length=2048 \
data.truncation='error' \
trainer.val_before_train=True \
actor_rollout_ref.actor.optim.lr=1e-6 \
actor_rollout_ref.model.use_remove_padding=True \
actor_rollout_ref.actor.use_kl_loss=False \
actor_rollout_ref.actor.kl_loss_coef=0.000 \
actor_rollout_ref.actor.entropy_coeff=0 \
actor_rollout_ref.actor.clip_ratio_low=0.2 \
actor_rollout_ref.actor.clip_ratio_high=0.3 \
actor_rollout_ref.model.enable_gradient_checkpointing=True \
actor_rollout_ref.actor.fsdp_config.param_offload=True \
actor_rollout_ref.actor.fsdp_config.optimizer_offload=True \
actor_rollout_ref.rollout.name=vllm \
actor_rollout_ref.rollout.gpu_memory_utilization=0.8 \
actor_rollout_ref.ref.log_prob_micro_batch_size_per_gpu=8 \
actor_rollout_ref.ref.fsdp_config.param_offload=True \
algorithm.use_kl_in_reward=False \
trainer.critic_warmup=0 \
trainer.logger=['console','wandb'] \
trainer.project_name=AgentLightning \
trainer.experiment_name=train_sql_agent \
trainer.nnodes=1 \
trainer.save_freq=256 \
trainer.test_freq=32 \
trainer.total_epochs=2
```
4. Launch agent clients that connect with the server:
```bash
export VERL_API_BASE=http://localhost:9997/ # Same as the server port. This is used for receiving tasks and sending results.
python sql_agent.py \
--litsqlagent.trained-agents write \ # Will only train the write and rewrite agent.
--trainer.n-workers 16 \
--litsqlagent.val-temperature 0
```
There is no hard requirement in the launching order of the server and clients. But remember to kill the long-running agent clients after the training is done.
## Debug the Agent without verl
You can run the agent client alone without the `verl` server. This is useful for debugging the agent logic and SQL execution.
1. Copy `.env.example` to `.env` and fill in your OpenAI API key. `VERL_API_BASE` does not really matter here because you are not connecting to the server end.
2. Run the agent client:
```bash
dotenv run python sql_agent.py \
--litsqlagent.trained-agents write \ # Will only select the trajectories related to write and rewrite.
--trainer.n-workers 1 \ # For debug, use single process.
--trainer.dev true # Enable the dev debug mode.
```
## Evaluation
The example is evaluated using Llama-3.2-Instruct models. The models are trained on the Spider dataset for 2 epochs, with evaluation performed on a randomly selected subset of 500 test samples to compute held-out accuracy. The default setup for running agent clients during evaluation is as follows:
```bash
python sql_agent.py \
--litsqlagent.trained-agents write \
--trainer.n-workers 16 \
--trainer.daemon true \
--litsqlagent.val-temperature 0 \
--litsqlagent.max-turns 3 \
--litsqlagent.table-info-truncate 2048 \
--litsqlagent.execution-truncate 2048
```
The setup of training server is the same as the command above.
### W&B Report
[link](https://api.wandb.ai/links/ultmaster/4cid500g)
### Performance Metrics
![](../assets/sql-agent-val-reward-curve.png)
| Model | Size | Context | Max Turns | Agents | Acc (Initial) | Acc (Final) | Transitions | Prompt Length | Response Length |
|---------------|--------|-----------|-------------|-------------------------------|-----------------|---------------|---------------|-----------------|-------------------|
| Llama3.2 | 1B | 2048 | 3 | write&#124;rewrite | 21 | 49.6 | 2.87 → 3.08 | 821.2 | 319.2 → 249.4 |
| Llama3.2 | 3B | 2048 | 3 | write&#124;rewrite | 51.8 | 66.4 | 2.20 → 2.72 | 865.6 | 116.2 → 314.3 |
**Notes:**
1. **Context Length**: Controlled via `--litsqlagent.table-info-truncate <context-length>` and `--litsqlagent.execution-truncate <context-length>`
2. **Max Turns**: Set using `--litsqlagent.max-turns <max-turns>`
3. **Agents**: Specified with `--litsqlagent.agents <regex>` (defaults to `write`, which matches both write and rewrite agents)
4. **Transitions**: Represents the number of prompt-response pairs traced (collected) during each rollout. Note that this differs from the turn count in the SQL agent workflow, where one turn may encompass 2-3 transitions in the check-rewrite cycle. The number of transitions is also related to which *agents* get involved in the training.
5. **Prompt/Response Length**: Average token count per **traced** prompt/transition response.
### Efficiency Metrics
| Model | Size | Context | Max Turns | Agents | # GPUs | # Steps | Time (h) | Time/Step (s) | Rollout Time (%) | Update Actor Time (%) |
|---------------|--------|-----------|-------------|-------------------------------|----------|-----------|------------|-----------------|--------------------|-------------------------|
| Llama3.2 | 1B | 2048 | 3 | write&#124;rewrite | 1 | 436 | 13.06 | 98.9 | 66.7 | 25.2 |
| Llama3.2 | 3B | 2048 | 3 | write&#124;rewrite | 2 | 436 | 10.3 | 181.3 | 63.9 | 27.9 |
Binary file not shown.

After

Width:  |  Height:  |  Size: 154 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 302 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 224 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 242 KiB

Some files were not shown because too many files have changed in this diff Show More