NVIDIA Compute Devices Are Not Supported by the OpenCL Version

Problem

Zivid Studio or an application using Zivid SDK fails during initialization with the following error:

Error

An error occurred: Error occurred during initialization: Nvidia compute devices are not supported by the OpenCL version of the Zivid SDK on platform 'windows'.

To use an Nvidia compute device, install the CUDA version of the Zivid SDK.

You can enable this compute device by setting the Config.yml option 'ComputeDevice/AllowUnsupported' to 'yes'.

Note that your compute device is untested by Zivid, and can cause issues such as incorrect results or crashes.

Zivid recommends to only use supported compute devices for production.

For more information, see the knowledge base article https://support.zivid.com/en/latest/getting-started/software-installation/about-gpu.html#selecting-compute-device.

The following compute devices were found on your system: ...

To choose a different compute device than the one selected by the Zivid SDK, set the Config.yml option 'ComputeDevice/SelectionFilter'.

Cause

The OpenCL version of Zivid SDK treats NVIDIA GPUs as an unsupported compute device. This is expected behavior when the OpenCL version of the SDK is installed on a machine with an NVIDIA GPU.

Solution

Recommended: install the CUDA version

Uninstall the OpenCL version of the SDK and install the CUDA version instead, which supports NVIDIA GPUs without any extra configuration. See Software Installation for installation instructions.

Alternative: allow the unsupported compute device

If you want to keep using the OpenCL version of the SDK on an NVIDIA GPU, download the Config.yml file and place it in the following directory:

Windows

mkdir %LOCALAPPDATA%\Zivid\API
move %HOMEPATH%\Downloads\Config.yml %LOCALAPPDATA%\Zivid\API\

Ubuntu

mkdir --parents "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/API
mv ~/Downloads/Config.yml "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/API/

The config file sets Vendor to Nvidia and AllowUnsupported to yes:

__version__:
    serializer: 1
    data: 19
Configuration:
    ComputeDevice:
        Type: GPU
        Vendor: Nvidia
        AllowUnsupported: yes