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

.. py:module:: perun.backend

.. autoapi-nested-parse::

   Backend module.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/perun/backend/backend/index
   /autoapi/perun/backend/nvml/index
   /autoapi/perun/backend/powercap_rapl/index
   /autoapi/perun/backend/psutil/index
   /autoapi/perun/backend/rocmsmi/index
   /autoapi/perun/backend/util/index


Functions
---------

.. autoapisummary::

   perun.backend.getBackendMetadata
   perun.backend.getHostMetadata


Package Contents
----------------

.. py:function:: getBackendMetadata(backends: Dict[str, perun.backend.backend.Backend], sensors: Dict[str, Tuple[str]]) -> Dict[str, Any]

   Get backend related metadata dictionary based on the current sensor configuration.

   :param backends: Dictionary with available backends
   :type backends: dict[str, Backend]
   :param sensors: Sensor backend configuration to include in the metadata object.
   :type sensors: Dict[str, Tuple[str]]

   :returns: Backend metadata dictionary.
   :rtype: Dict[str, Any]


.. py:function:: getHostMetadata() -> Dict[str, Any]

   Return dictionary with the platform related metadata.

   :returns: Dictionary with host metadata.
   :rtype: Dict[str, Any]