Create a report

Create a W&B Report with the W&B App or programmatically.

W&B Report and Workspace API is in Public Preview.

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.

See this Google Colab for an example on how to programmatically create a report.

W&B App

1. Navigate to your project workspace in the W&B App.

2. Click Create report in the upper right corner of your workspace.

   

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.

   

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.

Report tab

1. Navigate to your project workspace in the W&B App.

2. Select to the Reports tab (clipboard image) in your project.

3. Select the Create Report button on the report page.

   

Report and Workspace API

Create a report programmatically:

1. Install W&B SDK (wandb) and Report and Workspace API (wandb-workspaces):

   pip install wandb wandb-workspaces
   

2. Next, import workspaces

   import wandb
   import wandb_workspaces.reports.v2 as wr
   

3. Create a report with wandb_workspaces.reports.v2.Report. Create a report instance with the Report Class Public API (wandb.apis.reports). Specify a name for the project.

   report = wr.Report(project="report_standard")
   

4. Save the report. Reports are not uploaded to the W&B server until you call the .save() method:

   report.save()
   

For information on how to edit a report interactively with the App UI or programmatically, see Edit a report.