Python API总体说明

接口简介

Profiling模块提供msPTI Python接口，用于采集各模块性能数据。

msPTI API的功能介绍和使用示例请参见msPTI工具。

接口列表

具体接口如下：

表 1 msPTI Python API

接口	说明
HcclMonitor类型	HcclMonitor说明
HcclMonitor.start	标识通信算子性能数据采集的开始。
HcclMonitor.stop	标识通信算子性能数据采集的结束。
HcclMonitor.flush_all	调用回调函数，将缓冲区中的所有Activity数据写入用户内存。
HcclMonitor.set_buffer_size	在采集开始前设置Activity Buffer的大小。
KernelMonitor类型	KernelMonitor说明
KernelMonitor.start	标识Kernel性能数据采集的开始。
KernelMonitor.stop	标识Kernel性能数据采集的结束。
KernelMonitor.flush_all	调用回调函数，将缓冲区中的所有Activity数据写入用户内存。
KernelMonitor.set_buffer_size	在采集开始前设置Activity Buffer的大小。
MstxMonitor类型	MstxMonitor说明
MstxMonitor.start	标识数据采集msTX打点的开始。
MstxMonitor.stop	标识数据采集msTX打点的结束。
MstxMonitor.enable_domain	开启对应域打点的采集。
MstxMonitor.disable_domain	关闭对应域打点的采集。
MstxMonitor.flush_all	调用回调函数，将缓冲区中的所有Activity数据写入用户内存。
MstxMonitor.set_buffer_size	在采集开始前设置Activity Buffer的大小。
CommunicationMonitor类型	CommunicationMonitor说明
CommunicationMonitor.start	标识通信算子性能数据采集的开始。
CommunicationMonitor.stop	标识通信算子性能数据采集的结束。
CommunicationMonitor.flush_all	调用回调函数，将缓冲区中的所有Activity数据写入用户内存。
CommunicationMonitor.set_buffer_size	在采集开始前设置Activity Buffer的大小。
Data Structure类型	Data Structure说明
HcclData	Activity Record类型MSPTI_ACTIVITY_KIND_HCCL对应的结构体。
KernelData	Activity Record类型MSPTI_ACTIVITY_KIND_KERNEL对应的结构体。
MarkerData	Activity Record类型MSPTI_ACTIVITY_KIND_MARKER对应的结构体。
RangeMarkerData	Activity Record类型MSPTI_ACTIVITY_KIND_MARKER对应的结构体。
CommunicationData	Activity Record类型MSPTI_ACTIVITY_KIND_COMMUNICATION对应的结构体。
Enumeration类型	Enumeration说明
msptiResult	MSPTI返回的错误和结果代码。
msptiActivityKind	MSPTI支持的所有Activity类型。
msptiActivityFlag	Activity Record的活动标记。
msptiActivitySourceKind	标记Activity数据来源。
msptiCommunicationDataType	通信算子传输的数据类型。