Skip to content

Commit 37769c9

Browse files
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

models/reports/clone-and-export-reports.mdx

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,37 @@
11
---
22
description: "Export W&B Reports as PDF or LaTeX files, and clone reports using the App UI or the Report and Workspace API."
33
title: Clone and export reports
4+
keywords: ["export report", "clone report", "PDF", "LaTeX", "Report and Workspace API"]
45
---
56

67
<Note>
78
W&B Report and Workspace API is in Public Preview.
89
</Note>
910

10-
## Export reports
11+
This page describes how to export a W&B Report to a portable file format. It also describes how to clone an existing report to reuse its structure as a starting point for new work.
1112

12-
Export a report as a PDF or LaTeX. Within your report, select the **action (<Icon icon="ellipsis-vertical" iconType="solid"/>)** menu to expand the dropdown menu. Choose **Download and** select either PDF or LaTeX output format.
13+
## Export a report
1314

14-
## Cloning reports
15+
Export a report as a PDF or LaTeX file to share its contents outside of W&B or to archive a static version of your analysis. In your report, select the **action (<Icon icon="ellipsis-vertical" iconType="solid"/>)** menu. Choose **Download** and select either PDF or LaTeX output format.
16+
17+
## Clone a report
18+
19+
Clone a report to reuse an existing project's template and formatting as the basis for a new report. You can clone reports in the W&B App UI or programmatically with the Report and Workspace API.
1520

1621
<Tabs>
1722
<Tab title="W&B App">
18-
Within your report, select the **action (<Icon icon="ellipsis-vertical" iconType="solid"/>)** menu to expand the dropdown menu. Choose the **Clone this report** button. Pick a destination for your cloned report in the modal. Choose **Clone report**.
23+
In your report, select the **action (<Icon icon="ellipsis-vertical" iconType="solid"/>)** menu. Choose **Clone this report**. In the modal, pick a destination for your cloned report. Choose **Clone report**.
1924

2025
<Frame>
2126
<img src="/images/reports/clone_reports.gif" alt="Cloning reports" />
2227
</Frame>
2328

24-
Clone a report to reuse a project's template and format. Cloned projects are visible to your team if you clone a project within the team's account. Projects cloned within an individual's account are only visible to that user.
29+
When you clone a report, you specify the destination. If you clone it to a team, all team members can view it. If you clone it to your personal account, only you can view it by default.
2530
</Tab>
2631
<Tab title="Report and Workspace API">
27-
Load a Report from a URL to use it as a template.
32+
Use the Report and Workspace API to load an existing report from its URL and reuse it as a template for a new report.
33+
34+
Load a report from a URL to use it as a template. Replace `PROJECT` with the name of your W&B project.
2835

2936
```python
3037
report = wr.Report(
@@ -34,7 +41,7 @@ report.save() # Save
3441
new_report = wr.Report.from_url(report.url) # Load
3542
```
3643

37-
Edit the content within `new_report.blocks`.
44+
After you load the report, edit the content in `new_report.blocks` to customize the cloned report, then save it. Replace `ENTITY` with your W&B entity name.
3845

