Excluded GPU Queries#
This chapter describes NVML operations that are associated with excluded GPUs.
Functions#
- nvmlReturn_t nvmlGetExcludedDeviceCount(unsigned int *deviceCount)
Retrieves the number of excluded GPU devices in the system.
- nvmlReturn_t nvmlGetExcludedDeviceInfoByIndex(unsigned int index, nvmlExcludedDeviceInfo_t *info)
Acquire the device information for an excluded GPU device, based on its index.
Structs#
- nvmlExcludedDeviceInfo_t
Excluded GPU device information.
Functions#
-
nvmlReturn_t nvmlGetExcludedDeviceCount(unsigned int *deviceCount)#
Retrieves the number of excluded GPU devices in the system.
For all products.
- Parameters:
deviceCount – Reference in which to return the number of excluded devices
- Returns:
NVML_SUCCESS if deviceCount has been set
NVML_ERROR_INVALID_ARGUMENT if deviceCount is NULL
- nvmlReturn_t nvmlGetExcludedDeviceInfoByIndex(
- unsigned int index,
- nvmlExcludedDeviceInfo_t *info,
Acquire the device information for an excluded GPU device, based on its index.
For all products.
Valid indices are derived from the deviceCount returned by nvmlGetExcludedDeviceCount(). For example, if deviceCount is 2 the valid indices are 0 and 1, corresponding to GPU 0 and GPU 1.
See also
- Parameters:
index – The index of the target GPU, >= 0 and < deviceCount
info – Reference in which to return the device information
- Returns:
NVML_SUCCESS if device has been set
NVML_ERROR_INVALID_ARGUMENT if index is invalid or info is NULL