Welcome to the timemory Documentation!

Table of Contents

• About
  • Design Goals
  • Support for timemory in external tools
  • Credits
  • Contributions
• Features
  • Cross-Language Support
  • Reusable Components
  • Multithreading
  • Distributed Memory Parallelism
  • Hardware Counters
  • Plot Generation in Python
  • Pandas Dataframe Analysis in Python
  • Command-line Tools
  • Signal Detection
  • Cache Information
  • Support for Multiple Third-Party Instrumentation APIs
  • Generic Bundling of Multiple Tools
  • Powerful GOTCHA Extensions
• Installation
  • CMake Options
  • CMake Example
• Getting Started
  • Project Integration
    • timemory as a Submodule
    • Using CMake
    • Using Makefiles
    • Compilation with the Template Interface
  • Getting Started
    • Dynamic Instrumentation
    • Initialization and Finalization
    • Basic API
    • Environment Controls
  • Roofline
    • Generating Roofline Data
    • Roofline Python Module: timemory.roofline
    • Customizing the calculation of the “roof” for the Roofline
    • Configuring number of threads in the Roofline
    • Full Customization of the Roofline Model
• Tools
  • timem
    • Installation
    • Output Examples
    • Options
    • Customization Demonstration
  • timemory-avail
    • Available Components
    • Available Settings
    • Available Hardware Counters
  • timemory-run
    • Build Requirements
    • Dynamic Instrumentation Modes
    • General Syntax
    • Component Selection
    • Distributed Memory Parallelism
    • Command Line Options
  • timemory-stubs library
    • Description
    • About timemory-run tool
    • Usage
    • Examples
  • timemory-jump library
    • Description
    • About timemory-run tool
    • Usage
    • Examples
  • timemory-mpip library
    • Usage
  • timemory-ncclp library
    • Usage
  • timemory-mallocp library
    • Usage
    • Example
  • timemory-ompt library
    • Usage
  • timemory-nvml
    • Installation
    • Execution Modes
    • Options
  • timemory-compiler-instrument library
    • Description
    • Compiler Instrumentation Settings
    • Build
    • Example
  • KokkosP Profiling Tools
    • Build
    • Running Kokkos application with timemory enabled
    • Selecting Different Components
    • Filtering Kokkos Labels
    • Kernel Logging
    • Sample Output
    • Kernel Logging Sample Output
  • Profiling with timemory
    • Instrumenting Existing Binary
    • Instrumentation Binary at Compile-Time
• API
  • C / C++ / Fortran Library
    • Interface
    • Enumerations
  • Python Bindings
    • Description
    • Contents
    • Initialization and Finalization
    • Settings
    • Decorators
    • Context Managers
    • Function Profiler
    • Tracing Profiler
    • Library Bindings
    • Individual Components
    • Storage
  • C++ Variadic Template Bundlers
    • auto_bundle
    • auto_list
    • auto_tuple
    • component_bundle
    • component_list
    • component_tuple
    • lightweight_tuple
    • Static Polymorphic Base Classes
  • C++ Type-Traits
    • Component Implementation
    • Base Class Modifications
    • Priority Ordering
    • Data Sharing
    • Data Collection
    • Feature Support
    • Archive Serialization
    • Units and Formatting
    • Output Reporting
    • Statistics
    • Storage
    • Deprecated
  • C++ Concepts
    • Inheritable Concepts
    • Non-Inheritable Concepts
  • C++ Policies
  • C++ Operations
  • C++ Utilities
    • Scope
    • Quirks
    • Sampling
    • Conditional
  • Memory Management
    • Manager Class
    • Memory Buffers
    • Allocators
    • Graph Classes
    • Storage Class
  • Basic Usage
  • Creating Custom Tools/Components
    • Custom Logging Component Example
    • Composable Components Example
    • Extended Example
• Components
  • Using GOTCHA
    • Use Cases
    • Traditional GOTCHA in C
    • GOTCHA in timemory
    • Function Wrapping
    • Function Replacement
    • Extended Example
  • Roofline Components
    • Pre-defined Types
  • Custom Components
    • Type Traits
    • Custom Component Example
  • Overview
  • Component Basics
  • Component Metadata
  • Timing Components
  • Resource Usage Components
  • I/O Components
  • User Bundle Components
  • Third-Party Interface Components
  • Hardware Counter Components
  • Miscellaneous Components
  • GPU Components
  • Data Tracking Components
  • Function Wrapping Components
  • Base Components
• Tutorials
• Contributing to timemory
  • Basic Layout
    • Step 1. Create source/timemory/components/hello_world/ folder
    • Step 2. source/timemory/components/hello_world/CMakeLists.txt
    • Step 3. source/timemory/components/hello_world/types.hpp
    • Step 4. source/timemory/components/hello_world/backends.hpp
    • Step 5. source/timemory/components/hello_world/extern.hpp
    • Step 6. source/timemory/components/hello_world/extern.cpp
    • Step 7. source/timemory/components/hello_world/components.hpp
  • Version and Interface Compatibility
    • Function Signature Changes
    • Behavior changes
  • Conclusion
• Doxygen