atomiq.arguments

Submodules

Classes

ArgumentProvider

NativeArgumentProvider

Package Contents

class atomiq.arguments.ArgumentProvider[source]
static_arguments
abstractmethod _build_arguments(target_class, arguments=None)[source]

Build the argument dict.

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

Parameters:

  • target_class (type) -- The class of the target for which to build the arguments

  • arguments (Optional[dict]) -- arguments to be considered additionally

Return type:

dict

get_arguments(target_class)[source]

Query the arguments dict from the argument provider.

Parameters:

target_class (type) -- The class of the target for which to build the arguments

Returns:

Argument dictionary in the format required by atomiq

Return type:

dict

abstractmethod update_argument(name, arg_def)[source]

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

Parameters:

  • name (str) -- Name or identifier of the argument

  • arg_def (dict) -- dict with argument definition to be stored

class atomiq.arguments.NativeArgumentProvider[source]

Bases: ArgumentProvider

_build_arguments(target_class, arguments=None)[source]

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

Parameters:

  • target_class (type) -- The class of the target for which to build the arguments

  • arguments (Optional[dict]) -- arguments to be considered additionally

Return type:

dict

static_arguments
get_arguments(target_class)

Query the arguments dict from the argument provider.

Parameters:

target_class (type) -- The class of the target for which to build the arguments

Returns:

Argument dictionary in the format required by atomiq

Return type:

dict

abstractmethod update_argument(name, arg_def)

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

Parameters:

  • name (str) -- Name or identifier of the argument

  • arg_def (dict) -- dict with argument definition to be stored