heimdallr.utilities.nvidia.bindings

Created on 29/03/2020

Functions

check_return(ret)

description

friendly_object_to_struct(obj, model)

description

get_func_pointer(name)

description

nvmlDeviceClearAccountingPids(handle)

description

nvmlDeviceClearCpuAffinity(handle)

description

nvmlDeviceClearEccErrorCounts(handle, ...)

description

nvmlDeviceFreezeNvLinkUtilizationCounter(...)

Freeze the NVLINK utilization counters.

nvmlDeviceGetAPIRestriction(device, apiType)

description

nvmlDeviceGetAccountingBufferSize(handle)

description

nvmlDeviceGetAccountingMode(handle)

description

nvmlDeviceGetAccountingPids(handle)

description

nvmlDeviceGetAccountingStats(handle, pid)

description

nvmlDeviceGetApplicationsClock(handle, type)

description

nvmlDeviceGetAutoBoostedClocksEnabled(handle)

description

nvmlDeviceGetBAR1MemoryInfo(handle)

description

nvmlDeviceGetBoardId(handle)

description

nvmlDeviceGetBrand(handle)

description

nvmlDeviceGetBridgeChipInfo(handle)

description

nvmlDeviceGetClockInfo(handle, type)

description

nvmlDeviceGetComputeMode(handle)

description

nvmlDeviceGetComputeRunningProcesses(handle)

description

nvmlDeviceGetCount()

description

nvmlDeviceGetCpuAffinity(handle, cpuSetSize)

description

nvmlDeviceGetCurrPcieLinkGeneration(handle)

description

nvmlDeviceGetCurrPcieLinkWidth(handle)

description

nvmlDeviceGetCurrentClocksThrottleReasons(handle)

description

nvmlDeviceGetCurrentDriverModel(handle)

description

nvmlDeviceGetCurrentEccMode(handle)

description

nvmlDeviceGetCurrentGpuOperationMode(handle)

description

nvmlDeviceGetDecoderUtilization(handle)

description

nvmlDeviceGetDefaultApplicationsClock(...)

description

nvmlDeviceGetDetailedEccErrors(handle, ...)

description

nvmlDeviceGetDisplayActive(handle)

description

nvmlDeviceGetDisplayMode(handle)

description

nvmlDeviceGetDriverModel(handle)

description

nvmlDeviceGetEccMode(handle)

description

nvmlDeviceGetEncoderUtilization(handle)

description

nvmlDeviceGetEnforcedPowerLimit(handle)

description

nvmlDeviceGetFanSpeed(handle)

description

nvmlDeviceGetGpuOperationMode(handle)

description

nvmlDeviceGetGraphicsRunningProcesses(handle)

description

nvmlDeviceGetHandleByIndex(index)

description

nvmlDeviceGetHandleByPciBusId(pciBusId)

description

nvmlDeviceGetHandleBySerial(serial)

description

nvmlDeviceGetHandleByUUID(uuid)

description

nvmlDeviceGetIndex(handle)

description

nvmlDeviceGetInforomConfigurationChecksum(handle)

description

nvmlDeviceGetInforomImageVersion(handle)

description

nvmlDeviceGetInforomVersion(handle, ...)

description

nvmlDeviceGetMaxClockInfo(handle, type)

description

nvmlDeviceGetMaxPcieLinkGeneration(handle)

description

nvmlDeviceGetMaxPcieLinkWidth(handle)

description

nvmlDeviceGetMemoryErrorCounter(handle, ...)

description

nvmlDeviceGetMemoryInfo(handle)

Retrieves memory object.

nvmlDeviceGetMinorNumber(handle)

description

nvmlDeviceGetMultiGpuBoard(handle)

description

nvmlDeviceGetName(handle)

description

nvmlDeviceGetNvLinkCapability(device, link, cap)

Retrieve the capability of a specified NvLinklink.

nvmlDeviceGetNvLinkErrorCounter(device, ...)

Retrieve the specified error counter value.

nvmlDeviceGetNvLinkRemotePciInfo(device, link)

Retrieve the PCI information for the remote node on a NvLink link.

nvmlDeviceGetNvLinkState(device, link)

Retrieve the state of the device's NvLink for the link specified.

nvmlDeviceGetNvLinkUtilizationControl(...)

Get NVLINK utilization counter control information

nvmlDeviceGetNvLinkUtilizationCounter(...)

Retrieve an NVLINK utilization counter.

nvmlDeviceGetNvLinkVersion(device, link)

Retrieve NvLink version.

nvmlDeviceGetPciInfo(handle)

description

nvmlDeviceGetPcieReplayCounter(handle)

description

nvmlDeviceGetPcieThroughput(device, counter)

description

nvmlDeviceGetPendingDriverModel(handle)

description

nvmlDeviceGetPendingEccMode(handle)

description

nvmlDeviceGetPendingGpuOperationMode(handle)

description

nvmlDeviceGetPerformanceState(handle)

description

nvmlDeviceGetPersistenceMode(handle)

description

nvmlDeviceGetPowerManagementDefaultLimit(handle)

description

nvmlDeviceGetPowerManagementLimit(handle)

description

nvmlDeviceGetPowerManagementLimitConstraints(handle)

description

nvmlDeviceGetPowerManagementMode(handle)

description

nvmlDeviceGetPowerState(handle)

description

nvmlDeviceGetPowerUsage(handle)

description

nvmlDeviceGetRetiredPages(device, sourceFilter)

description

nvmlDeviceGetRetiredPagesPendingStatus(device)

description

nvmlDeviceGetSamples(device, sampling_type, ...)

description

nvmlDeviceGetSerial(handle)

