Documentation
Search…
Collaborative Reports
Project management and collaboration tools for machine learning projects
Reports let you organize and embed visualizations, describe your findings, share updates with collaborators, and more.
Check out our video demo of Reports, or read curated Reports in W&B Fully Connected.

Typical use cases for reports

  1. 1.
    Notes: Add a graph with a quick note to yourself.
  2. 2.
    Collaboration: Share findings with your colleagues.
  3. 3.
    Work log: Track what you've tried and plan next steps.

Notes: Add a visualization with a quick summary

Capture an important observation, an idea for future work, or a milestone reached in the development of a project. All experiment runs in your report will link to their parameters, metrics, logs, and code, so you can save the full context of your work.
Jot down some text and pull in relevant charts to illustrate your insight (comparing networks in distributed training → )
Save the best examples from a complex code base for easy reference and future interaction (example: LIDAR point clouds → )

Collaboration: Share findings with your colleagues

Explain how to get started with a project, share what you've observed so far, and synthesize the latest findings. Your colleagues can make suggestions or discuss details using comments on any panel or at the end of the report.
Include dynamic settings so that your colleagues can explore for themselves, get additional insights, and better plan their next steps. In this example, three types of experiments can be visualized independently, compared, or averaged (SafeLife benchmark experiments →).
Use sliders and configurable media panels to showcase a model's results or training progress (example → StarGANv2)

Work log: Track what you've tried and plan next steps

Write down your thoughts on experiments, your findings, and any gotchas and next steps as you work through a project, keeping everything organized in one place. This lets you "document" all the important pieces beyond your scripts (example: tuning transformers →).
Tell the story of a project, which you and others can reference later to understand how and why a model was developed (example → The View from the Driver's Seat)
Once you have experiments in W&B, easily visualize results in reports. Here's a quick overview video.

How to create a report

You can create a new report from a workspace, or directly from the report tab in a project.‌‌

1. Create a report from a workspace

Click Create report in the upper right corner of your workspace. This gives you a way to pull in some charts from the page to use in your new custom page.
We provide a few quick templates to guide you or you can create a blank report and start there.‌
  • Snapshot adds the current date/time to the title, and adds a filter to the run set, which means only runs created before the current time are included in the snapshot.
  • Dashboard titles the report “Project Dashboard” and adds a filter to match exactly the current set of selected runs.
  • Update titles the report “<today’s date> Project Update” and filters to the exact set of runs that were selected in the workspace.
  • Blank gives you the space to add a fresh panel grid and visualizations, or just write some notes to yourself.

2. From the report tab‌

Go to the Reports tab in your project, and click Create Report button on the report page. This creates a new blank report. Save that report to get a shareable link, or send charts to the report from different workspaces, and even different projects!

How to edit a report

Add charts to a report

Again press /, then add a panel grid, then add a panel (like a line plot, scatter plot, or parallel coordinates chart). Each panel grid has a set of run sets and a set of panels. The run sets at the bottom of the section control what data shows up on the panels in the grid. Create a new panel grid if you want to add charts that pull data from a different set of runs.

Duplicate and delete panel grids

If you have a good layout that you'd like to reuse, you can select a panel grid and copy-paste it to duplicate it in the same report, or even paste it into a different report.
As you can see in the gif below, you can highlight a whole panel grid section by clicking the drag handle in the upper right corner. You can also click and drag to highlight and select a region in a report, which can include panel grids, text, and headings.
To delete a panel grid, simply select it and press delete on your keyboard.

Collaborate on reports

Once you've saved a report, you can click the Share button to collaborate. Make sure the visibility settings on your project allow your collaborators to access the report— you'll need an open project or a team project to share a report that you can edit together.
When you press edit, you'll be editing a draft copy of the report. This draft auto-saves, and when you press Save to report you'll be publishing your changes to the shared report.
If one of your collaborators has edited the report in the meantime, you'll get a warning to help you resolve potential edit conflicts.

Comment on reports

Click the comment button on a panel in a report to add a comment directly to that panel.

Panel grids

If you'd like to compare a different set of runs, create a new panel grid. Each section's graphs are controlled by the Run Sets at the bottom of that section.

Run sets

  • Dynamic run sets: If you start from "Visualize all" and filter or deselect runs to visualize, the run set will automatically update to show any new runs that match the filters.
  • Static run sets: If you start from "Visualize none" and select the runs you want to include in your run set, you will only ever get those runs in the run set. No new runs will be added.
  • Defining keys: If you have multiple Run Sets in a section, the columns are defined by the first run set. To show different keys from different projects, you can click "Add Panel Grid" to add a new section of graphs and run sets with that second set of keys. You can also duplicate a grid section.

Exporting reports

Click the download button to export your report as a LaTeX zip file. Check the README.md in your downloaded folder to find instructions on how to convert this file to PDF. It's easy to upload the zip file to Overleaf to edit the LaTeX.

Cross-project reports

Compare runs from two different projects with cross-project reports. Use the project selector in the run set table to pick a project.
The visualizations in the section pull columns from the first active runset. If you're not seeing 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. This feature supports history data on time series lines, but we don't support pulling different summary metrics from different projects— so a scatter plot wouldn't work for columns that are only logged in another project.
If you really 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'll still be able to filter to just the runs from each project, but you'll have all the columns for both sets of runs available in the report.
Share a view-only link to a report that is in a private project or team project.
View-only report links add a secret access token to the URL, so anyone who opens the link can view the page. For customers on W&B Local private cloud installations, these links will still be behind your firewall, so only members of your team with access to your private instance and access to the view-only link will be able to view the report.
In view 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 on a run to get to the run page.

Send a graph 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.

Last modified 9d ago