Skip to main content

Loop Kernel Analysis and Performance Modeling Toolkit

Project description

https://github.com/RRZE-HPC/kerncraft/blob/master/doc/logo/logo-lightbg.svg

kerncraft

Loop Kernel Analysis and Performance Modeling Toolkit

This tool allows automatic analysis of loop kernels using the Execution Cache Memory (ECM) model, the Roofline model and actual benchmarks. kerncraft provides a framework to investigate the data reuse and cache requirements by static code analysis. In combination with the Intel IACA tool kerncraft can give a good overview of both in-core and memory bottlenecks and use that data to apply performance models.

For a detailed documentation see publications in doc/.

https://github.com/RRZE-HPC/kerncraft/actions/workflows/test-n-publish.yml/badge.svg https://codecov.io/github/RRZE-HPC/kerncraft/coverage.svg?branch=master

Installation

On most systems with python pip and setuputils installed, just run:

pip install --user kerncraft

for the latest release. In order to get the Intel Achitecture Code Analyzer (IACA), required by the ECM, ECMCPU and RooflineASM performance models, read this and run:

iaca_get --I-accept-the-Intel-What-If-Pre-Release-License-Agreement-and-please-take-my-soul

Additional requirements are:
  • likwid (used in Benchmark model and by likwid_bench_auto)

Usage

  1. Get an example kernel and machine file from the examples directory

wget https://raw.githubusercontent.com/RRZE-HPC/kerncraft/master/examples/machine-files/SandyBridgeEP_E5-2680.yml

wget https://raw.githubusercontent.com/RRZE-HPC/kerncraft/master/examples/kernels/2d-5pt.c

  1. Have a look at the machine file and change it to match your targeted machine (above we downloaded a file for a Sandy Bridge EP machine)

  2. Run kerncraft

kerncraft -p ECM -m SandyBridgeEP_E5-2680.yml 2d-5pt.c -D N 10000 -D M 10000 add -vv for more information on the kernel and ECM model analysis.

Citations

When using Kerncraft for your work, please consider citing the following publication:

Kerncraft: A Tool for Analytic Performance Modeling of Loop Kernels (preprint)

J. Hammer, J. Eitzinger, G. Hager, and G. Wellein: Kerncraft: A Tool for Analytic Performance Modeling of Loop Kernels. In: Tools for High Performance Computing 2016, ISBN 978-3-319-56702-0, 1-22 (2017). Proceedings of IPTW 2016, the 10th International Parallel Tools Workshop, October 4-5, 2016, Stuttgart, Germany. Springer, Cham. DOI: 10.1007/978-3-319-56702-0_1, Preprint: arXiv:1702.04653``

Credits

Implementation: Julian Hammer;
ECM Model (theory): Georg Hager, Holger Stengel, Jan Treibig;
LC generalization: Julian Hammer

License

AGPLv3

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

kerncraft-0.8.16.tar.gz (672.5 kB view details)

Uploaded Source

Built Distribution

kerncraft-0.8.16-py3-none-any.whl (125.8 kB view details)

Uploaded Python 3

File details

Details for the file kerncraft-0.8.16.tar.gz.

File metadata

  • Download URL: kerncraft-0.8.16.tar.gz
  • Upload date:
  • Size: 672.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.4

File hashes

Hashes for kerncraft-0.8.16.tar.gz
Algorithm Hash digest
SHA256 70db01727993eb3c1328b7ae1b136c6f60eb41c8deac75129bc8c2f7e60edcd4
MD5 fa613ea50f16150b42b102bc69c6628a
BLAKE2b-256 508e2c04c4fcc5ee905755181a317e52946f30ad707cda014cca47a0bac8d816

See more details on using hashes here.

File details

Details for the file kerncraft-0.8.16-py3-none-any.whl.

File metadata

  • Download URL: kerncraft-0.8.16-py3-none-any.whl
  • Upload date:
  • Size: 125.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.4

File hashes

Hashes for kerncraft-0.8.16-py3-none-any.whl
Algorithm Hash digest
SHA256 8cc5551d60513181d6cb09df148799db42c9225dedb94e5e812ee8951dc1de99
MD5 2a93944a7d01e6668acbb4349c57773b
BLAKE2b-256 f8e6cf40177c33d75748f3e61f2462c25074253daac1ed6f456aa7df512ad583

See more details on using hashes here.

Supported by

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