Skip to content

Add code-integration guide for AI agents (optional, stacked on install guide)#283

Draft
kamran-rapidfireAI wants to merge 1 commit into
docs/agent-install-guidefrom
docs/agent-integration-guide
Draft

Add code-integration guide for AI agents (optional, stacked on install guide)#283
kamran-rapidfireAI wants to merge 1 commit into
docs/agent-install-guidefrom
docs/agent-integration-guide

Conversation

@kamran-rapidfireAI

@kamran-rapidfireAI kamran-rapidfireAI commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

Optional / additive. Extends the install/setup guide (#281) with a code-integration layer.

⚠️ This PR is stacked on docs/agent-install-guide (the install/setup guide, #281). Review and merge that one first; GitHub will auto-retarget this PR to main afterward. It is safe to never merge this PR — the install guide stands alone without it.

What

Extend docs/AGENTS.md with the code-integration layer for AI coding agents wiring rapidfireai into a user's own project (beyond just installing it):

  • Code-integration patterns for the Experiment API — RAG/eval, SFT, DPO, GRPO
  • AutoML config-group reference (RFGridSearch/RFRandomSearch, List/Range, the RF*Config classes)
  • Experiment lifecycle (run_fit/run_evals/get_results/end, rapidfireai start vs Experiment(...))
  • Two extra validation items for the integration path

This change is purely additive over the install guide: it re-adds the integration sections and broadens the title/intro back to "install … and integrate."

Files (1)

  • docs/AGENTS.md

🤖 Generated with Claude Code

Extend docs/AGENTS.md with code-integration patterns for the Experiment API
(RAG/eval, SFT, DPO, GRPO), the AutoML config-group reference, and the
experiment lifecycle, so AI coding agents can wire rapidfireai into a user's
own project, not just install it.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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