atomiq.arguments
================

.. py:module:: atomiq.arguments


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/atomiq/arguments/arguments/index
   /autoapi/atomiq/arguments/json/index


Classes
-------

.. autoapisummary::

   atomiq.arguments.ArgumentProvider
   atomiq.arguments.NativeArgumentProvider


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

.. py:class:: ArgumentProvider

   .. py:attribute:: static_arguments


   .. py:method:: _build_arguments(target_class, arguments = None)
      :abstractmethod:


      Build the argument dict.

      This is intended to be overwritten by subclasses to implement the logic for the respective backend

      :param target_class: The class of the target for which to build the arguments
      :param arguments: arguments to be considered additionally



   .. py:method:: get_arguments(target_class)

      Query the arguments dict from the argument provider.

      :param target_class: The class of the target for which to build the arguments

      :returns: Argument dictionary in the format required by atomiq
      :rtype: dict



   .. py:method:: update_argument(name, arg_def)
      :abstractmethod:


      Update the argument definition in the backend of the argument provider, i.e. store updated values

      :param name: Name or identifier of the argument
      :param arg_def: dict with argument definition to be stored



.. py:class:: NativeArgumentProvider

   Bases: :py:obj:`ArgumentProvider`


   .. py:method:: _build_arguments(target_class, arguments = None)

      Build the argument dict from the `arguments` attribute of the target class.

      This enables to just write a dict with the argument definition in the experiment class

      :param target_class: The class of the target for which to build the arguments
      :param arguments: arguments to be considered additionally