Skip to main content

ittapi

ittapi is a Python binding to Intel Instrumentation and Tracing Technology (ITT) API. It provides a convenient way to mark up the Python code for further performance analysis using performance analyzers from Intel like Intel VTune or others.

NOTE: For compatibility and smooth migration with earlier versions of Python bindings(itt-python), please replace import itt with import ittapi.compat as itt. For more details about ittapi.compat, visit ittapi.compat page.

ittapi supports following ITT APIs:

  • Collection Control API
  • Domain API
  • Event API
  • Id API
  • String Handle API
  • Task API
  • Thread Naming API

Usage

The main goal of the project is to provide the ability to instrument a Python code using ITT API in the Pythonic way. ittapi provides wrappers that simplify markup of Python code.

import ittapi

@ittapi.task
def workload():
  pass

workload()

ittapi.task can be used as a decorator. In this case, the name of a callable object (workload function in this example) will be used as a name of the task and the task will be attributed to a default domain named 'ittapi'. If you want to change the default name and/or other parameters for the task (e.g. task domain), you can pass them as arguments to ittapi.task:

import ittapi

@ittapi.task('My Task', domain='My Task Domain')
def workload():
  pass

workload()

Also, ittapi.task returns the object that can be used as a context manager:

import ittapi

with ittapi.task():
    # some code here...
    pass

If the task name is not specified, the ittapi.task uses call site information (filename and line number) to give the name to the task. A custom name for the task and other task parameters can be specified via arguments for ittapi.task in the same way as for the decorator form.

Installation

ittapi package is available on PyPi and can be installed in the usual way for the supported configurations:

pip install ittapi

Build

The native part of ittapi module is written using C++20 standard, therefore you need a compiler that supports this standard, for example GCC-10 for Linux and Visual Studio 2022 for Windows.

Ubuntu 22.04

  1. Install the compiler and Python utilities to build module:

    sudo apt install gcc g++ python3-pip
    
  2. Clone the repository:

    git clone https://github.com/intel/ittapi.git
    
  3. Build and install ittapi:

    cd python
    pip install .
    

Windows 10/11

  1. Install Python 3.8+ together with pip utility.

  2. Install Visual Studio 2022. Make sure that "Desktop development with C++" workload is selected.

  3. Clone the repository

    git clone https://github.com/intel/ittapi.git
    
  4. Build and install ittapi

    cd python
    pip install .
    

References

Metadata

Release files for ittapi 1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for ittapi 1.2.1
File Actions
ittapi-1.2.1-cp314-cp314-win_amd64.whl CPython 3.14 CPython 3.14 Windows x86-64 Details for ittapi-1.2.1-cp314-cp314-win_amd64.whl
ittapi-1.2.1-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl CPython 3.14 CPython 3.14 Linux glibc 2.28+ x86-64, Linux glibc 2.5+ x86-64 Details for ittapi-1.2.1-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
ittapi-1.2.1-cp313-cp313-win_amd64.whl CPython 3.13 CPython 3.13 Windows x86-64 Details for ittapi-1.2.1-cp313-cp313-win_amd64.whl
ittapi-1.2.1-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl CPython 3.13 CPython 3.13 Linux glibc 2.28+ x86-64, Linux glibc 2.5+ x86-64 Details for ittapi-1.2.1-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
ittapi-1.2.1-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for ittapi-1.2.1-cp312-cp312-win_amd64.whl
ittapi-1.2.1-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.28+ x86-64, Linux glibc 2.5+ x86-64 Details for ittapi-1.2.1-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
ittapi-1.2.1-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details for ittapi-1.2.1-cp311-cp311-win_amd64.whl
ittapi-1.2.1-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl CPython 3.11 CPython 3.11 Linux glibc 2.28+ x86-64, Linux glibc 2.5+ x86-64 Details for ittapi-1.2.1-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
ittapi-1.2.1-cp310-cp310-win_amd64.whl CPython 3.10 CPython 3.10 Windows x86-64 Details for ittapi-1.2.1-cp310-cp310-win_amd64.whl
ittapi-1.2.1-cp310-cp310-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl CPython 3.10 CPython 3.10 Linux glibc 2.28+ x86-64, Linux glibc 2.5+ x86-64 Details for ittapi-1.2.1-cp310-cp310-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
ittapi-1.2.1-cp39-cp39-win_amd64.whl CPython 3.9 CPython 3.9 Windows x86-64 Details for ittapi-1.2.1-cp39-cp39-win_amd64.whl
ittapi-1.2.1-cp39-cp39-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl CPython 3.9 CPython 3.9 Linux glibc 2.5+ x86-64, Linux glibc 2.28+ x86-64 Details for ittapi-1.2.1-cp39-cp39-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
ittapi-1.2.1-cp38-cp38-win_amd64.whl CPython 3.8 CPython 3.8 Windows x86-64 Details for ittapi-1.2.1-cp38-cp38-win_amd64.whl
ittapi-1.2.1-cp38-cp38-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl CPython 3.8 CPython 3.8 Linux glibc 2.28+ x86-64, Linux glibc 2.5+ x86-64 Details for ittapi-1.2.1-cp38-cp38-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl

