Skip to main content
App version: 3.4.8

Reports in Neptune

A report is a customizable analysis of specific runs in your project.

Dashboard or report?

Both dashboards and reports help you analyze runs and their metadata through detailed and customizable views. Choose which one better answers your needs:

Dashboard

  • Ideal for analyzing the ongoing experiments.
  • You can compare experiments within one project.
  • Dashboard configuration applies to the runs that are currently made visible by a person viewing the dashboard.

Report

  • Ideal for analyzing the final results of experiments.
  • You can compare experiments from multiple projects.
  • You can select visible runs for people who view the report.
  • You can add comments and extra resources such as links or images.

Example of a report in Neptune

Access reports​

To access reports, select Reports in the left panel of the Neptune app.

Your work is grouped into two categories:

  • Private drafts – reports that are work in progress and visible only to you.
  • Published reports – finished reports that are visible to other users.

Create a report​

There are three ways to create a report:

Related

Publish a report​

When you create a report, it's automatically saved as your private draft. To make a report available to other users, publish it.

There are two ways to publish a report:

  • In the editing mode, select Publish.
  • In the Reports section, from the private draft menu (), select Publish changes.

Duplicate a report​

You can create copies of an existing report and modify them without impacting the original.

You can also copy reports between projects that belong to different workspaces. Note that you need at least the viewer role in the source project and at least the contributor role in the target project.

To duplicate a report:

  1. From the report menu (), select Duplicate report.
  2. From the dropdown, select the target project.

The copied report is saved as your private draft. To make it available to other users, publish the report.

Edit a report​

To edit an already published report, switch to the editing mode.

There are three ways to access the editing mode:

  • In the Reports section, from the report menu (), select Edit draft or Create new draft.
  • In the Reports section, hover over a report name and select Edit draft or Create new draft.
  • When viewing a report, in the toolbar, switch from Viewing to Editing.

The changes that you make in the editing mode are saved as a draft. Publish the draft to create a new version of the report and make your changes visible to other users.

Versioning​

Each time you make changes to a report and publish them, you create a report version.

Access version history​

To view all versions of a report:

  1. Switch to the viewing mode.
  2. From the report menu (), select Version Control.

Edit and share versions​

In the version history, hover over a version and open its options () to access the following actions:

  • Copy and share a link to a selected version
  • Edit version name and description
  • Restore an older version of a report

Viewing mode​

In the viewing mode, you can interact with an already published report without modifying it.

Edit chart widget settings​

You can configure settings to apply across all charts in the report. Use Controls in the top toolbar to modify the following:

note

These settings apply to all chart widgets in the report and are stored by your browser. To let other users see your changes, switch the mode to Editing and save the version as a draft.

Export chart widgets in bulk​

You can export and download multiple chart widgets at once.

To select a chart widget, click the check box next to the chart title. You have the following options:

  • copy selected charts to clipboard
  • download selected charts as a single PNG image
  • duplicate selected charts to a new or existing report

Filter widgets by name​

To filter widgets by their name, use the search. Regular expressions are supported.

Select runs to include​

To choose which runs to show, in the bottom table pane, click the eye icons ().

  • To select an entire set of runs, click the eye icon () on the tab.
  • To access display shortcuts, click the eye icon on the table header row.

To learn more about displaying runs, see Analyze runs: Select which runs are visible.

note

In viewing mode, the selected runs are stored by your browser. To let other users see your changes, switch the mode to Editing and save the version as a draft. For details, see Configure a report: Define run sets.