Skip to content

docs(weave): add Compare evaluations page (DOCS-2540)#2931

Merged
anastasiaguspan merged 4 commits into
mainfrom
compare-eval-docs-2540
Jul 21, 2026
Merged

docs(weave): add Compare evaluations page (DOCS-2540)#2931
anastasiaguspan merged 4 commits into
mainfrom
compare-eval-docs-2540

Conversation

@anastasiaguspan

@anastasiaguspan anastasiaguspan commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a new How-to guide, Compare evaluations, to the Weave docs. It documents the Compare evaluations view: opening it from the Evals table, reading the Summary and Dataset results tabs, and the customization actions (set a baseline, change comparison order, remove from comparison).

  • New page: weave/guides/evaluation/compare_evals.mdx
  • 4 new images under weave/guides/evaluation/img/
  • Nav: added under Evaluate your agents and applications in docs.json (English nav only)

Resolves DOCS-2540.

What the ticket asked for (and how it's handled)

  • Add a general discussion of eval comparison, including the properties/metrics table below the charts — done.
  • Adapt 3 sections from Compare traces and other logged information (Set a baseline, Change the comparison order, Remove from comparison) for the slightly different evals UI — done.
  • Remove a baseline section excluded (disabled in this UI, per ticket) — done.
  • Change the comparison order copied verbatim — done.
  • Remove from comparison wording (no "object") — done.
  • 4 new images swapped in; page placed under Evaluation with images under img/ — done.
  • Filename compare_evals.mdx, title "Compare evaluations" — done.

Verified against source (wandb/core)

Several claims were checked directly against frontends/weave/.../CompareEvaluationsPage:

  • Inconsistency warnings (ScorecardSection.tsx): "Dataset inconsistency detected" fires when the dataset ref varies across evals and limits examples to the dataset intersection; "Scoring inconsistency detected" fires when the scorer ref varies. Page wording updated to match.
  • Dataset results tab (CompareEvaluationsPage.tsx, ExampleCompareSection, ExampleFilterSection): per-example table with a row-detail pane; two scatter plots (brush-to-filter) render only when comparing exactly two evaluations; shows a "0 rows in common" alert when datasets don't intersect.
  • Metric diff badge color (ScorecardSection.tsx): driven by a metricLowerIsBetter flag — higher-is-better by default (increase = green), reversed for lower-is-better metrics. Page wording updated from the earlier improve/regress phrasing.

Recommendations for technical review

Please confirm the remaining items before merging.

Technical accuracy

  • Badge color relies on each metric being correctly flagged metricLowerIsBetter. In the ticket screenshot, violation_count shows green on an increase because it isn't flagged lower-is-better. Confirm whether that's expected (built-in scorers may not set the flag), so we can decide whether the page needs a caveat.
  • Confirm the per-example table columns (dataset input + each evaluation's output + scorer metrics) are described accurately for the general case.

Nice to have

  • All four screenshots show three evaluations, so the two-evaluation scatter plots are described without an image. Consider adding a two-eval screenshot.

Sources

  • JIRA: DOCS-2540 (imported from WBDOCS-1916), reporter Matt Linville; original Slack request from Mohammad Bakir.
  • Source page for adapted sections: weave/guides/tools/comparison.mdx.
  • Source of truth for behavior: wandb/core frontends/weave/src/components/PagePanelComponents/Home/Browse3/pages/CompareEvaluationsPage/.
  • Related eng work: WB-36708 (chart-selection filter fix, Roman Pushkin, core#47427); eval-compare header/crash fix (Griffin Tarpenning); core#47403 persist eval compare columns (Josiah Lee).
  • Screenshots supplied on the ticket (attached to DOCS-2540).

🤖 Generated with Claude Code

Add a new How-to guide under Evaluate your agents and applications that
documents the Weave Compare evaluations view: how to open it, what the
Summary and Dataset results tabs show, and how to set a baseline,
reorder evaluations, and remove an evaluation from the comparison.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@anastasiaguspan

Copy link
Copy Markdown
Contributor Author

Resume prompt (for a fresh Claude Code session)

Continue DOCS-2540 (https://coreweave.atlassian.net/browse/DOCS-2540). The new page weave/guides/evaluation/compare_evals.mdx and its 4 images are committed and pushed on branch compare-eval-docs-2540; draft PR is #2931. It's added to docs.json under "Evaluate your agents and applications" (English nav only). mint broken-links passes.

Key decisions: adapted 3 sections from weave/guides/tools/comparison.mdx; excluded "Remove a baseline" (disabled in this UI per ticket); "Remove from comparison" uses no "object". The metric badge color was changed from improves/regresses to directional (increase = green, decrease = red) based on the eval-compare.png screenshot — SME must confirm this behavior (see the PR's "Recommendations for technical review").

Remaining: (1) SME technical-accuracy review of the flagged items, then (2) editorial/style review, then mark PR ready and assign reviewers. Localized nav (fr/ja/ko) was intentionally left untouched; translation is handled separately.

@wandb-docs-pr-writer

Copy link
Copy Markdown
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 75%, saving 427.9 KB.

Filename Before After Improvement Visual comparison
weave/guides/evaluation/img/eval-compare.png 261.3 KB 63.4 KB 75.7% View diff
weave/guides/evaluation/img/eval-compare-select.png 198.6 KB 50.0 KB 74.8% View diff
weave/guides/evaluation/img/comparison-evals-baseline.png 64.9 KB 17.0 KB 73.8% View diff
weave/guides/evaluation/img/comparison-evals-baseline-set.png 45.9 KB 12.4 KB 73.0% View diff

@wandb-docs-pr-writer

Copy link
Copy Markdown
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 10.8%, saving 6.8 KB.

Filename Before After Improvement Visual comparison
weave/guides/evaluation/img/eval-compare.png 63.4 KB 56.6 KB 10.8% View diff

3 images did not require optimisation.

@mintlify

mintlify Bot commented Jul 17, 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 17, 2026, 8:37 PM

@github-actions

github-actions Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

📚 Mintlify Preview Links

🔗 View Full Preview

✨ Added (1 total)

📄 Pages (1)

File Preview
weave/guides/evaluation/compare_evals.mdx Compare Evals

📝 Changed (1 total)

⚙️ Other (1)
File
docs.json

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 21964f6 at 2026-07-17 21:10:12 UTC

@github-actions

github-actions Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

⚠️ Some issues were detected

Preview: https://wb-21fd5541-compare-eval-docs-2540.mintlify.site

Full Github Actions output

@w-b-hivemind

w-b-hivemind Bot commented Jul 17, 2026

Copy link
Copy Markdown

HiveMind Sessions

1 session · 23m · $5.54

Session Agent Duration Tokens Cost Lines
Technical Documentation Authoring Skill
06c481cb-655d-4292-a46d-ef5ab546f24a
claude 23m 43.9K $5.54 +107 -5
Total 23m 43.9K $5.54 +107 -5
Screenshots

View all sessions in HiveMind →

Run claude --resume 06c481cb-655d-4292-a46d-ef5ab546f24a to pickup where you left off.

… badge color (DOCS-2540)

Verified against wandb/core CompareEvaluationsPage source:
- Dataset results tab is a per-example table (dataset input + each
  evaluation's output and scorer metrics) with a row-detail pane; when
  comparing two evaluations it shows two scatter plots for brushing to
  filter diverging examples. Document the empty (no shared rows) state.
- Match Dataset/Scoring inconsistency warnings to the source: the
  dataset/scorer varies across evaluations; examples are limited to the
  dataset intersection.
- Badge color follows metricLowerIsBetter (higher-is-better by default),
  not a fixed improve/regress rule.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@anastasiaguspan
anastasiaguspan marked this pull request as ready for review July 20, 2026 13:03
@anastasiaguspan
anastasiaguspan requested a review from a team as a code owner July 20, 2026 13:03

@dbrian57 dbrian57 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!


The W&B Weave **Compare evaluations** view lets you inspect two or more logged evaluations side by side. Use it to see how metrics move between runs when you change a prompt, model, or scorer, and to catch dataset or scorer inconsistencies before you draw conclusions from the results.

This guide is for Weave users who want to compare logged evaluations in the Weave UI. It covers how to open the Compare evaluations view, what appears in the summary charts and results tables, and the actions you can take to tailor the comparison, including setting a baseline, reordering evaluations, and removing an evaluation from the comparison.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this section a part of the authoring skill now? I've noticed the bot using it a lot. I feel like it fluffily rehashes the introduction and I'm not a big fan of it.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, the author skill hasn't changed, perhaps its model drift causing different behavior.
tho, fwiw, although i agree it is 'fluffy' - it didn't strike me as something abnormal for docs - typically pages have a introductory recap of "what info will you find in this page?". no? Do we not want that anymore?

* **Properties**: Any additional properties recorded on the evaluation.
* **Metrics**: The aggregate value for each metric produced by the evaluation's scorers.

For numeric metrics, the difference from the baseline is displayed as a colored badge next to the value. The color reflects whether the change is in the favorable or unfavorable direction for that metric: by default, higher values are treated as better, so a green badge marks an increase and a red badge marks a decrease. For metrics configured as lower-is-better, the colors are reversed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great detail.

@anastasiaguspan
anastasiaguspan merged commit 544378a into main Jul 21, 2026
8 checks passed
@anastasiaguspan
anastasiaguspan deleted the compare-eval-docs-2540 branch July 21, 2026 14:40
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.

2 participants