API 레퍼런스
hapti는 두 가지 인터페이스를 제공합니다. 일반적인 사용자 환경에서는 CLI만으로 충분하며, Python API는
코드 구간 주석 및 PyTorch 연동을 위해 제공됩니다.
| 인터페이스 |
주요 역할 및 대상 |
대표 진입점 |
| CLI |
프로그램을 프로파일러 환경에서 실행하고 트레이스를 병합하는 기본 도구(대다수 사용자 대상) |
haprof, haprof merge |
| Python API |
코드 내 주석 지정 및 PyTorch 프로파일러 연동 |
annotate, mark, hapti.kineto.register 등 |
레코드가 언제 수집되는지, 디바이스 시간이 어떻게 드러나는지, 카운터를 어떻게 읽는지 같은
의미는 두 인터페이스가 동일하며 프로그래밍 가이드에서 한 번만
설명합니다. 이 절은 옵션과 시그니처를 다룹니다.
영역별 진입점
| 영역 |
진입점 |
레퍼런스 |
| 실행·병합 |
haprof, haprof merge |
CLI |
| 주석 |
annotate, range_push, range_pop, range_start, range_stop, mark |
Python API |
| PyTorch 연동 |
hapti.kineto.register |
Python API |
참조 페이지
| 페이지 |
이럴 때 참고 |
| 카운터 레퍼런스 |
하드웨어 카운터 41개의 의미와 트레이스에 표시되는 파생 지표(util% 등)를 확인할 때 |
| 환경 변수 |
CLI 옵션 대신 환경 변수로 설정하거나, HAPTI_COUNTERS로 수집할 카운터를 지정할 때 |
| 지원 매트릭스 |
지원 플랫폼과 수집할 수 있는 항목·없는 항목을 확인할 때 |
공통 의미
| 속성 |
값 |
| 연동 방식 |
런처가 설정하는 LD_PRELOAD. 소스 수정도 재빌드도 없음 |
| 범위 |
프로세스 단위. 프로세스 시작 시점에 고정 |
| 출력 |
Perfetto .pftrace와 Chrome .json. 기본은 둘 다 |
| 출력 위치 |
haprof를 실행한 디렉토리, 또는 -d |
| 기록 시점 |
프로세스 종료 시 |
| 디바이스 레코드 |
호출 시점이 아니라 디바이스의 배치 경계에서 방출 |
| 클럭 |
모든 시각이 호스트 CLOCK_MONOTONIC 나노초 |
| 카운터 |
41개 중 기본 20개 등록. 커널 실행마다 샘플링되고 델타나 백분율로 표시 |
| 트레이스당 디바이스 |
하나 |
| Python API |
주석과 PyTorch 연동 전용. 프로파일링을 시작·중지·설정하지 않음 |
함께 보기