Commit 37769c9
authored
style: apply /style-guide pass to models/reports (#2687)
## Summary
This PR applies the `/style-guide` skill (Google Developer Style Guide +
CoreWeave conventions) to documentation under `models/reports`. The run
was automated and contains style-only edits across 7 files.
## Files edited
- `models/reports/clone-and-export-reports.mdx`
- `models/reports/collaborate-on-reports.mdx`
- `models/reports/create-a-report.mdx`
- `models/reports/cross-project-reports.mdx`
- `models/reports/edit-a-report.mdx`
- `models/reports/embed-reports.mdx`
- `models/reports/reports-gallery.mdx`
## Recommendations for technical review
### Prerequisites
- Add a Prerequisites section (or links) to most pages covering: W&B
account/login (`wandb login`), `wandb` and `wandb-workspaces` package
install, the canonical import statement (`import
wandb_workspaces.reports.v2 as wr`), and required SDK versions for the
Report and Workspace API (`clone-and-export-reports.mdx`,
`create-a-report.mdx`, `edit-a-report.mdx`, `embed-reports.mdx`).
- Document the role/seat/permissions needed to clone a report into a
team vs. individual account, edit a published report, and share with
external (non-org) recipients (`clone-and-export-reports.mdx`,
`collaborate-on-reports.mdx`, `edit-a-report.mdx`).
- Define or link out to W&B concepts referenced without context: W&B
Local, project visibility types (Private/Team/Public/Open), run sets
(`cross-project-reports.mdx`).
- Link to a "Create a report" prerequisite from `embed-reports.mdx` and
`clone-and-export-reports.mdx` for readers who don't yet have a report.
### Verification steps
- Add success/confirmation cues after major procedures: where the
saved/cloned report appears, how to find it, what `report.url` returns,
and noting that `report.url` is populated only after `report.save()`
(`clone-and-export-reports.mdx`, `create-a-report.mdx`,
`edit-a-report.mdx`).
- Add guidance on confirming an export succeeded (where the PDF/LaTeX
file lands, browser behavior) in `clone-and-export-reports.mdx`.
- Document the UI path for generating a view-only/magic link in
`cross-project-reports.mdx`.
- Add brief "what success looks like" sentences to each embed flow
(Confluence, Notion, HTML, Gradio) in `embed-reports.mdx`, and
confirmation cues for share/invite/save actions in
`collaborate-on-reports.mdx`.
### Technical accuracy
- Confirm the Public Preview status of the Report and Workspace API
callout in `clone-and-export-reports.mdx`.
- Verify the current W&B App click paths and that referenced GIFs still
match the UI: action menu → **Download** → PDF/LaTeX and action menu →
**Clone this report** → **Clone report**
(`clone-and-export-reports.mdx`); `share-report.gif` placement
(`collaborate-on-reports.mdx`); collapse-header behavior
(`edit-a-report.mdx`).
- Confirm UI labels are current and use consistent casing/bolding:
**Create report** (sentence case), **Add to report**,
**Share**/**Invite**, **view-only mode**, project visibility labels
Private/Team/Public/Open (`create-a-report.mdx`,
`cross-project-reports.mdx`, `collaborate-on-reports.mdx`).
- Verify the API surface in code samples (`wr.Report`,
`wr.Report.from_url`, `wr.PanelGrid`, `wr.Runset` vs. `wr.RunSet`
casing, `wr.LinePlot`, `wr.BarPlot`, `wr.MediaBrowser`,
`wr.RunComparer`, `wr.H1`) and whether the older `wandb.apis.reports`
Public API referenced alongside `wandb_workspaces.reports.v2.Report` is
still recommended (`clone-and-export-reports.mdx`,
`create-a-report.mdx`, `edit-a-report.mdx`).
- Confirm the exact "Add run sets" parameter name (`runsets` vs. "`run
sets`") and `Tags` filter syntax (`Tags('training') == 'training'` vs.
`Metric('tags') in [...]`) in `edit-a-report.mdx`.
- Verify the Colab notebook link in `edit-a-report.mdx` — URL contains
`Update-wandb-workspaces-tuturial` (likely a typo).
- Confirm `PROJECT` and `ENTITY` should appear as bare identifiers vs.
quoted strings in code snippets, and that "W&B entity" is the correct
user-facing term (username vs. team) (`clone-and-export-reports.mdx`).
- Verify the active-voice rewrite "W&B automatically saves a draft" —
confirm W&B (server-side) is the actor, not the browser/client
(`collaborate-on-reports.mdx`).
- Confirm that the second **Share** bullet under "Share a report"
requires clicking the outer **Share** button first, or whether labels
have changed (`collaborate-on-reports.mdx`).
- Confirm that the W&B Local access-control sentence still accurately
describes private-instance behavior with view-only links
(`cross-project-reports.mdx`).
- Verify embed claims in `embed-reports.mdx`: **Share** button location
(upper right), that **Copy embed code** returns a full `<iframe>`
snippet, that "only public reports are viewable when embedded" remains
absolute (no embed-token/signed-URL support), current Confluence macro
name (`iframe cell` may be stale), current Notion **Embed** block label,
that the Gradio sample URL still resolves, that `gr.HTML` is still
current, and whether the unclosed `<iframe>` in the Gradio sample is
intentional.
- Verify external/example links in `reports-gallery.mdx` still resolve
and demonstrate the described capabilities: Inception-ResNet-V2, StarGAN
v2, LIDAR, SafeLife, the `bit.ly/wandb-learning-dexterity` shortlink,
and the OpenAI Robotics report. Confirm the published display title for
"What To Do When Inception-ResNet-V2 Is Too Slow."
### Missing content
- Link to the Report and Workspace API reference for `wr.Report`,
`wr.PanelGrid`, `wr.Runset`, panel constructors, and block types;
briefly explain what `report.blocks` is and which block types are valid
(`clone-and-export-reports.mdx`, `edit-a-report.mdx`).
- Document export limitations: size limits, whether interactive panels
are flattened in PDF/LaTeX, image/asset handling, and PDF vs. LaTeX
formatting caveats (`clone-and-export-reports.mdx`).
- Add a one-line conceptual anchor or link to a "What is a W&B Report?"
page near the top of pages that reference Reports without defining them
(`create-a-report.mdx`, `reports-gallery.mdx`).
- Note the next state after clicking **Create report** in the "Report
tab" tab — particularly whether it opens the same chart-selection modal
as the W&B App tab (`create-a-report.mdx`).
- Consider replacing the removed "(clipboard image)" parenthetical with
a screenshot if a visual cue helps locate the **Reports** tab
(`create-a-report.mdx`).
- Promote the history-data limitation to a `<Note>` or `<Warning>`, and
the tag/move workaround to its own subheading (and verify the workaround
is current) in `cross-project-reports.mdx`.
- Show how to attach a `runset` built via `Group runs by summary
metrics`, `SummaryMetric filters`, and `Tags filters` to a report;
document whether SoundCloud has an embed class to match the App UI tab;
add a written procedure (not just a GIF) for collapsing headers
(`edit-a-report.mdx`).
- Relocate the public-only embed `<Note>` to the page intro of
`embed-reports.mdx` since it applies to all embed methods; add written
procedural steps to accompany the Confluence and Notion GIFs; add a link
explaining how to make a report public; add a comment in the Gradio
sample indicating readers should substitute their own report URL.
- In `reports-gallery.mdx`, decide whether to keep the "Label:
Description" H2 pattern or simplify, and harmonize line 68's link
phrasing ("See [The View from the Driver's Seat] report for how you can
report your findings.") with the parallel "See the [Title] report for an
example of how..." pattern used elsewhere.
- Consider moving the inline `# Create`, `# Save`, `# Load` comments in
`clone-and-export-reports.mdx` into surrounding prose if the goal is
pedagogy rather than copy-pastable code.
## 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.1 parent 2e67933 commit 37769c9
7 files changed
Lines changed: 177 additions & 147 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | 7 | | |
7 | 8 | | |
8 | 9 | | |
9 | 10 | | |
10 | | - | |
| 11 | + | |
11 | 12 | | |
12 | | - | |
| 13 | + | |
13 | 14 | | |
14 | | - | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
15 | 20 | | |
16 | 21 | | |
17 | 22 | | |
18 | | - | |
| 23 | + | |
19 | 24 | | |
20 | 25 | | |
21 | 26 | | |
22 | 27 | | |
23 | 28 | | |
24 | | - | |
| 29 | + | |
25 | 30 | | |
26 | 31 | | |
27 | | - | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
28 | 35 | | |
29 | 36 | | |
30 | 37 | | |
| |||
34 | 41 | | |
35 | 42 | | |
36 | 43 | | |
37 | | - | |
| 44 | + | |
38 | 45 | | |
39 | 46 | | |
40 | 47 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | | - | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
7 | 10 | | |
8 | 11 | | |
9 | | - | |
10 | | - | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
11 | 16 | | |
12 | 17 | | |
13 | | - | |
| 18 | + | |
14 | 19 | | |
15 | 20 | | |
16 | | - | |
17 | 21 | | |
18 | | - | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
19 | 25 | | |
20 | 26 | | |
21 | | - | |
| 27 | + | |
22 | 28 | | |
23 | 29 | | |
24 | 30 | | |
25 | | - | |
26 | 31 | | |
27 | | - | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
28 | 35 | | |
29 | 36 | | |
30 | | - | |
| 37 | + | |
31 | 38 | | |
32 | 39 | | |
33 | 40 | | |
34 | | - | |
35 | 41 | | |
36 | | - | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | 7 | | |
7 | 8 | | |
8 | 9 | | |
9 | 10 | | |
10 | | - | |
| 11 | + | |
11 | 12 | | |
12 | | - | |
| 13 | + | |
13 | 14 | | |
14 | 15 | | |
15 | 16 | | |
16 | 17 | | |
17 | 18 | | |
18 | | - | |
| 19 | + | |
19 | 20 | | |
20 | 21 | | |
21 | | - | |
| 22 | + | |
22 | 23 | | |
23 | 24 | | |
24 | | - | |
| 25 | + | |
25 | 26 | | |
26 | 27 | | |
27 | | - | |
| 28 | + | |
28 | 29 | | |
29 | 30 | | |
30 | | - | |
| 31 | + | |
31 | 32 | | |
32 | 33 | | |
33 | 34 | | |
34 | | - | |
35 | | - | |
| 35 | + | |
| 36 | + | |
36 | 37 | | |
37 | 38 | | |
38 | | - | |
| 39 | + | |
39 | 40 | | |
40 | 41 | | |
41 | 42 | | |
| |||
45 | 46 | | |
46 | 47 | | |
47 | 48 | | |
48 | | - | |
| 49 | + | |
49 | 50 | | |
50 | 51 | | |
51 | 52 | | |
52 | | - | |
53 | | - | |
| 53 | + | |
| 54 | + | |
54 | 55 | | |
55 | 56 | | |
56 | | - | |
| 57 | + | |
57 | 58 | | |
58 | | - | |
| 59 | + | |
59 | 60 | | |
60 | 61 | | |
61 | 62 | | |
62 | 63 | | |
63 | | - | |
| 64 | + | |
64 | 65 | | |
65 | 66 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
6 | 7 | | |
7 | 8 | | |
8 | 9 | | |
9 | 10 | | |
10 | | - | |
| 11 | + | |
11 | 12 | | |
12 | 13 | | |
13 | 14 | | |
14 | 15 | | |
15 | 16 | | |
16 | | - | |
| 17 | + | |
17 | 18 | | |
18 | | - | |
| 19 | + | |
19 | 20 | | |
20 | | - | |
| 21 | + | |
21 | 22 | | |
22 | 23 | | |
23 | 24 | | |
24 | | - | |
| 25 | + | |
25 | 26 | | |
26 | 27 | | |
27 | 28 | | |
28 | 29 | | |
29 | 30 | | |
30 | 31 | | |
31 | 32 | | |
32 | | - | |
| 33 | + | |
33 | 34 | | |
34 | 35 | | |
35 | | - | |
| 36 | + | |
36 | 37 | | |
37 | 38 | | |
38 | 39 | | |
39 | 40 | | |
40 | | - | |
| 41 | + | |
0 commit comments