Reports in Neptune
A report is a customizable analysis of specific runs in your project. To access reports, select Reports in the left panel.
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.
Create a report
There are three ways to create a report:
- Create an empty report, then add and configure widgets
- Export an existing dashboard
- Export an existing chart view
Selecting runs to include
To choose which runs to show, in the bottom table pane, click the eye icons ().
- To select an entire group 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.
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 groups.
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:
- Switch to the viewing mode.
- In the top toolbar, click button.
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:
- Apply smoothing
- Change axis settings
- Change X-axis values
- Filter displayed data based on step
- Show or hide inherited metrics
- Use one color by group
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.
Filter widgets by name
To filter widgets by their name, use the search. Regular expressions are supported.