Skip to content

docs(readme): document experiment eval contract #1577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
christso merged 1 commit into from
Jun 30, 2026
Merged

docs(readme): document experiment eval contract #1577

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ agentv init

**3. Create an eval** in `evals/`:
```yaml
name: backend-with-skills
experiment: backend-with-skills
description: Code generation quality
target: copilot-sdk
model: claude-sonnet-4.6
Expand All @@ -67,6 +67,7 @@ workspace:

policy:
runs: 3
early_exit: false
timeout_seconds: 600
threshold: 0.8
budget_usd: 5
Expand Down Expand Up @@ -96,7 +97,7 @@ agentv compare .agentv/results/backend-without-skills/<timestamp>/copilot-sdk--c

## Results

Each run writes a timestamped invocation directory under `.agentv/results/<experiment>/<timestamp>/`. In this example, `name: backend-with-skills` names the condition being measured, `target: copilot-sdk` selects the system under test, and `model: claude-sonnet-4.6` overrides that target's default model. The resolved target identity is still `copilot-sdk--claude-sonnet-4.6` so CI baselines can distinguish model changes. The flat `index.jsonl` manifest is the portable surface used by scripts, CI, and `agentv compare`:
Each run writes a timestamped invocation directory under `.agentv/results/<experiment>/<timestamp>/`. In this example, `experiment: backend-with-skills` names the condition being measured, `target: copilot-sdk` selects the system under test, and `model: claude-sonnet-4.6` overrides that target's default model. The resolved target identity is still `copilot-sdk--claude-sonnet-4.6` so CI baselines can distinguish model changes. The flat `index.jsonl` manifest is the portable surface used by scripts, CI, and `agentv compare`:

```bash
agentv eval evals/my-eval.yaml
Expand Down Expand Up @@ -162,12 +163,13 @@ Use `defineEval()` when you want AgentV to run the TypeScript eval file:
import { defineEval } from '@agentv/sdk';

export default defineEval({
name: 'backend-with-skills',
experiment: 'backend-with-skills',
description: 'Code generation quality',
target: 'copilot-sdk',
model: 'claude-sonnet-4.6',
policy: {
runs: 3,
earlyExit: false,
timeoutSeconds: 600,
threshold: 0.8,
budgetUsd: 5,
Expand Down
Loading