Skip to content

docs: refresh README as evidence-generating eval infra#271

Merged
abrichr merged 1 commit into
mainfrom
docs/readme-refresh
Jul 21, 2026
Merged

docs: refresh README as evidence-generating eval infra#271
abrichr merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@abrichr

@abrichr abrichr commented Jul 21, 2026

Copy link
Copy Markdown
Member

Summary

Refreshes the openadapt-evals README to reflect what the repo actually is today: evaluation and benchmarking infrastructure that produces the evidence behind OpenAdapt's governed-demonstration-compiler claims, not an end-user product.

Verified against the current package layout, pyproject.toml entry points, and recent commits (#265, #266, #269, #270) before writing.

Key changes

  • Honest positioning. Keeps and cleans the research-status banner; states plainly this is internal/research tooling not required to record, compile, or replay a workflow.
  • openadapt-flow evaluation section (new). Documents scripts/eval_flow_on_waa.py / openadapt-eval-flow: replay (compile one demo, replay against WAA with ~0 model calls) and hybrid (compiled-first, agent fallback on halt), both scored by WAA's own verifier. Notes it is dry-run by default and hard cost-capped.
  • Evidence framing. Explains the accounting dimensions (compiled vs zero-shot, silent wrong-action rate, over-halt rate, cost/model-call accounting) and points at the committed eval_results/ reports and their generator scripts.
  • New surfaces documented. Meta-benchmark harness (harness/), the unified oa VM CLI, openenv/, workflow/, analysis/.
  • Architecture tree updated to match the real openadapt_evals/ layout.
  • Substrates first-class in the product with honest maturity; private crown-jewel data and recipes kept out of scope.
  • Cross-links to docs.openadapt.ai, the openadapt launcher, and openadapt-flow.
  • No em dashes anywhere (verified).

Docs-only change; no code touched.

🤖 Generated with Claude Code

https://claude.ai/code/session_01NyCHrzA1psrKMFfroYbzaM

Reframe the README around what this repo actually is: evaluation and
benchmarking infrastructure that produces evidence for OpenAdapt's
governed-demonstration-compiler claims, not an end-user product.

- Keep and clean the research-status banner (no em dashes anywhere)
- Add the openadapt-flow evaluation section (replay + hybrid on WAA,
  scored by WAA's own verifier, dry-run-by-default and cost-capped)
- Document the meta-benchmark harness, the unified oa VM CLI, the
  openadapt-eval-flow entry point, and the committed evidence reports
- Update the architecture tree to match the current package layout
  (flow/, harness/, openenv/, workflow/, analysis/, cli/)
- Frame substrates as first-class in the product with honest maturity;
  keep private crown-jewel data and recipes out of scope
- Cross-link docs.openadapt.ai and the OpenAdaptAI org

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NyCHrzA1psrKMFfroYbzaM
@abrichr
abrichr merged commit 1fec685 into main Jul 21, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant