style: apply /style-guide pass to models/tables

[johndmulhausen]

Summary

This PR applies the /style-guide skill (Google Developer Style Guide + CoreWeave conventions) to documentation under models/tables. The run was fully automated; only style-level edits were made.

Files edited

• models/tables/evaluate-models.mdx
• models/tables/log_tables.mdx
• models/tables/tables-download.mdx
• models/tables/tables-gallery.mdx
• models/tables/tables-walkthrough.mdx
• models/tables/visualize-tables.mdx

Recommendations for technical review

Prerequisites

• Several pages have no Prerequisites section. Consider adding one covering required packages (weave, wandb, pandas), Python/runtime version, login (wandb login), and account/project access:
  • evaluate-models.mdx (entity/project access, Models Registry access)
  • log_tables.mdx (W&B account, SDK version, project access)
  • tables-download.mdx (link to artifact basics; note pandas dependency)
  • tables-walkthrough.mdx (labeled as Tutorial / Quickstart but missing prereqs)
  • visualize-tables.mdx (logged W&B Tables in artifacts, runs that call wandb.Run.log() with table data, project access in the W&B App)

Verification steps

• Add expected outcomes after procedures so readers can confirm success:
  • evaluate-models.mdx: what the user should see in the Weave UI after running an evaluation, and in the W&B UI after logging a Table.
  • log_tables.mdx: expected output after the Create and log a table procedure (rendered table or run-console confirmation).
  • tables-download.mdx: what example.csv should contain and how to confirm df is populated.
  • tables-walkthrough.mdx: expected state after navigating to a run in "Visualize tables in your project workspace".
  • visualize-tables.mdx: guidance for when the Compare button does not appear on hover (e.g., only one artifact version exists); verification cue for the step slider when _step values are sparse or missing.

Technical accuracy

• evaluate-models.mdx:
  • Line 67 — results = await evaluation.evaluate(model) at top level. Confirm whether the snippet assumes an async context (notebook/REPL) or requires asyncio.run(...).
  • Line 84 — summary, call = await evaluation.evaluate.call(evaluation, model). Verify the .call(...) signature; passing evaluation as both receiver and first argument looks suspicious.
  • Line 100 — llm_judge_scorer is decorated with @weave.op() and uses await but is defined as def, not async def. Verify intended behavior.
  • Line 116 — Inside the batch-evaluation loop, the shared evaluation object is referenced. Verify the intended pattern for batch evals across multiple models.
  • Line 236 — confidences = [model(img).max() for img, _ in test_data] recomputes predictions. Verify whether confidences should be cached from the prior loop.
