Intel® Advisor User Guide

ID 766448
Date 3/31/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

run_oa.py Options

Collect basic data, do markup, and collect refinement data. Then proceed to run analysis on profiling data. This script combines the separate scripts collect.py and analyze.py.

Usage

advisor-python <APM>/run_oa.py <project-dir> [--options] -- <target> [target-options]

NOTE:
Replace <APM> with $APM on Linux* OS or %APM% on Windows* OS.

Options

The following table describes options that you can use with the run_oa.py script. The target application to analyze and application options, if any, must be preceded by two dashes and a space and placed at the end of a command.

Option

Description

<project-dir>

Required. Specify the path to the Intel® Advisor project directory.

-h

--help

Show all script options.

-v <verbose>

--verbose <verbose>

Specify output verbosity level:

  • 1 - Show only error messages. This is the least verbose level.

  • 2 - Show warning and error messages.

  • 3 (default) - Show information, warning, and error messages.

  • 4 - Show debug, information, warning, and error messages. This is the most verbose level.

NOTE:
This option affects the console output, but does not affect logs and report results.

--assume-dependencies (default) | --no-assume-dependencies

Assume that a loop has a dependency if the loop type is not known. When disabled, assume that a loop does not have dependencies if the loop dependency type is unknown.

--assume-hide-taxes [<loop-id> | <file-name>:<line-number>]

Use an optimistic approach to estimate invocation taxes: hide all invocation taxes except the first one.

You can provide a comma-separated list of loop IDs and source locations to hide taxes for. If you do not provide a list, taxes are hidden for all loops.

--assume-never-hide-taxes (default)

Use a pessimistic approach to estimate invocation taxes: do not hide invocation taxes.

--assume-parallel | --no-assume-parallel (default)

Assume that a loop is parallel if the loop type is not known.

--check-profitability (default) | --no-check-profitability

Check the profitability of offloading regions. Only regions that can benefit from the increased speed are added to a report.

When disabled, add all evaluated regions to a report, regardless of the profitability of offloading specific regions.

-c {basic, refinement, full}

--collect {basic, refinement, full}

Specify the type of data to collect for the application:

  • basic - Collect basic performance data (Survey, Trip Counts, FLOP), analyze data transfer between host and device memory, attribute memory objects to loops, and track accesses to stack memory.
  • refinement - Collect refined data (Dependencies) for marked loops only. Do not analyze data transfers.
  • full (default) - Collect both basic data for application and refined data for marked loops, analyze data transfer between host and device memory and potential data reuse, attribute memory objects to loops, and track accesses to stack memory.
NOTE:
For --collect full, make sure to use --data-reuse-analysis and --track-memory-objects.

For --collect basic, make sure to use the --track-memory-objects.

--config <config>

Specify a configuration file by absolute path or name. If you choose the latter, the model configuration directory is searched for the file first, then the current directory.

The following device configurations are available: xehpg_512xve (default), xehpg_256xve , gen11_icl, gen12_tgl, gen12_dg1, gen9_gt4, gen9_gt3, gen9_gt2.

NOTE:
You can specify several configurations by using the option more than once.

--cpu-scale-factor <integer>

Assume a host CPU that is faster than the original CPU by the specified value.

All original CPU times are divided by the scale factor.

--data-reuse-analysis (default) | --no-data-reuse-analysis

Estimate data reuse between offloaded regions. Disabling can decrease analysis overhead.

IMPORTANT:
Use with --collect full.

--data-transfer (default) | --no-data-transfer

Analyze data transfer.

NOTE:
Disabling can decrease analysis overhead.

--dry-run

Show the Intel® Advisor CLI commands for advisor appropriate for the specified configuration. No actual collection is performed.

--enable-batching | --disable-batching (default)

Enable job batching for top-level offloads. Emulate the execution of more than one instance simultaneously.

--enable-edram

Enable eDRAM modeling in the memory hierarchy model.

--enable-slm

Enable SLM modeling in the memory hierarchy model. Use both with collect.py and analyze.py.

--exclude-from-report <items-to-exclude>

Specify items to exclude from a report.