perun.backend.nvml
==================

.. py:module:: perun.backend.nvml

.. autoapi-nested-parse::

   Nvidia Mangement Library Source definition.



Attributes
----------

.. autoapisummary::

   perun.backend.nvml.log


Classes
-------

.. autoapisummary::

   perun.backend.nvml.NVMLBackend


Module Contents
---------------

.. py:data:: log

.. py:class:: NVMLBackend

   Bases: :py:obj:`perun.backend.backend.Backend`


   NVMLSource class.

   Setups connection to NVML and creates relevant devices


   .. py:attribute:: id
      :value: 'nvlm'



   .. py:attribute:: name
      :value: 'NVIDIA ML'



   .. py:attribute:: description
      :type:  str
      :value: 'Access GPU information from NVML python bindings'



   .. py:method:: setup() -> None

      Init pynvml and gather number of devices.



   .. py:method:: close() -> None

      Backend shutdown code.



   .. py:method:: availableSensors() -> dict[str, tuple]

      Return a dictionary with all available sensors.

      Each entry contains the backend id and type of sensor.

      :returns: Dictionary with device ids and measurement unit.
      :rtype: dict[str, tuple]



   .. py:method:: getSensors(deviceList: set[str]) -> list[perun.data_model.sensor.Sensor]

      Gather sensor object based on a set of device ids.

      :param deviceList: Set containing divice ids.
      :type deviceList: set[str]

      :returns: List with Sensor objects.
      :rtype: list[Sensor]