• log_tables.mdx:
  • In-page anchors on line 14 (#create-and-log-a-new-table, #table-logging-modes) may no longer match the current headings (Create and log a table, Logging modes). Verify against Mintlify's anchor generation.
  • Confirm that MUTABLE / INCREMENTAL are the public API constants (not enum members like LogMode.MUTABLE) before wrapping them in backticks in headings.
  • Line 17 — INCREMENTAL mode version note cites W&B Server v0.70.0+. Confirm whether a separate SDK-version constraint applies or whether SaaS users have a different availability window.
  • Line 232 — resume_step and final_step in the Resume example are referenced but not defined in the snippet. Decide whether to inline definitions or cross-link to resume runs.
• tables-download.mdx:
  • Line 11 — Prose shows artifact.get(table, "table_name") (two args) but the code uses artifact.get("my_table") (one arg). Verify the correct signature against the current SDK.
  • Line 7 — "Like all W&B artifacts, you can convert Tables into pandas DataFrames" — verify whether Tables themselves are Artifacts, or are convertible because they are logged within Artifacts.
  • Lines 15, 24 — wandb.init() as r uses the variable name r; confirm whether the team's idiom is run.
  • Line 35 — Confirm table.get_dataframe() is the canonical method on the current wandb.Table API.
  • Line 51 — Verify /models/artifacts/construct-an-artifact/ is the intended target for the "reference documentation on artifacts" bullet.
• tables-gallery.mdx:
  • Verify all external example URLs still resolve (MNIST predictions, SafeLife RL, Whale2Song audio transfer, Shakespeare RNN, iNaturalist artifact).
  • Line 67 — confirm whether http://wandb.me/audio-transfer should be https.
  • Confirm "ten types of living things" still matches the actual iNaturalist model in the linked artifact.
  • Decide whether to expand "CNN" (line 59) and "RNN" (line 75) for consistency with the spelled-out "reinforcement learning (RL)".
• tables-walkthrough.mdx:
  • Line 22 — link path /models/ref/python/experiments/run.md/#method-runlog has a .md extension mid-path. Verify the route resolves under Mintlify.
  • Lines 46–47 — indentation inside the Pandas DataFrame code block is inconsistent (my_table and run.log indented two spaces instead of four under the with block). Confirm intent or correct in a code-formatting pass.
• visualize-tables.mdx:
  • The "Stateless in an artifact context" callout and the parallel statement under "Save your view" repeat the same idea in slightly different wording. Confirm both phrasings are accurate and aligned with current product behavior.
  • The anchor #custom-step-keys (step 7 of the query-panel procedure) targets a heading "Custom step key" (singular), which renders as #custom-step-key. Confirm the anchor resolves.
  • The H2 "Visualize how values change throughout your runs" is long but the qualifier is meaning-bearing; SMEs may want a shorter alternative.
  • Confirm that nesting the "predictions" screenshot under step 3 of the comparison procedure matches the intended UI sequence.

Missing content

• evaluate-models.mdx: W&B Models Registry and log_mode="MUTABLE" are referenced without inline explanation or link. Add short definitions or links so the page remains self-contained.
• log_tables.mdx:
  • The Examples section reuses placeholder functions (load_eval_data(), model.predict(), get_training_batch(), etc.) defined earlier in Note callouts but does not repeat the placeholder caveats. Add a single shared note at the top of Examples or link to a canonical example dataset/loader.
  • The combined INCREMENTAL + IMMUTABLE pattern (lines 153–180) effectively doubles storage. Add (or confirm the deliberate absence of) explicit guidance about the cost/storage tradeoff.
• tables-download.mdx:
  • Note the pandas dependency.
  • Consider whether other export formats (Parquet, JSON, Excel) merit mention alongside CSV, since the prose says "any method that pandas supports."
• tables-gallery.mdx:
  • The final section "Analyze improvement over training time" has no <Frame> image, unlike every other entry. Confirm whether an image is missing or this is intentional.
  • Several Colab links (wandb.me/dsviz-nature-colab, wandb.me/audio-transfer, wandb.me/dsviz-cars-demo, wandb.me/dsviz-mnist-colab) point to externally maintained notebooks. Confirm they remain runnable.
  • The intro mentions syncing to your hosting instance, but no example differentiates SaaS vs. self-hosted. Consider whether any examples require a specific deployment context.
• tables-walkthrough.mdx:
  • Line 9 references a button to try a PyTorch Quickstart example, but no <Card> or button component is present. Verify whether the component was omitted or the sentence should be removed.
  • The page title and description promise "query data," but the walkthrough does not include a query step. Add a query section or adjust the framing.
• visualize-tables.mdx:
  • "Merged view" and "Side-by-side view" contain author placeholders ({/* To do, add steps */} / {/* To do */}) where step-by-step instructions are not yet written.
  • "Save your view" mentions exporting to a Report but does not describe what the resulting Report contains, or whether the export is a snapshot or a live view.
  • A commented-out table stub at the end of "Custom step key" (Run History Tables Stepper, Run History Plots Stepper, Stepper) appears to be an unfilled comparison table.

How to review

• Each file's changes are style edits only. Compare side-by-side and flag any that change technical meaning.
• Approve and merge to accept the edits, or close to reject them.

[mintlify]

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

Project	Status	Preview	Updated (UTC)
wandb	🟢 Ready	View Preview	Jun 4, 2026, 4:13 PM

[github-actions]

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (6 total)

📄 Pages (6)

File	Preview
models/tables/evaluate-models.mdx	Evaluate Models
models/tables/log_tables.mdx	Log Tables
models/tables/tables-download.mdx	Tables Download
models/tables/tables-gallery.mdx	Tables Gallery
models/tables/tables-walkthrough.mdx	Tables Walkthrough
models/tables/visualize-tables.mdx	Visualize Tables

---

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 7910ed9 at 2026-06-05 20:47:03 UTC

[github-actions]

🔗 Link Checker Results

✅ All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-style-guide-models-tables-20260604-114339.mintlify.app

[ngrayluna]

Incorrect PR title

[johndmulhausen]

Incorrect PR title

Cursor's worktree contagion ended up slurping in other files' style edits; rescoped to models/tables

[Copilot]

Pull request overview

This PR applies automated style-guide edits across the models/tables documentation pages (primarily prose restructuring, heading/list formatting, and added frontmatter keywords) to improve readability and consistency.

Changes:

• Added keywords metadata and expanded/clarified introductory copy across the tables docs.
• Reformatted notes, lists, and section structure for improved scanability.
• Minor wording updates throughout examples and procedural steps.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
models/tables/evaluate-models.mdx	Adds keywords and restructures Weave/Tables evaluation sections and bullets.
models/tables/log_tables.mdx	Adds keywords and rewrites intro + logging mode explanations for clarity.
models/tables/tables-download.mdx	Adds keywords and rewrites export steps and “Next steps” section.
models/tables/tables-gallery.mdx	Adds keywords and reorganizes/rewrites gallery intro and section headings.
models/tables/tables-walkthrough.mdx	Adds keywords and rewrites Quickstart framing and step descriptions.
models/tables/visualize-tables.mdx	Adds keywords and rewrites comparison/stepper sections and note formatting.

Comments suppressed due to low confidence (1)

models/tables/evaluate-models.mdx:111

• The llm_judge_scorer example uses await judge_model.predict(...) inside a regular def, which is invalid Python syntax. The function should be declared async def if it awaits.

@weave.op()
def llm_judge_scorer(expected: str, output: str, judge_model) -> dict:
    prompt = f"Is this answer correct? Expected: {expected}, Got: {output}"
    judgment = await judge_model.predict(prompt)
    return {"judge_score": judgment}

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[johndmulhausen]

Review feedback addressed in 7910ed9

Thanks for the reviews. All Copilot comments are incorporated:

File	Fix
log_tables.mdx	Broken intro anchors → #create-and-log-a-table, #logging-modes
visualize-tables.mdx	#custom-step-keys → #custom-step-key
tables-download.mdx	Prose now matches code: artifact.add(table, "my_table") + artifact.get("my_table")
tables-walkthrough.mdx	Dropped the unfulfilled "query" promise from the intro
evaluate-models.mdx	llm_judge_scorer is now async def so its await is valid Python

Re: the suppressed low-confidence comment on evaluate-models.mdx:111 (await inside a non-async def) — that one was correct, so I applied it. judge_model.predict mirrors the async def predict defined earlier on the page, so the scorer has to be async def.

PR title — resolved earlier (rescoped to models/tables).

Two related items I left alone (your call)

1. Pre-existing dangling reference in tables-walkthrough.mdx:9: "Select the button below to try a PyTorch Quickstart example project on MNIST data." — there is no button/<Card> and there never has been (traces back to the Mintlify import in Mintlify import #1727). It is out of scope for this style pass and I did not want to guess the intended target. Easy follow-ups: drop the sentence, or add a <Card> linking to the Tables Quickstart Colab.
2. Localized mirrors (ja/, ko/, fr/) carry the same broken anchors I just fixed in English. I left them to the translation-sync pipeline since hand-editing localized files in a style PR tends to fight that automation — flagging in case it needs a manual nudge.