Skip to content

[BUG]: Replace obsolete Nsight GUI utility names with nsys-ui and ncu-ui #2654

Description

@isVoid

Problem

cuda.pathfinder.SUPPORTED_BINARY_UTILITIES currently includes the legacy GUI names nsight-sys and nsight-compute, but omits the executable names used by supported Nsight releases: nsys-ui and ncu-ui.

Because find_nvidia_binary_utility() treats the requested name literally (and appends .exe on Windows), calls using the legacy names return None on a current standalone Nsight installation even though the corresponding GUI is installed.

The CLI entries nsys and ncu are correct and should remain unchanged.

Evidence

These legacy names predate the CUDA Toolkit majors currently covered by cuda.pathfinder's “two most recent major versions” support policy.

Proposed change

  1. Replace nsight-sys with nsys-ui and nsight-compute with ncu-ui in the supported binary descriptors.
  2. Preserve nsys and ncu as the CLI utility names.
  3. Add standalone Windows discovery through the existing Nsight registry roots:
    • Nsight Systems: locate nsys-ui.exe under the host directory (for example, host-windows-x64).
    • Nsight Compute: locate the root shortcut and/or the actual executable under host/windows-desktop-*/ncu-ui.exe.
  4. Add tests for wheel/Conda layouts and standalone Windows layouts.

If removing names from the public supported tuple is considered too disruptive, a compatibility alternative is to retain the old inputs temporarily as deprecated aliases that resolve to the current UI executable, while documenting that the returned basename differs.

Expected behavior

find_nvidia_binary_utility("nsys-ui")  # absolute path to nsys-ui[.exe]
find_nvidia_binary_utility("ncu-ui")   # absolute path to ncu-ui[.exe]
find_nvidia_binary_utility("nsys")     # unchanged
find_nvidia_binary_utility("ncu")      # unchanged

Metadata

Metadata

Assignees

No one assigned

    Labels

    triageNeeds the team's attention

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions