Initilization and Cleanup

This page describes the methods that handle NVML initialization and cleanup. More...

Functions
nvmlReturn_t DECLDIR	nvmlInit ()
	Initialize NVML by discovering and attaching to all GPU devices in the system.
nvmlReturn_t DECLDIR	nvmlShutdown ()
	Shut down NVML by releasing all GPU resources previously allocated with nvmlInit().

---

Detailed Description

This page describes the methods that handle NVML initialization and cleanup.

It is the user's resonsibility to call nvmlInit() before calling any other methods, and nvmlShutdown() once NVML is no longer being used.

---

Function Documentation

nvmlReturn_t DECLDIR nvmlInit

(

)

Initialize NVML by discovering and attaching to all GPU devices in the system.

This method should be called once before invoking any other methods in the library.

Returns:

• NVML_SUCCESS if NVML has been properly initialized
• NVML_ERROR_ALREADY_INITIALIZED if NVML has already been initialized
• NVML_ERROR_NO_PERMISSION if the user doesn't have permission to talk to any device
• NVML_ERROR_UNKNOWN on any unexpected error

nvmlReturn_t DECLDIR nvmlShutdown

(

)

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

This method should be called after NVML work is done.

Returns:

• NVML_SUCCESS if NVML has been properly shut down
• NVML_ERROR_UNINITIALIZED if the library has not been successfully initialized
• NVML_ERROR_UNKNOWN on any unexpected error