Annotation Types

Markers

Annotate a specific point in a program execution.

For example, mark when an exception occurs:

import nvtx

domain = nvtx.get_domain('My Lib')
attr = domain.get_event_attributes(color='red')

try:
    raise Exception()
except Exception() as e:
    attr.message = str(e)
    domain.mark(attr)
    raise

Ranges

Annotate a range between two points in a program’s execution. There are two types of ranges:

Push/Pop Ranges

• Form a stack of nested NVTX ranges per thread per NVTX domain.

• When possible, prefer to use nvtx.annotate.

• Otherwise, for best performance, prefer to use nvtx.Domain.push_range() and nvtx.Domain.pop_range() over nvtx.push_range() and nvtx.pop_range().

Start/End Ranges

• May overlap with other ranges arbitrarily.

• Can be started and ended by different threads.

• For best performance, prefer to use nvtx.Domain.start_range() and nvtx.Domain.end_range() over nvtx.start_range() and nvtx.end_range().