Skip to main content
App version: 3.4.7

Configure a report

Visualize your metadata as a report by configuring widgets and customizing the display options.

A report in a viewing mode in the Neptune app.

Save general widget layout

To save a layout to use with any runs, create a dashboard instead of a report.

Add widgets

To add a widget to a report, click New widget in the top toolbar.

Supported widgets

In reports, you can use the following widget types:

Filter widgets by name

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

Create sections

With sections, you can organize widgets into titled, collapsible segments. Create a section, then drag existing widgets into it.

Define run sets

To specify which runs to show in the report, use the table view. To switch between run sets, create tabs with different configurations of visible runs, then visualize or hide the set as a whole.

If you change the runs, remember to publish your changes.

Use one color by set

To make all runs within a set to have the same color, change the global report settings:

  1. In the top toolbar, click Controls.

  2. Under Display settings & averaging:

    • In Style runs with, choose Color.
    • In Apply style per, choose Run set.

Include runs from other projects

To add runs from another project to the report, create a new set.

Runs and sets that originate from other projects are labeled as External.

note

People can only view the report data if they have at least viewer access to all of the projects included in the report.

Edit chart widget settings

Apart from customizing each chart widget individually, you can configure settings to apply across all charts of the report. Use Controls in the top toolbar to modify the following:

  • Apply smoothing
  • Change axis settings
  • Change X series
  • Filter displayed data based on step
  • Show or hide inherited metrics
  • Change display options

Change display options

By default, charts apply one color per run and one line style per metric.

You can change these settings to improve the visibility of your metadata. For example, if you compare multiple metrics across few runs, you might prefer to distinguish the metrics by color rather than the line style.

To change the display options for all chart widgets in the report:

  1. In the top toolbar, click Controls.

  2. Under Display settings & averaging, update the following settings:

    • In Style runs with, choose between Line style or Color.
    • In Apply style per, choose between Individual run or Run set.

The applied colors and line styles are reflected in the chart legend and the table view.

Rename report

To rename the report:

  1. In the editing mode, hover over the report name.
  2. Click the Edit icon.