User Guide

Contents

Work with Standalone HTML Reports

Export the interactive
Intel® Advisor
HTML reports that you can share or open on a remote machine using your web browser.

Offload Modeling HTML Reports

For
Offload Modeling
perspective,
Intel Advisor
enables you to export two types of HTML reports:
  • An interactive HTML report that represents results in the same structure as in graphical user interface (GUI) and enables you to switch between
    Offload Modeling
    and
    GPU Roofline Insights
    perspective results if you collect your data for an application running on GPU.
    You can export an interactive HTML report only using command line interface (CLI).
  • A legacy HTML report that enables you to view an extended set of metrics for your offloaded and non-offloaded code regions. This report also enables you to download configuration files used to model target accelerators and view execution logs for your application.
Export
Offload Modeling
HTML Reports
Intel Advisor
automatically saves both types of HTML reports when you run
Offload Modeling
perspective from CLI
. Once the execution is complete, you can find the reports stored in the following files:
  • <project-dir>/e<NNN>/report/advisor-report.html
    for interactive HTML report
  • <project-dir>/e<NNN>/report/report.html
    for legacy HTML report
If you run
Offload Modeling
perspective using GUI,
Intel Advisor
automatically saves the legacy report into the
<project-dir>/e<NNN>/report
directory.
Intel Advisor
enables you to export an interactive HTML report for results collected in the GUI using CLI. For example, to export an
interactive HTML report
as
offload_modeling_report.html
, make sure that the value of the
--project-dir
option specifies the path to your project directory and run the following command:
advisor --report=all --project-dir=./advi_results --report-output=./offload_modeling_report.html
Use the
--report-output
option to specify the directory to save the report to and a file name. This step is required.
View
Offload Modeling
Interactive HTML Report
Switch between the
Summary
and
Accelerated Regions
tabs to view estimated performance on a target accelerator. The structure of results in
Offload Modeling
interactive HTML Report is similar to GUI.
If you collect data for both
Offload Modeling
and
GPU Roofline Insights
perspectives, you can switch between perspectives using the
Perspective Selector
drop-down menu in the top left corner of the report to view results for both perspectives in one report.
For details about results interpretation, see Explore Offload Modeling Results.
View
Offload Modeling
Legacy HTML Report
Switch between the tabs to explore metrics for offloaded and non-offloaded code regions, estimate data transfer taxes, view or download configuration file for the selected target accelerator and examine execution logs.

GPU Roofline HTML Reports

Intel Advisor
enables you to export two types of HTML reports:
  • An interactive HTML report that represents results in the same structure as in GUI and enables you to switch between
    Offload Modeling
    and
    GPU Roofline Insights
    perspective results if you collect your data for an application running on GPU. This report contains grid data with GPU metrics, a GPU Roofline chart, and a source view.
    You can export an interactive HTML report only using CLI.
  • An HTML Roofline chart that enables you to visualize your application performance on an interactive Roofline chart and view your platform information.
Export HTML GPU Roofline Chart using GUI
To export an interactive HTML GPU Roofline chart using GUI, do the following:
  1. Run
    GPU Roofline Insights
    perspective.
  2. Select FLOAT or INT data type using the filter pane at the top of the Roofline chart. You cannot change the data type after the report is generated.
  3. Export the project results by clicking the button and selecting
    Export as HTML
    option. To share your result as an image, consider selecting
    Export as SVG
    option and setting up the resolution.
  4. Save the HTML report and open it in your browser.
Export GPU Roofline Report using CLI
Once the perspective executes,
Intel Advisor
enables you to export both types of HTML reports using CLI. For example, to export an
interactive HTML report
as
gpu_roofline_report.html
, make sure that the value of the
--project-dir
option specifies the path to your project directory and run the following command:
advisor --report=all --project-dir=./advi_results --report-output=./gpu_roofline_report.html
Use the
--report-output
option to specify the directory to save the report to and a file name. This step is required.
For example, to export an
HTML GPU Roofline chart
for floating-point operations data as
gpu_roofline.html
, make sure that the value of the
--project-dir
option specifies the path to your project directory and run the following command:
advisor --report=roofline --gpu --project-dir=./advi_results --report-output=./gpu_roofline.html --data-type=float
Use the
--report-output
option to specify the directory to save the report to and a file name. This step is required.
Use the
--gpu
option to generate a Roofline chart for GPU kernels. This option is
required
.
Use the
--data-type=
<type>
option to specify the data type to show in the Roofline chart. Available types are
float
(default) or
int
. You cannot change the data type after the report is generated.
Once report generation is complete, open it in your preferred web browser.
View Interactive HTML Report for GPU Roofline
Switch between the
Summary
and
GPU Roofline Regions
tabs to examine how your application executes on a GPU, identify top hotspots, and define room for their optimization using a Roofline chart and GPU grid metrics.
For details about result interpretation, see Explore GPU Roofline Results.
View HTML GPU Roofline Chart
Identify top hotspots and room for optimization of your application running on GPU using a Roofline chart and view the application execution and performance details in the
Performance Metrics Summary
drop-down section.
For details on results interpretation, see Examine Bottlenecks on a GPU Roofline Chart.

HTML Roofline Chart for CPU Roofline

Export an interactive Roofline chart for
CPU / Memory Roofline Insights
perspective to share it or open on a remote machine using your web browser. This report enables you to visualize performance of your application running on CPU, identify factors limiting your application performance, and define headroom for optimization at different memory levels.
Export HTML CPU Roofline Chart Using GUI
To export an interactive HTML CPU Roofline chart using GUI, do the following:
  1. Run
    CPU / Memory Roofline Insights
    perspective.
  2. Select FLOAT or INT data type using the filter pane at the top of the Roofline chart. You cannot change the data type after the report is generated.
  3. Export the project results by clicking the button and selecting
    Export as HTML
    option. To share your result as an image, consider selecting
    Export as SVG
    option and setting up the resolution.
  4. Save the HTML report and open it in your browser.
Export HTML CPU Roofline Chart Using CLI
Intel Advisor
enables you to export an HTML CPU Roofline chart using CLI. For example, to export an interactive CPU Roofline chart for floating-point operations data as
roofline.html
, make sure that the value of the
--project-dir
option specifies the path to your project directory and run the following command:
advisor --report=roofline --project-dir=./advi_results --report-output=./roofline.html
Use the
--report-output
option to specify the directory to save the report to and a file name. This step is required.
Use the
--with-stack
option to enable call stack data in the HTML report. Use it if you collected CPU Roofline with call stack data using the
--stacks
option.
Use the
--data-type=
<type>
option to specify the data type to show in the Roofline chart. Available types are
float
(default),
int
,
mixed
. You
cannot
change the data type after the report in generated.
Use the
--memory-level=
<string>
option to show specific memory levels in the HTML report by default. Available memory levels are
L1
(default),
L2
,
L3
, and
DRAM
. You can combine several memory levels with an underscore (for example,
L1_L2
). Use this if you generated the Memory-level CPU Roofline with
--enable-cache-simulation
.
Once report generation is complete, open it in your preferred web browser.
View CPU HTML Roofline Chart
Identify hotspots for optimization and room for improvement of your application running on CPU and view the application execution and performance details in the
Performance Metrics Summary
drop-down section.
CPU Roofline HTML report
For more information on interpretation of Roofline charts, see Examine Bottlenecks on CPU Roofline Chart.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.