Skip to content

docs(weave): add "Evaluate your AI agent with Weave" tutorial - #2945

Draft
anastasiaguspan wants to merge 3 commits into
mainfrom
aguspan/docs-agent-evals
Draft

docs(weave): add "Evaluate your AI agent with Weave" tutorial#2945
anastasiaguspan wants to merge 3 commits into
mainfrom
aguspan/docs-agent-evals

Conversation

@anastasiaguspan

@anastasiaguspan anastasiaguspan commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Summary

New Get Started tutorial, Evaluate your AI agent with Weave (weave/agent-evals.mdx), with a companion Colab (weave/cookbooks/source/agent_evals.ipynb) and a nav entry under the Weave Get Started group.

It teaches agent evaluation with the Agents/Conversations workflow (OTel spans, not Ops/Calls): trace an agent as turns and tool calls, score single-turn and multi-turn task completion with an LLM judge via EvaluationLogger, and compare agent versions.

What's included

  • weave/agent-evals.mdx — the page. Inline code is intentionally reduced to the Weave surface; the full runnable source lives in the Colab.
  • weave/cookbooks/source/agent_evals.ipynb — companion notebook (agent on Claude Sonnet, judge on Claude Opus).
  • docs.jsonweave/agent-evals added to the Get Started group (English only; localized nav untouched).

Verification

The code patterns were run end-to-end against the real Weave and Anthropic SDKs (agent trace, single-turn eval, multi-turn eval) publishing to a live Weave project. The notebook was validated (JSON parses; every code cell parses).

Recommendations for technical review

Identified during authoring and style editing; please confirm before merge.

Technical accuracy

  • The implicitly_patch_integrations: False rationale (avoids duplicate legacy Op/Call traces alongside the manual Conversation SDK spans) matches current behavior.
  • The eval-to-agent-trace deep link is a UI/query-time feature, not an SDK return value — confirm the "link to the transcript" claim renders as described.
  • Model IDs claude-sonnet-5 (agent) and claude-opus-4-8 (judge) are correct for the docs' target audience.

Missing content / confirm

  • The reduced snippets use placeholders (convo_id, new_id(), run_agent_turn, run_tool, response_tool_calls, task_completion, judge_task) defined in a bulleted list and deferred to the Colab — confirm this is enough for a self-contained read.
  • The Colab/GitHub links assume the notebook lands at weave/cookbooks/source/agent_evals.ipynb on main. If the cookbook build renames or generates notebooks, adjust the URLs.
  • Cross-link /weave/guides/evaluation/evaluation_logger exists on main; the in-flight branch codex/link-agent-evals-docs edits that same guide (linked agent eval traces) — coordinate if both land.

Related

  • Complements weave/tutorial-rag.
  • Jira: DOCS-2885.

🤖 Generated with Claude Code

Add a new Get Started tutorial covering agent evaluation with the Weave
Agents/Conversations workflow: tracing an agent as a conversation of turns
and tool calls, scoring single-turn and multi-turn task completion with an
LLM judge via EvaluationLogger, and comparing agent versions. Includes a
companion Colab notebook with the full runnable source.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@anastasiaguspan
anastasiaguspan requested a review from a team as a code owner July 21, 2026 15:00
@anastasiaguspan

Copy link
Copy Markdown
Contributor Author

Resume prompt (for a fresh Claude Code session)

Continue work on wandb/docs PR #2945 (branch aguspan/docs-agent-evals): the new Weave tutorial weave/agent-evals.mdx + companion Colab weave/cookbooks/source/agent_evals.ipynb, nav entry in docs.json under the Weave "Get Started" group. Jira DOCS-2885.

Context: teaches agent evaluation with the new Agents/Conversations workflow (OTel spans, not weave.Op/Calls) — trace an agent, score single- and multi-turn task completion with an LLM judge via EvaluationLogger, compare versions. Created in addition to weave/tutorial-rag (not a replacement). Agent = claude-sonnet-5, judge = claude-opus-4-8. Inline code is intentionally reduced to the Weave surface; full source is in the Colab. Code was verified end-to-end against the real Weave + Anthropic SDKs.

Verified working source and decision notes live outside the repo at ~/agent-eval-tutorial/ (HANDOFF.md, agent.py, judge.py, 01_trace.py, 02_eval_task_completion.py, 04_multi_turn.py). Persistent project memory: .claude/projects/-Users-aguspan-Weave-weave/memory/ (agent-eval-tutorial.md, agent-eval-mechanism.md, task-completion-meaning.md, harbor-analogy.md).

Open items: the "Recommendations for technical review" checklist in the PR body (implicit-patching rationale, eval→trace link being a UI feature, placeholder sufficiency, Colab path, coordination with branch codex/link-agent-evals-docs). Docs style already applied via the docs:docs skill passes.

@mintlify

mintlify Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
wandb 🟢 Ready View Preview Jul 21, 2026, 3:06 PM

@github-actions

github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

📚 Mintlify Preview Links

🔗 View Full Preview

✨ Added (1 total)

📄 Pages (1)

File Preview
weave/agent-evals.mdx Agent Evals

📝 Changed (1 total)

⚙️ Other (1)
File
docs.json

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 0a12a7a at 2026-07-27 13:21:47 UTC

@github-actions

github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

⚠️ Some issues were detected

Preview: https://wb-21fd5541-aguspan-docs-agent-evals.mintlify.site

Full Github Actions output

@mintlify

mintlify Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
wandb 🟡 Building Jul 21, 2026, 3:01 PM

Comment thread weave/agent-evals.mdx Outdated
@w-b-hivemind

w-b-hivemind Bot commented Jul 24, 2026

Copy link
Copy Markdown

HiveMind Sessions

2 sessions · 1h 43m · $39

Session Agent Duration Tokens Cost Lines
Review and Push TypeScript Docs Changes
fd5aed14-d82d-4281-bd6e-5ea05c63a581
claude 23m 47.1K $4.73 +259 -36
Agent Evals Documentation and Notebook Overhaul
8980c233-4799-4ecc-a696-ef116d75a721
claude 1h 19m 234.4K $34 +417 -46
Total 1h 43m 281.4K $39 +676 -82

View all sessions in HiveMind →

Run claude --resume fd5aed14-d82d-4281-bd6e-5ea05c63a581 to pickup where you left off.

Fold per-language prose and code into <Tabs> on the init, conversation-trace,
Score, Compare, and Multi-turn sections, keeping shared prose outside the tabs.
Demote task_completion to an example LLM judge rather than a Weave concept,
trim the scope note and Extend section, and fix the compare_evals and scorers
links.

Expand the accompanying Python notebook to a runnable 20 cells: %pip install,
getpass key entry, run_agent_turn returning (reply, transcript),
judge_task_completion, and Evals-tab navigation clues.

The Python path is verified end to end. The TypeScript tabs still reference an
accompanying TypeScript file that is not yet in the repo, and their claim that
conversation spans link to eval rows does not hold on weave JS 0.16.3 — two SDK
bugs (complete-mode project writes, EvalLinkSpanProcessor registration) are with
engineering. Resolve both before this page ships.

Co-Authored-By: Claude Opus 5 (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