NVIDIA Nsight Tools JupyterLab Extension

A JupyterLab extension for profiling cells execution using NVIDIA Nsight tools.

Demo

Click on the image to launch the video

Requirements

• JupyterLab >= 4.0.0
• Docker (optional, for GUI support)
• nvtx (Required for Nsight Compute support)

Nsight tools are not shipped with this extension. The required tool(s) should be installed separately on the JupyterLab server machine.

Install and setup

• To install the extension, execute:

pip install jupyterlab-nvidia-nsight

• Set Nsight Systems and/or Nsight Compute installation location in the extension settings.

Profile JupyterLab cells

1. Enable Nsight tool by using the Profiling with Nsight Systems/Compute... command under the NVIDIA Nsight menu, or by using the command palette.
   • Note: This operation restarts the JupyterLab kernel.
2. Profile cells execution by using the Run and profile selected cells... command.
3. The cell's profiling info is displayed in the cell output area.

Analyzing the profile session in Nsight tools GUI

• Open Nsight tools report files in a tab inside JupyterLab.
• Release 0.5 supports display of Nsight Systems GUI. Display of Nsight Compute GUI is planned for a future release.
• Display of Nsight tools GUI requires a WebRTC docker image. Build the GUI WebRTC docker image by executing:

<nsys_install_dir>/host-linux-x64/Scripts/WebRTCContainer/build.sh

• Known issue: Keyboard doesn't work in GUI display.

Supported Tools

Nsight Systems

• Required Nsight Systems release 2024.1.1 or later.
• Use --stats=true when profiling cells execution to see textual output of nsys stats.

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-nvidia-nsight

Troubleshooting

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list