3946
```python
4047
pg = wr.PanelGrid(
Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,44 @@
11
---
22
description: Collaborate and share W&B Reports with peers, co-workers, and your team.
33
title: Collaborate on reports
4+
keywords: ["share report", "report comments", "star report", "report collaboration", "edit conflict"]
45
---
56

6-
This page describes various ways to collaborate on reports with your team.
7+
This page describes ways to collaborate on reports with your team. Use these workflows to share results, gather feedback, and keep important reports accessible.
8+
9+
You can share a report, edit it collaboratively, add comments, or star it for quick access.
710

811
## Share a report
9-
When viewing a report, click **Share**, then:
10-
- To share a link to the report with an email address or a username, click **Invite**. Enter an email address or username, select **Can view** or **Can edit**, then click **Invite**. If you share by email, the email address does not need to be a member of your organization or team.
12+
13+
When viewing a report, click **Share**. You can share a report in one of the following ways:
14+
15+
- To share a link to the report with an email address or a username, click **Invite**. Enter an email address or username, select **Can view** or **Can edit**, then click **Invite**. If you share by email, the email address doesn't need to be a member of your organization or team.
1116
- To generate a sharing link instead, click **Share**. Adjust the permissions for the link, then click **Copy report link**. Share the link with the member.
1217

13-
When viewing the report, click a panel to open it in full-screen mode. If you copy the URL from the browser and share it with another user, when they access the link the panel will open directly in full-screen mode.
18+
When viewing the report, click a panel to open it in full-screen mode. If you copy the URL from the browser and share it with another user, the panel opens directly in full-screen mode when they access the link.
1419

1520
## Edit a report
16-
When any team member clicks the **Edit** button to begin editing the report, a draft is automatically saved. Select **Save to report** to publish your changes.
1721

18-
If an edit conflict occurs, such as when two team members edit the report at once, a warning notification helps you to resolve any conflicts.
22+
Multiple team members can edit the same report and publish changes when they're ready. When any team member clicks the **Edit** button to begin editing the report, W&B automatically saves a draft. Select **Save to report** to publish your changes.
23+
24+
If an edit conflict occurs, such as when two team members edit the report at once, a warning notification helps you resolve any conflicts.
1925

2026
<Frame>
21-
<img src="/images/reports/share-report.gif" alt="Report sharing modal for a report in a 'Public' project" max-width="90%" />
27+
<img src="/images/reports/share-report.gif" alt="Report sharing modal for a report in a 'Public' project" max-width="90%" />
2228
</Frame>
2329

2430
## Comment on reports
25-
Click **Comment** to leave a comment on a report.
2631

27-
To comment directly on a panel, hover over the panel, then click the comment button, which looks like a speech bubble.
32+
To leave a comment on a report, click **Comment**.
33+
34+
To comment directly on a panel, hover over the panel, then click the comment button (<Icon icon="comment" iconType="regular"/>).
2835

2936
<Frame>
30-
<img src="/images/reports/demo_comment_on_panels_in_reports.gif" alt="Adding a comment to a panel" />
37+
<img src="/images/reports/demo_comment_on_panels_in_reports.gif" alt="Adding a comment to a panel" />
3138
</Frame>
3239

3340
## Star a report
34-
If your team has a large number of reports, click **Star** at the top of a report to add it to your favorites. When viewing your team's list of reports, click the star in a report's row to add it to your favorites. Starred reports appear at the top of the list.
3541

36-
From the list of reports, you can see how many members have starred each report to gauge its relative popularity.
42+
If your team has many reports, click the open star icon (<Icon icon="star" iconType="regular"/>) at the top of a report to add it to your favorites. To remove the star, click the closed star icon (<Icon icon="star" iconType="solid"/>). When viewing your team's list of reports, click the open star in a report's row to add it to your favorites. Starred reports appear at the top of the list.
43+
44+
From the list of reports, you can see how many members have starred each report to gauge its popularity.

models/reports/create-a-report.mdx

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,42 @@
11
---
22
description: Create a W&B Report with the W&B App or programmatically.
33
title: Create a report
4+
keywords: ["create report", "wandb-workspaces", "Report API", "programmatic reports"]
45
---
56

67
<Note>
78
W&B Report and Workspace API is in Public Preview.
89
</Note>
910

10-
Select a tab below to learn how to create a report in the W&B App or programmatically with the W&B Report and Workspace API.
11+
Select a tab to learn how to create a report in the W&B App or programmatically with the Report and Workspace API.
1112

12-
See this [Google Colab](https://colab.research.google.com/github/wandb/examples/blob/master/colabs/intro/Report_API_Quickstart.ipynb) for an example on how to programmatically create a report.
13+
For an example of how to programmatically create a report, see this [Google Colab](https://colab.research.google.com/github/wandb/examples/blob/master/colabs/intro/Report_API_Quickstart.ipynb).
1314

1415

1516
<Tabs>
1617
<Tab title="W&B App">
1718
1. Navigate to your project workspace in the W&B App.
18-
2. Click **Create report** in the upper right corner of your workspace.
19+
2. In the upper-right corner of your workspace, click **Create report**.
1920

2021
<Frame>
21-
<img src="/images/reports/create_a_report_button.png" alt="Create report button" />
22+
<img src="/images/reports/create_a_report_button.png" alt="Create report button" />
2223
</Frame>
2324

24-
3. A modal will appear. Select the charts you would like to start with. You can add or delete charts later from the report interface.
25+
3. A modal appears. Select the charts you want to start with. You can add or delete charts later from the report interface.
2526

2627
<Frame>
27-
<img src="/images/reports/create_a_report_modal.png" alt="Create report modal" />
28+
<img src="/images/reports/create_a_report_modal.png" alt="Create report modal" />
2829
</Frame>
2930

30-
4. Select the **Filter run sets** option to prevent new runs from being added to your report. You can toggle this option on or off. Once you click **Create report,** a draft report will be available in the report tab to continue working on.
31+
4. Select the **Filter run sets** option to prevent new runs from being added to your report. You can toggle this option on or off. A draft report is saved automatically. Access it in the **Reports** tab.
3132
</Tab>
3233
<Tab title="Report tab">
3334
1. Navigate to your project workspace in the W&B App.
34-
2. Select to the **Reports** tab (clipboard image) in your project.
35-
3. Select the **Create Report** button on the report page.
35+
2. Select the **Reports** tab in your project.
36+
3. Click **Create report**.
3637

3738
<Frame>
38-
<img src="/images/reports/create_report_button.png" alt="Create report button" />
39+
<img src="/images/reports/create_report_button.png" alt="Create report button" />
3940
</Frame>
4041
</Tab>
4142
<Tab title="Report and Workspace API">
@@ -45,21 +46,21 @@ Create a report programmatically:
4546
```bash
4647
pip install wandb wandb-workspaces
4748
```
48-
2. Next, import workspaces
49+
2. Import the W&B Python SDK and the Report and Workspace API.
4950
```python
5051
import wandb
5152
import wandb_workspaces.reports.v2 as wr
52-
```
53-
3. Create a report with `wandb_workspaces.reports.v2.Report`. Create a report instance with the Report Class Public API ([`wandb.apis.reports`](/models/ref/python/public-api/api#reports)). Specify a name for the project.
53+
```
54+
3. Create a report with `wandb_workspaces.reports.v2.Report`. Create a report instance with the Report Class Public API ([`wandb.apis.reports`](/models/ref/python/public-api/api#reports)). Specify a name for the project.
5455
```python
5556
report = wr.Report(project="report_standard")
56-
```
57+
```
5758

58-
4. Save the report. Reports are not uploaded to the W&B server until you call the .`save()` method:
59+
4. Save the report. Reports aren't uploaded to W&B until you call the `.save()` method:
5960
```python
6061
report.save()
6162
```
6263

63-
For information on how to edit a report interactively with the App UI or programmatically, see [Edit a report](/models/reports/edit-a-report/).
64+
For more information, see [Edit a report](/models/reports/edit-a-report).
6465
</Tab>
6566
</Tabs>
Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,41 @@
11
---
22
description: Compare runs from two different projects with cross-project reports.
33
title: Compare runs across projects
4+
keywords: ["magic link", "view-only report", "run set", "share report", "project selector"]
45
---
56
<Note>
67
Watch a [video demonstrating comparing runs across projects](https://www.youtube.com/watch?v=uD4if_nGrs4) (2 min).
78
</Note>
89

910

10-
Compare runs from two different projects with cross-project reports. Use the project selector in the run set table to pick a project.
11+
Cross-project reports let you compare runs from two different projects side by side, which is useful when you want to evaluate experiments tracked under separate W&B projects without duplicating data. Use the project selector in the run set table to pick a project.
1112

1213
<Frame>
1314
<img src="/images/reports/howto_pick_a_different_project_to_draw_runs_from.gif" alt="Compare runs across different projects" />
1415
</Frame>
1516

16-
The visualizations in the section pull columns from the first active runset. Make sure that the first run set checked in the section has that column available if you do not see the metric you are looking for in the line plot.
17+
The visualizations in the section pull columns from the first active run set. If you don't see the metric you're looking for in the line plot, make sure that the first run set checked in the section has that column available.
1718

18-
This feature supports history data on time series lines, but we don't support pulling different summary metrics from different projects. In other words, you can not create a scatter plot from columns that are only logged in another project.
19+
This feature supports history data on time series lines, but doesn't support pulling different summary metrics from different projects. In other words, you can't create a scatter plot from columns that are only logged in another project.
1920

20-
If you need to compare runs from two projects and the columns are not working, add a tag to the runs in one project and then move those runs to the other project. You can still filter only the runs from each project, but the report includes all the columns for both sets of runs.
21+
If you need to compare runs from two projects and the columns aren't working, add a tag to the runs in one project and then move those runs to the other project. You can still filter only the runs from each project, but the report includes all the columns for both sets of runs.
2122

2223
## View-only report links
2324

24-
Share a view-only link to a report that is in a private project or team project.
25+
When you need to share a report with someone outside your project (such as a stakeholder who doesn't have a W&B account), use a view-only link. Share a view-only link to a report that is in a private project or team project.
2526

2627
<Frame>
2728
<img src="/images/reports/magic-links.gif" alt="View-only report links" />
2829
</Frame>
2930

3031
View-only report links add a secret access token to the URL, so anyone who opens the link can view the page. Anyone can use the magic link to view the report without logging in first. For customers on [W&B Local](/platform/hosting/) private cloud installations, these links remain behind your firewall, so only members of your team with access to your private instance _and_ access to the view-only link can view the report.
3132

32-
In **view-only mode**, someone who is not logged in can see the charts and mouse over to see tooltips of values, zoom in and out on charts, and scroll through columns in the table. When in view mode, they cannot create new charts or new table queries to explore the data. View-only visitors to the report link won't be able to click a run to get to the run page. Also, the view-only visitors would not be able to see the share modal but instead would see a tooltip on hover which says: `Sharing not available for view only access`.
33+
In **view-only mode**, someone who isn't logged in can see the charts and mouse over to see tooltips of values, zoom in and out on charts, and scroll through columns in the table. When in view mode, they can't create new charts or new table queries to explore the data. View-only visitors to the report link can't click a run to get to the run page. Also, view-only visitors can't see the share modal. Instead, they see a tooltip on hover that says: `Sharing not available for view only access`.
3334

3435
<Info>
35-
The magic links are only available for Private and Team projects. For Public (anyone can view) or Open (anyone can view and contribute runs) projects, the links can't turn on/off because this project is public implying that it is already available to anyone with the link.
36+
The magic links are only available for "Private" and "Team" projects. For "Public" (anyone can view) or "Open" (anyone can view and contribute runs) projects, you can't turn the links on or off because the project is public, meaning it's already available to anyone with the link.
3637
</Info>
3738

3839
## Send a graph to a report
3940

40-
Send a graph from your workspace to a report to keep track of your progress. Click the dropdown menu on the chart or panel you'd like to copy to a report and click **Add to report** to select the destination report.
41+
If you want to preserve a chart from a workspace alongside related analysis, you can send it directly to a report. Send a graph from your workspace to a report to keep track of your progress. Click the dropdown menu on the chart or panel you'd like to copy to a report and click **Add to report** to select the destination report.

0 commit comments

Comments
 (0)