ittapi

ittapi是Intel仪器和跟踪技术（ITT）API的Python绑定。它提供了一种方便的方式来标记Python代码，以便使用Intel的VTune或其他性能分析器进行进一步的性能分析。

注意：为了与Python绑定的早期版本（itt-python）兼容和顺利迁移，请将 import itt 替换为 import ittapi.compat as itt。有关 ittapi.compat 的更多详细信息，请访问 ittapi.compat页面。

ittapi支持以下ITT API

• 集合控制API
• 域API
• 事件API
• 标识符API
• 字符串句柄API
• 任务API
• 线程命名API

用法

该项目的主要目标是提供一种使用ITT API在Python方式中仪器化Python代码的能力。ittapi提供了简化Python代码标记的包装器。

import ittapi

@ittapi.task
def workload():
  pass

workload()

ittapi.task可以用作装饰器。在这种情况下，可调用对象（例如此示例中的workload函数）的名称将用作任务的名称，并将任务分配给默认域“ittapi”。如果您想更改默认名称和/或其他任务参数（例如任务域），您可以将其作为参数传递给ittapi.task

import ittapi

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

workload()

此外，ittapi.task返回的对象可以用作上下文管理器

import ittapi

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

如果未指定任务名称，则 ittapi.task 将使用调用站点信息（文件名和行号）为任务命名。可以通过与装饰器形式相同的方式，通过 ittapi.task 的参数指定任务的自定义名称和其他任务参数。

安装

ittapi 包可在 PyPi 上找到，并且可以按照支持配置的常规方式安装。

pip install ittapi

构建

ittapi 模块的本地部分使用 C++20 标准编写，因此您需要一个支持此标准的编译器，例如 Linux 的 GCC-10 和 Windows 的 Visual Studio 2022。

Ubuntu 22.04

1. 安装构建模块所需的编译器和 Python 工具。

   sudo apt install gcc g++ python3-pip
   

2. 克隆仓库

   git clone https://github.com/intel/ittapi.git
   

3. 构建和安装 ittapi

   cd python
   pip install .
   

Windows 10/11

1. 安装 Python 3.8+ 以及 pip 工具。

2. 安装 Visual Studio 2022。确保选择了“使用 C++ 的桌面开发”工作负载。

3. 克隆仓库

   git clone https://github.com/intel/ittapi.git
   

4. 构建和安装 ittapi

   cd python
   pip install .
   

参考

• 仪表化和跟踪技术 API
• Intel® VTune™ Profiler 用户指南 - 任务分析
• Intel® 图形性能分析器用户指南 - 仪表化和跟踪技术 API 支持