在Nsight工具GUI中分析配置会话

• 默认情况下禁用了GUI显示。要使用Nsight Systems GUI分析报告文件，请检查扩展设置中的启用Nsight Systems UI复选框。
• 在JupyterLab中的一个标签页中打开Nsight工具报告文件。
• 显示Nsight工具GUI需要WebRTC Docker镜像。通过执行以下命令构建GUI WebRTC Docker镜像：

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

支持的工具

Nsight Systems

• 支持Nsight Systems版本2024.1.1或更高版本。建议使用最新版本。
• 在分析单元格执行时使用--stats=true，以查看nsys stats的文本输出。

在扩展中无法使用的NSYS CLI标志列表

• --help，-h
• –hotkey-capture
• --output，-o
• –session-new
• –session
• --stop-on-exit，-x

Nsight Compute

• 支持Nsight Compute版本2024.3或更高版本。建议使用最新版本。

在扩展中无法使用的NCU CLI标志列表

• –app-replay-buffer
• –app-replay-match
• –app-replay-mode
• –check-exit-code
• –chips
• –config-file-path
• –config-file
• --export，-o
• --force-overwrite，-f
• --help，-h
• –hostname
• --import，-i
• –kill
• –list-chips
• –list-metrics
• –list-rules
• –list-sections
• –list-sets
• –log-file
• –mode
• –null-stdin
• –open-in-ui
• –profile-from-start
• –query-metrics-collection
• –query-metrics-mode
• –query-metrics
• –quiet
• –range-filter
• –range-replay-options
• –rename-kernels-export
• –replay-mode
• –section-folder-restore
• --version，-v

仅当启用NCU时才可使用的NCU CLI标志列表

• –apply-rules
• –cache-control
• –call-stack-type
• –call-stack
• –clock-control
• –disable-profiler-start-stop
• –graph-profiling
• –import-source
• –injection-path-32
• –injection-path-64
• –max-connections
• –metrics
• –pm-sampling-buffer-size
• –pm-sampling-interval
• –pm-sampling-max-passes
• --port，-p
• –preload-library
• –rule
• –section-folder-recursive
• –section-folder
• –section
• –set
• –source-folders
• –support-32bit
• –target-processes-filter
• –target-processes
• –verbose
• –warp-sampling-buffer-size
• –warp-sampling-interval
• –warp-sampling-max-passes

仅当分析单元格时才可使用的NCU CLI标志列表

• –csv
• –devices
• –disable-extra-suffixes
• –filter-mode
• –kernel-id
• –kernel-name-base
• --kernel-name，-k
• --launch-count，-c
• –launch-skip-before-match
• –launch-skip，-s
• –nvtx-exclude
• –nvtx-include
• –page
• –print-details
• –print-fp
• –print-kernel-base
• –print-metric-attribution
• –print-metric-instances
• –print-metric-name
• –print-nvtx-rename
• –print-rule-details
• –print-source
• –print-summary
• –print-units
• –rename-kernels-path
• –rename-kernels
• –resolve-source-file

卸载

要移除扩展，请执行

pip uninstall jupyterlab-nvidia-nsight

故障排除

如果您看到前端扩展，但它没有工作，请检查服务器扩展是否启用

jupyter server extension list

如果已安装并启用了服务器扩展，但您看不到前端扩展，请检查前端扩展是否已安装

jupyter labextension list

已知问题

• 当Nsight Compute启用时，使用“中断内核”命令（通过使用命令面板、内核菜单或停止按钮）中断JupyterLab内核会导致内核终止并重新启动。

发行说明

0.6.0

• 支持在JupyterLab内部显示Nsight Compute UI。
• 修复与Nsight工具UI的键盘交互问题。

0.5.2

• 在项目描述中添加了Nsight Compute部分。
• 在扩展加载时验证服务器连接。

0.5.1

• 初始版本。