Skip to main content

Extra-P, automated performance modeling for HPC applications

Project description

Extra-P

Automated performance modeling for HPC applications

PyPI - Python Version GitHub release (latest by date) PyPI version PyPI - License GitHub issues GitHub pull requests GitHub Workflow Status

Screenshot of Extra-P Extra-P is an automatic performance-modeling tool that supports the user in the identification of scalability bugs. A scalability bug is a part of the program whose scaling behavior is unintentionally poor, that is, much worse than expected. A performance model is a formula that expresses a performance metric of interest such as execution time or energy consumption as a function of one or more execution parameters such as the size of the input problem or the number of processors.

Extra-P uses measurements of various performance metrics at different execution configurations as input to generate performance models of code regions (including their calling context) as a function of the execution parameters. All it takes to search for scalability issues even in full-blown codes is to run a manageable number of small-scale performance experiments, launch Extra-P, and compare the asymptotic or extrapolated performance of the worst instances to the expectations.

Extra-P generates not only a list of potential scalability bugs but also human-readable models for all performance metrics available such as floating-point operations or bytes sent by MPI calls that can be further analyzed and compared to identify the root causes of scalability issues.

The following video on the Laboratory for Parallel Programming @ TUDa YouTube channel provides a quick introduction to Extra-P.

IMAGE ALT TEXT HERE

Extra-P is developed by TU Darmstadt – in collaboration with ETH Zurich.

For questions regarding Extra-P, please send a message to extra-p-support@lists.parallel.informatik.tu-darmstadt.de.


Table of Contents

  1. Requirements
  2. Installation
  3. How to use it
  4. License
  5. Citation
  6. Publications

Requirements

  • Python 3.8 or higher
  • numpy
  • pycubexr
  • marshmallow
  • packaging
  • tqdm
  • sklearn
  • PySide6 (for GUI)
  • matplotlib (for GUI)
  • pyobjc-framework-Cocoa (only for GUI on macOS)

Installation

Use the following command to install Extra-P and all required packages via pip.

python -m pip install extrap --upgrade

The --upgrade forces the installation of a new version if a previous version is already installed.

Usage

Extra-P can be used in two ways, either using the command-line interface or the graphical user interface. More information about the usage of Extra-P with both interfaces can be found in the quick start guide.

Note
Extra-P is designed for weak-scaling, therefore, directly modeling of strong-scaling behaviour is not supported. Instead of modeling the runtime of your strong-scaling experiment, you can model the resource consumption, i.e., the runtime times the number of processors. Extra-P automatically offers this conversion, if it detects that strong-scaling data was loaded. If you are loading files that contain per-thread/per-rank data you should select the scaling-type upfront to run the conversion already during the import.

Graphical user interface

The graphical user interface can be started by executing the extrap-gui command.

Command line interface

The command line interface is available under the extrap command:

extrap OPTIONS (--cube | --text | --talpas | --json | --extra-p-3 | --experiment) FILEPATH

You can use different input formats as shown in the examples below:

  • Text files: extrap --text test/data/text/one_parameter_1.txt
  • JSON files: extrap --json test/data/json/input_1.JSON
  • Talpas files: extrap --talpas test/data/talpas/talpas_1.txt
  • Create model and save it to text file at the given path: extrap --out test.txt --text test/data/text/one_parameter_1.txt

You can find an overview about all command line options under docs/command-line-options.md.

License

BSD 3-Clause "New" or "Revised" License

Citation

Please cite Extra-P in your publications if it helps your research:

@inproceedings{calotoiu_ea:2013:modeling,
  author = {Calotoiu, Alexandru and Hoefler, Torsten and Poke, Marius and Wolf, Felix},
  month = {November},
  title = {Using Automated Performance Modeling to Find Scalability Bugs in Complex Codes},
  booktitle = {Proc. of the ACM/IEEE Conference on Supercomputing (SC13), Denver, CO, USA},
  year = {2013},
  pages = {1--12},
  publisher = {ACM},
  isbn = {978-1-4503-2378-9},
  doi = {10.1145/2503210.2503277}
}

Publications

  1. Alexandru Calotoiu, David Beckingsale, Christopher W. Earl, Torsten Hoefler, Ian Karlin, Martin Schulz, Felix Wolf: Fast Multi-Parameter Performance Modeling. In Proc. of the 2016 IEEE International Conference on Cluster Computing ( CLUSTER), Taipei, Taiwan, pages 172–181, IEEE, September 2016. PDF

  2. Marcus Ritter, Alexandru Calotoiu, Sebastian Rinke, Thorsten Reimann, Torsten Hoefler, Felix Wolf: Learning Cost-Effective Sampling Strategies for Empirical Performance Modeling. In Proc. of the 34th IEEE International Parallel and Distributed Processing Symposium (IPDPS), New Orleans, LA, USA, pages 884–895, IEEE, May 2020. PDF

  3. Marcus Ritter, Alexander Geiß, Johannes Wehrstein, Alexandru Calotoiu, Thorsten Reimann, Torsten Hoefler, Felix Wolf: Noise-Resilient Empirical Performance Modeling with Deep Neural Networks. In Proc. of the 35th IEEE International Parallel and Distributed Processing Symposium (IPDPS), Portland, Oregon, USA, pages 23–34, IEEE, May 2021. PDF

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

extrap-4.2.3.tar.gz (180.7 kB view details)

Uploaded Source

Built Distribution

extrap-4.2.3-py3-none-any.whl (206.6 kB view details)

Uploaded Python 3

File details

Details for the file extrap-4.2.3.tar.gz.

File metadata

  • Download URL: extrap-4.2.3.tar.gz
  • Upload date:
  • Size: 180.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for extrap-4.2.3.tar.gz
Algorithm Hash digest
SHA256 d88d69b48b75bca1ce7b10d892e15f21ac98ec1ddd7f670f949e5d2089353afd
MD5 015871c2c5fd9e29fb7835b6f005387c
BLAKE2b-256 9e6e276c585e9ddcf3e7a260314d79c57173019664aa2cf0cd7e4da73afb5a8a

See more details on using hashes here.

Provenance

The following attestation bundles were made for extrap-4.2.3.tar.gz:

Publisher: python-publish.yml on extra-p/extrap

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file extrap-4.2.3-py3-none-any.whl.

File metadata

  • Download URL: extrap-4.2.3-py3-none-any.whl
  • Upload date:
  • Size: 206.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for extrap-4.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 09375796b114b248286574c5a42c103283b341e918eabdb45b1dca8caecd20ab
MD5 dfdba67560d8e2ef0f3c56994d1d8936
BLAKE2b-256 7e69ed9eef3d9c422a19f30f7288ee09ddfbaa3835ca317de21c619693ad4913

See more details on using hashes here.

Provenance

The following attestation bundles were made for extrap-4.2.3-py3-none-any.whl:

Publisher: python-publish.yml on extra-p/extrap

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page