Skip to content

docs(v6): add platform links to quickstart, intro, and eval guide #614

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

Open
shfunc wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −2
Open

docs(v6): add platform links to quickstart, intro, and eval guide #614

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/v6/guides/running-an-eval.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ hud eval "My Taskset" claude --all --group 3
```

**From the platform**, open [hud.ai](https://hud.ai), pick the environment, choose a taskset and a model,
and launch - no CLI required.
and launch - no CLI required. See [evaluations on the platform](/platform/evaluations) for that flow.

### Choosing an agent

Expand Down
1 change: 1 addition & 0 deletions docs/v6/start/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ that environment, and run any agent to perform those tasks, at any scale. Our SD
- [**Advanced**](/v6/advanced/extending) - off the beaten path: bring your own harness, composing environments, subagents, and chat.
- [**Cookbooks**](/v6/cookbooks/index) - worked examples and creative ways to use HUD.
- [**More**](/v6/more/faq) - FAQ, migrating to v6, and contributing.
- [**Platform**](/platform/introduction) - the hud.ai side of the workflow: deployed environments, tasksets, evaluations, and traces.

{/* <CardGroup cols={2}>
<Card title="Quickstart" icon="bolt" href="/v6/start/quickstart">
Expand Down
8 changes: 7 additions & 1 deletion docs/v6/start/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,10 @@ tasks = [count_letter(word=w) for w in ("strawberry", "raspberry", "blueberry")]
hud eval tasks.py claude
```

`hud eval` spawns the environment locally, runs the `claude` agent, and grades it. Every rollout generates a replayable trace on [hud.ai](https://hud.ai).
`hud eval` spawns the environment locally, runs the `claude` agent, and grades it. Every rollout generates a replayable trace on [hud.ai](https://hud.ai).

## 5. View your traces

`hud eval` prints a job link. Open it on [hud.ai](https://hud.ai) to replay each trace step by
step - every prompt, action, and the reward the grader returned. From the
[platform](/platform/evaluations) you can run whole tasksets across models and compare the results.
Loading