Skip to content

Commit c5f6c26

Browse files
committed
update api and doc
1 parent b8a9d3c commit c5f6c26

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,13 @@ To extract kernel activities and NVTX annotated regions (e.g. [torch.cuda.nvtx.r
1717
python3 nsys2json.py <nsys_sqlite_file> -o <output_json>
1818
```
1919

20-
To filter out only kernel activities or NVTX annotated regions, use:
20+
To filter out kernel activities or NVTX annotated regions, use:
2121
```bash
22-
-activity-type {kernel,nvtx}
22+
-activity-type {kernel, nvtx-cpu, nvtx-kernel}
2323
```
24+
* `kernel`: Raw CUDA kernel activities
25+
* `nvtx-cpu`: NVTX annotated regions on CPU threads
26+
* `nvtx-kernel`: NVTX annotated regions, but calculate the start and end time from CUDA kernel activities launched within the region
2427

2528
To filter NVTX regions based on name, use:
2629
```bash

nsys2json.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ def nsys2json():
306306
for activity in args.activity_type:
307307
if activity == "kernel":
308308
parse_cupti_kernel_events(conn, strings, traceEvents)
309-
elif activity == "nvtx":
309+
elif activity == "nvtx-cpu":
310310
parse_nvtx_events(conn, traceEvents, event_prefix=args.nvtx_event_prefix, color_scheme=args.nvtx_color_scheme)
311311
elif activity == "nvtx-kernel":
312312
parse_nvtx_kernel_events(conn, strings, traceEvents, event_prefix=args.nvtx_event_prefix, color_scheme=args.nvtx_color_scheme)

0 commit comments

Comments
 (0)