Intel® Advisor User Guide

ID 766448
Date 7/13/2023
Public

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

Document Table of Contents

custom-config

Specify the absolute path or name for a custom TOML configuration file with additional modeling parameters.

GUI Equivalent

Project Properties > Analysis Target > Performance Modeling > Custom Device Configuration

Syntax

--custom-config=<path>

Arguments

<path> is the absolute path or a name of a custom TOML configuration file.

Actions Modified

collect=projection

collect=offload

Usage

If you specify the configuration file name, the configuration directory will be searched first, then the current directory. See Advanced Modeling Configuration for details about modeling parameters available.

You can specify this option more than once to provide multiple custom configuration files for the Performance Modeling. For example, you can provide a scalers.toml file generated from an Offload Modeling HTML report and a manually created configuration file with additional parameters.

When used with --collect=offload, the custom configuration file is checked for a memory structure description at the Trip Counts analysis step. This description is used to generate cache configuration for cache simulation. If you specify several configurations, Intel Advisor only uses the last configuration with memory structure parameters for Trip Counts and ignores other files. For example, if you specified a target device configuration with config and additional parameters with custom-config, Intel Advisor only uses the target device configuration for the Trip Counts analysis and ignores the custom configuration, but for the Performance Modeling, it uses both configuration files.

NOTE:
target-device, config, and cache-config options take precedence over memory structure parameters specified with custom-config.

Example

  1. Create a TOML configuration file and specify additional parameters.

  2. Run Survey Analysis.

  3. Run Trip Counts and FLOP analyses of the Characterization stage.

  4. Model your application performance on a target device with the custom myConfig.toml file.

advisor --collect=survey --static-instruction-mix --project-dir=./advi_results -- ./myApplication
advisor --collect=tripcounts --flop --enable-data-transfer-analysis --project-dir=./advi_results -- ./myApplication
advisor --collect=projection --custom-config=./myConfig.toml --project-dir=./advi_results

See Also