Skip to content

docs: refresh README with honest research positioning#67

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

docs: refresh README with honest research positioning#67
abrichr merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@abrichr

@abrichr abrichr commented Jul 21, 2026

Copy link
Copy Markdown
Member

Refreshes the openadapt-ml README to match the OpenAdapt house positioning and this repo's actual maturity as experimental research code.

What changed

  • Positioning. Frames the product as a governed demonstration compiler (openadapt-flow) whose healthy replay path makes zero model calls, and positions this repo as the upstream research + cost-optimization (Phase 2) surface, not a supported API.
  • Honest training status. New section stating base VLMs cannot operate Windows without SFT; the GRPO standalone backend is the default single-GPU prototyping path while the verl backend is an integration stub that raises NotImplementedError; SFT via TRL SFTTrainer is the most exercised path.
  • Architecture tree updated to the current package layout (grpo/, perception/, export/, baselines/, segmentation/, evals/, models/providers/).
  • Cross-links to docs.openadapt.ai and the OpenAdaptAI/openadapt launcher; notes that private hardening corpora and deployment-derived recipes are kept out of this repo.
  • Removed em-dash-style separators; verified all referenced docs and demo GIFs exist.

Docs-only change; no code touched.

🤖 Generated with Claude Code

https://claude.ai/code/session_01NyCHrzA1psrKMFfroYbzaM

Align openadapt-ml's README with the OpenAdapt house positioning and its
actual, current maturity as experimental research code.

- Frame the product as a governed demonstration compiler (openadapt-flow)
  whose healthy replay path makes zero model calls; position this repo as
  the upstream research and cost-optimization (Phase 2) surface.
- Add an honest training status section: base VLMs cannot operate Windows
  without SFT; GRPO standalone backend is the default prototyping path while
  the verl backend is an integration stub raising NotImplementedError; SFT
  via TRL SFTTrainer is the most exercised path.
- Update the architecture tree to match the current package layout (grpo,
  perception, export, baselines, segmentation, evals, providers).
- Cross-link docs.openadapt.ai and the OpenAdaptAI/openadapt launcher; note
  private hardening corpora and recipes are kept out of this repo.
- Remove em-dash-style separators throughout.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NyCHrzA1psrKMFfroYbzaM
@abrichr
abrichr merged commit 0a1d05c into main Jul 21, 2026
4 checks 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