Total release size: 1.6 MB

Release files / ittapi-1.2.1-cp314-cp314-win_amd64.whl

Download URL ittapi-1.2.1-cp314-cp314-win_amd64.whl
Size 48.6 kB
Tags CPython 3.14 Windows x86-64
SHA-256 checksum
How to use checksums
9e2df7653badb76fbbacfd901864b952c478397aafce3a5404861e58853217dd
BLAKE2b-256 checksum
How to use checksums
997ac8d22aa71bec497cb846d4e2ff9879c45fdbe6cde114ab6ebbe9b7661577
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ittapi-1.2.1-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl

Download URL ittapi-1.2.1-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
Size 179.4 kB
Tags CPython 3.14 Linux glibc 2.28+ x86-64 Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
45d4c159b575127ceb6f80a5719051b5f21bdbf0028596e74e282b097cffa64e
BLAKE2b-256 checksum
How to use checksums
7e1bf344c6b518aa977dce53b9cd4ca92f8d244957c2d1202b05b02be39a274d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ittapi-1.2.1-cp313-cp313-win_amd64.whl

Download URL ittapi-1.2.1-cp313-cp313-win_amd64.whl
Size 47.3 kB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
7791c027766af8d55bfe0e27122e12aac049e7900e27950de048078d544f79af
BLAKE2b-256 checksum
How to use checksums
e63359ce8d7bc97f4bc3b81f83d5f4106bf31da863af45e91e8c72a109db6220
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ittapi-1.2.1-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl

Download URL ittapi-1.2.1-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
Size 178.5 kB
Tags CPython 3.13 Linux glibc 2.28+ x86-64 Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
29c82fc506ebf131d1662938b96cfdfbe6424882f15a7628f391ed4dfb830ca7
BLAKE2b-256 checksum
How to use checksums
2c552cf4d905c5a203efdf1a1cde64d410ee8d56ffed6e8043be1638744b5335
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ittapi-1.2.1-cp312-cp312-win_amd64.whl

Download URL ittapi-1.2.1-cp312-cp312-win_amd64.whl
Size 47.4 kB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
098326533cbaf5f59a04749b8d6940242c0de19b5c4cde074eda8f8954ef39cb
BLAKE2b-256 checksum
How to use checksums
b2918b16056d6438a78e69677922ecb63af4fc21b909361929edf807de86ed0f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ittapi-1.2.1-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl

Download URL ittapi-1.2.1-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
Size 178.1 kB
Tags CPython 3.12 Linux glibc 2.28+ x86-64 Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
7e633600ffa3ad280baea1494596433b5f1b0627e41b64ea19903eea88c3de55
BLAKE2b-256 checksum
How to use checksums
ef621b48f9d2b8e2ad584f5f0cf8b5517dc794eed217b48b327d25389039deba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ittapi-1.2.1-cp311-cp311-win_amd64.whl

