Skip to content

Commit f3e9fcc

Browse files
Add AI coding agent notice to README
Add a collapsible notice above the Overview that points AI coding agents to the operational setup guide (docs/AGENTS.md) before they help a user install or set up rapidfireai, with a quick RAG-vs-fine-tuning decision and a pointer to the contributor docs. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent beca285 commit f3e9fcc

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,17 @@ Rapid experimentation for easier, faster, and more impactful AI customization.
2424
Built for agentic RAG, context engineering, fine-tuning, and post-training of LLMs and other DL models.
2525
Delivers 16-24x higher throughput without extra resources.
2626

27+
<details>
28+
<summary><strong>🤖 AI coding agent helping a user install or set up rapidfireai? Read first</strong></summary>
29+
30+
If you are an AI coding agent (Claude Code, Cursor, Codex, GitHub Copilot, Windsurf, Aider, Junie, ...) helping a user install or set up `rapidfireai`, read **[`docs/AGENTS.md`](https://github.com/RapidFireAI/rapidfireai/blob/main/docs/AGENTS.md)** ([raw](https://raw.githubusercontent.com/RapidFireAI/rapidfireai/main/docs/AGENTS.md)) first. It is the operational install/setup/troubleshooting guide with a workflow decision tree and safety rules.
31+
32+
Quick decision: **RAG / context engineering**`rapidfireai init` + `Experiment(..., mode="evals")`. **Fine-tuning / post-training (SFT/DPO/GRPO)**`rapidfireai init --train` + `Experiment(..., mode="fit")`.
33+
34+
> **Note for agents working *on* rapidfireai itself (contributors)**: this disclosure is for *end-user* assistance. For repo-internal architecture, build, and contributor flow, see root [`AGENTS.md`](https://github.com/RapidFireAI/rapidfireai/blob/main/AGENTS.md) (canonical for all AI coding agents) and [`CONTRIBUTING.md`](https://github.com/RapidFireAI/rapidfireai/blob/main/CONTRIBUTING.md).
35+
36+
</details>
37+
2738
## Overview
2839

2940
RapidFire AI is a new experiment execution framework that transforms your AI customization experimentation from slow, sequential processes into rapid, intelligent workflows with hyperparallelized execution, dynamic real-time experiment control, and automatic system optimization.

0 commit comments

Comments
 (0)