Welcome to the timemory Documentation!

Timing + Memory + Hardware Counter Utilities for C / C++ / CUDA / Python


Build Status Build status codecov

Source Command
GitHub git clone https://github.com/NERSC/timemory.git
PyPi pip install timemory
Anaconda Cloud conda install -c jrmadsen timemory

Anaconda Cloud

Why Use timemory?

Support for Multiple Instrumentation Marker APIs

Create Your Own Performance and Analysis Tools

Generic Bundling of Multiple Tools

Powerful GOTCHA Extensions

Multi-language Support

Table of contents

  1. About -- About the timemory project
  2. Features -- Features supported and provided by timemory
  3. Installation -- How to install timemory
  4. Components -- Available components in timemory and their wrappers
  5. Getting Started -- How to get started using timemory
    • Project integration, basic syntax, custom components, generating a roofline
  6. Runtime Overhead -- Analysis of runtime overhead of timemory
  7. Doxygen Documentation -- Doxygen source code documentation