Download URL ittapi-1.2.1-cp311-cp311-win_amd64.whl
Size 47.3 kB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
1cae7682449d9aaa905bdf6a879763e72a3049c54ffba262e18551eaf043013b
BLAKE2b-256 checksum
How to use checksums
b2108f0435aa11d5fb199711afeef674b66807b353cb19c9abd831d4eb1e4bc1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ittapi-1.2.1-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl

Download URL ittapi-1.2.1-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
Size 175.6 kB
Tags CPython 3.11 Linux glibc 2.28+ x86-64 Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
7818e4088737ed77ddbf99a95ab05600ec5f332455daee33a6e82b282d6a8031
BLAKE2b-256 checksum
How to use checksums
213796b4882cc99837defc62cbdd835894d6bd39b6efc91b78b884679f640744
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ittapi-1.2.1-cp310-cp310-win_amd64.whl

Download URL ittapi-1.2.1-cp310-cp310-win_amd64.whl
Size 47.3 kB
Tags CPython 3.10 Windows x86-64
SHA-256 checksum
How to use checksums
dc78c35702712071aeca053c229c497c117977f5d5ae4aeef12015f5f82bd243
BLAKE2b-256 checksum
How to use checksums
378996c6bca0e5f965a8e3f37ebb7c8ac7a86afd034cb84379d800e391022ce6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ittapi-1.2.1-cp310-cp310-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl

Download URL ittapi-1.2.1-cp310-cp310-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
Size 177.1 kB
Tags CPython 3.10 Linux glibc 2.28+ x86-64 Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
760b5c2c3d7d9a93f903a1c4620106149850371d16a9d06deea20eb14b0911a8
BLAKE2b-256 checksum
How to use checksums
250c55053bd80088529cb824caf66a0f441c551c0cff03ae2cf600437bcbb81b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ittapi-1.2.1-cp39-cp39-win_amd64.whl

Download URL ittapi-1.2.1-cp39-cp39-win_amd64.whl
Size 47.3 kB
Tags CPython 3.9 Windows x86-64
SHA-256 checksum
How to use checksums
466e7f6f3d0d6a31c2dee6e16023cbc500c4e711fdff5d4856b4f4042b534683
BLAKE2b-256 checksum
How to use checksums
1b96f2bdc0fb2c5f74d447bf41b1f452c1e115befb4bab6a5d0a29856c4418bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ittapi-1.2.1-cp39-cp39-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl

Download URL ittapi-1.2.1-cp39-cp39-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
Size 176.1 kB
Tags CPython 3.9 Linux glibc 2.28+ x86-64 Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
c33e8b5359d5347fac05cf8189c421417f1b3aaeb78c480df5ce133edab51ca7
BLAKE2b-256 checksum
How to use checksums
fcd61cd427dad4360cf5ee576027f86aeccda991ddadc7977ccee2c6e15c2a24
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ittapi-1.2.1-cp38-cp38-win_amd64.whl

Download URL ittapi-1.2.1-cp38-cp38-win_amd64.whl
Size 47.3 kB
Tags CPython 3.8 Windows x86-64
SHA-256 checksum
How to use checksums
76147a5863cc2009cb2ff5fd864cd9f1c0326757b2871a58797694a9fa70906f
BLAKE2b-256 checksum
How to use checksums
c3bc2393c24a5614029b177a6dfab72663634548409b3fa832896ddbebe5b871
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / ittapi-1.2.1-cp38-cp38-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl

Download URL ittapi-1.2.1-cp38-cp38-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
Size 178.1 kB
Tags CPython 3.8 Linux glibc 2.28+ x86-64 Linux glibc 2.5+ x86-64
SHA-256 checksum
How to use checksums
410f64bae0ec8097ab82f503323014ec493d4b33380997bcfbb8a1180f501778
BLAKE2b-256 checksum
How to use checksums
9f61ffa978b102e1470cae410330ad24c21cbbe4622ca744675a85b19fa5ccad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Security for ittapi 1.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page