User Guide

Contents

Intel Advisor CLI

Steps to
ramp up with
Intel® Advisor
CLI and get quick results
.
This section provides simple steps to get quick results and grasp the overall idea of how you can use
Intel® Advisor
.
For detailed information on using the command line to predict performance with the
Intel® Advisor Beta
, refer to the
Offload Advisor
.

Run the
Intel® Advisor Beta
CLI

The
Intel® Advisor Beta
CLI is available from a command line on Windows* or Linux* OS systems.
where:
  • <--action>
    is an
    Intel® Advisor Beta
    action to do, such as
    collect
    or
    report
    .
  • [--action-options]
    and
    [--global-options]
    are options to modify action behavior.
  • <target>
    is an application executable to analyze with optional
    [target-options]
    to apply to the target.
where:
  • <APM>
    is the environment variable that points to the directory with the
    Intel® Advisor Beta
    scripts. It is
    $APM
    for Linux* OS and
    %APM%
    for Windows* OS.
  • <offload-script>
    is a script to run:
    run_oa
    ,
    collect
    , or
    analyze
    .
  • <project-dir>
    is a path to a project directory.
  • [--options]
    is options to modify script behavior.
  • <target>
    is an application executable to analyze with optional
    [target-options]
    to apply to the target.
Staring
Intel® Advisor Beta
2021.1-beta10 release,
advixe-cl
and
advixe-python
command line interfaces are renamed to
advisor
and
advisor-python
respectively.

Run Analysis

To run an analysis from the CLI, you need to run the following command:
advixe-cl --collect=survey -- <target>
This command creates new project and runs the Survey analysis for the target application.

View Result

To view the analysis result, use the following command:
advixe-cl --report=survey
This command prints the analysis result into the terminal window.

Create Snapshot

Create a snapshot of the analysis results so that you can compare performance statistics before and after making changes in the target application's code. To create a snapshot run the following command:
advixe-cl --snapshot
The command creates snapshot in the current project directory with auto-generated name.

Re-run the Analysis

After making changes in the source code and recompiling the application, you need to re-run the analysis to see if the application performance changed as you expected. To re-run the analysis,
advixe-cl --collect=survey -- <target>

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804