description

nvmlDeviceGetSupportedClocksThrottleReasons(handle)

description

nvmlDeviceGetSupportedEventTypes(handle)

description

nvmlDeviceGetSupportedGraphicsClocks(handle, ...)

description

nvmlDeviceGetSupportedMemoryClocks(handle)

description

nvmlDeviceGetTemperature(handle, sensor)

description

nvmlDeviceGetTemperatureThreshold(handle, ...)

description

nvmlDeviceGetTopologyCommonAncestor(device1, ...)

description

nvmlDeviceGetTopologyNearestGpus(device, level)

description

nvmlDeviceGetTotalEccErrors(handle, ...)

description

nvmlDeviceGetTotalEnergyConsumption(handle)

description

nvmlDeviceGetUUID(handle)

description

nvmlDeviceGetUtilizationRates(handle)

description

nvmlDeviceGetVbiosVersion(handle)

description

nvmlDeviceGetViolationStatus(device, ...)

description

nvmlDeviceOnSameBoard(handle1, handle2)

description

nvmlDeviceRegisterEvents(handle, eventTypes, ...)

description

nvmlDeviceResetApplicationsClocks(handle)

description

nvmlDeviceResetNvLinkErrorCounters(device, link)

Reset all error counters to zero.

nvmlDeviceResetNvLinkUtilizationCounter(...)

Reset the NVLINK utilization counters.

nvmlDeviceSetAPIRestriction(handle, apiType, ...)

description

nvmlDeviceSetAccountingMode(handle, mode)

description

nvmlDeviceSetApplicationsClocks(handle, ...)

description

nvmlDeviceSetAutoBoostedClocksEnabled(...)

description

nvmlDeviceSetComputeMode(handle, mode)

description

nvmlDeviceSetCpuAffinity(handle)

description

nvmlDeviceSetDefaultAutoBoostedClocksEnabled(...)

description

nvmlDeviceSetDriverModel(handle, model)

description

nvmlDeviceSetEccMode(handle, mode)

description

nvmlDeviceSetGpuOperationMode(handle, mode)

description

nvmlDeviceSetNvLinkUtilizationControl(...)

Set the NVLINK utilization counter control.

nvmlDeviceSetPersistenceMode(handle, mode)

description

nvmlDeviceSetPowerManagementLimit(handle, limit)

description

nvmlDeviceValidateInforom(handle)

description

nvmlEventSetCreate()

description

nvmlEventSetFree(eventSet)

description

nvmlEventSetWait(eventSet, timeoutms)

description

nvmlInit()

Initialize NVML.

nvmlShutdown()

Shutdown NVML.

nvmlSystemGetDriverVersion()

description

nvmlSystemGetHicVersion()

description

nvmlSystemGetNVMLVersion()

description

nvmlSystemGetProcessName(pid)

description

nvmlSystemGetTopologyGpuSet(cpuNumber)

description

nvmlUnitGetCount()

description

nvmlUnitGetDeviceCount(unit)

description

nvmlUnitGetDevices(unit)

description

nvmlUnitGetFanSpeedInfo(unit)

description

nvmlUnitGetHandleByIndex(index)

description

nvmlUnitGetLedState(unit)

description

nvmlUnitGetPsuInfo(unit)

description

nvmlUnitGetTemperature(unit, type)

description

nvmlUnitGetUnitInfo(unit)

description

nvmlUnitSetLedState(unit, color)

description

nvml_error_string(result)

description

struct_to_friendly_object(struct)

description

Classes

FriendlyObject(dictionary)

description

PrintableStructure

Abstract class that produces nicer __str__ output than ctypes.Structure. e.g. instead of: >>> print str(obj) <class_name object at 0x7fdf82fef9e0> this class will print class_name(field_name: formatted_value, field_name: formatted_value).

c_nvmlAccountingStats_t

c_nvmlBAR1Memory_t

c_nvmlBridgeChipHierarchy_t

c_nvmlBridgeChipInfo_t

c_nvmlDevice_t

alias of LP_struct_c_nvmlDevice_t

c_nvmlEccErrorCounts_t

c_nvmlEventData_t

c_nvmlEventSet_t

alias of LP_struct_c_nvmlEventSet_t

c_nvmlHwbcEntry_t

c_nvmlLedState_t

c_nvmlMemory_t

c_nvmlPSUInfo_t

c_nvmlPciInfo_t

c_nvmlProcessInfo_t

c_nvmlSample_t

c_nvmlUnitFanInfo_t

c_nvmlUnitFanSpeeds_t

c_nvmlUnitInfo_t

c_nvmlUnit_t

alias of LP_struct_c_nvmlUnit_t

c_nvmlUtilization_t

c_nvmlValue_t

c_nvmlViolationTime_t

nvmlPciInfo_t

struct_c_nvmlDevice_t

struct_c_nvmlEventSet_t

struct_c_nvmlUnit_t

Exceptions

NVMLError(value)

description

NVMLError_AlreadyInitialized()

NVMLError_CorruptedInforom()

NVMLError_DriverNotLoaded()

NVMLError_FunctionNotFound()

NVMLError_GpuIsLost()

NVMLError_InsufficientPower()

NVMLError_InsufficientSize()

NVMLError_InvalidArgument()

NVMLError_IrqIssue()

NVMLError_LibRmVersionMismatch()

NVMLError_LibraryNotFound()

NVMLError_NoPermission()

NVMLError_NotFound()

NVMLError_NotSupported()

NVMLError_OperatingSystem()

NVMLError_ResetRequired()

NVMLError_Timeout()

NVMLError_Uninitialized()

NVMLError_Unknown()