NVML API Reference Guide (PDF) - vR384 (older) - Last updated October 31, 2017 - Send Feedback

2.11. Initialization and Cleanup

This chapter describes the methods that handle NVML initialization and cleanup. It is the user's responsibility to call nvmlInit() before calling any other methods, and nvmlShutdown() once NVML is no longer being used.

Defines

#define NVML_INIT_FLAG_NO_GPUS 1
Don't fail nvmlInit() when no GPUs are found.

Functions

nvmlReturn_t nvmlInit ( void )
nvmlReturn_t nvmlInitWithFlags ( unsigned int  flags )
nvmlReturn_t nvmlShutdown ( void )

Defines

#define NVML_INIT_FLAG_NO_GPUS 1

Functions

nvmlReturn_t nvmlInit ( void )
Returns

Description

Initialize NVML, but don't initialize any GPUs yet.

Note:
  • nvmlInit_v3 introduces a "flags" argument, that allows passing boolean values modifying the behaviour of nvmlInit().

  • In NVML 5.319 new nvmlInit_v2 has replaced nvmlInit"_v1" (default in NVML 4.304 and older) that did initialize all GPU devices in the system.

This allows NVML to communicate with a GPU when other GPUs in the system are unstable or in a bad state. When using this API, GPUs are discovered and initialized in nvmlDeviceGetHandleBy* functions instead.

Note:

To contrast nvmlInit_v2 with nvmlInit"_v1", NVML 4.304 nvmlInit"_v1" will fail when any detected GPU is in a bad or unstable state.

ALL_PRODUCTS%

This method, should be called once before invoking any other methods in the library. A reference count of the number of initializations is maintained. Shutdown only occurs when the reference count reaches zero.

nvmlReturn_t nvmlInitWithFlags ( unsigned int  flags )
Parameters
flags
behaviour modifier flags
Returns

Description

nvmlInitWithFlags is a variant of nvmlInit(), that allows passing a set of boolean values modifying the behaviour of nvmlInit(). Other than the "flags" parameter it is completely similar to nvmlInit.

ALL_PRODUCTS%

nvmlReturn_t nvmlShutdown ( void )
Returns

Description

Shut down NVML by releasing all GPU resources previously allocated with nvmlInit().

ALL_PRODUCTS%

This method should be called after NVML work is done, once for each call to nvmlInit() A reference count of the number of initializations is maintained. Shutdown only occurs when the reference count reaches zero. For backwards compatibility, no error is reported if nvmlShutdown() is called more times than nvmlInit().


NVML API Reference Guide (PDF) - vR384 (older) - Last updated October 31, 2017 - Send Feedback