Intel® MPI Library Developer Reference for Linux* OS

ID 768732
Date 11/07/2023
Public

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

Document Table of Contents

mpitune_fast

This utility tunes the Intel® MPI Library to the cluster configuration using the Autotuning functionality.

Syntax

mpitune_fast <options>

Arguments

Options Description
-c | --colls Set custom collective operations to tune, delimited by commas.
-d | --results_dir <path-to-results-dir>

Set custom directory for tuning results, host files, and logs. Default: the current working directory.

-h | --help Display the help message.
-n <n> Specify the number of nodes. This can be a comma-delimited set of values to set up several launches.
-pd <path-to-performance-results-dir>,

--perf_results_dir <path-to-performance-results-dir>

Set a custom directory for validation performance results.

Default: performance_results_<timestamp>.

-ppn <n> Specify the number of processes per node. This can be a comma-delimited set of values to set up several launches.
-val <path-to-tuning-file>,

--validate <path-to-tuning-file>

Run the tuning file validation cycle to validate the existing tuning file.

Description

The mpitune_fast utility allows you to automatically set up the Intel MPI Library and launch with Autotuning enabled and configured for your cluster configuration.

The tool iteratively launches the Intel® MPI Benchmarks utility with the proper autotuner environment and generates a .dat file with the tuning parameters for your cluster configuration.

After generation the tuning file, set it as I_MPI_TUNING_BIN:

$ export I_MPI_TUNING_BIN=./tuning_results.dat
$ mpiexec <args>

Workload Managers  Support

mpitune_fast supports Slurm and LSF workload managers. It automatically defines job allocated hosts and performs launches.

MPI Options Support

The following MPI options are available within the utility:

Options Description
-f <filename> Specify a file containing host names.
-hosts HOSTS, --hosts HOSTS Set the host names, delimited by commas. Example: --hosts host1,host2

Example (default launch):

$ mpitune_fast -f ./hostfile

Example (customized launch):

$ mpitune_fast -ppn 8,4,2,1 -f ./hostfile -c alltoall,allreduce,barrier

See Also

Autotuning

MPI Tuning in the Intel MPI Library Developer Guide

For available configuration options, refer to mpitune Configuration Options.

Cluster-Wide MPI Tuning Using Intel® MPI Library