atomiq.arguments.arguments module

class atomiq.arguments.arguments.ArgumentProvider

Bases: object

Abstract base class to represent argument providers for experiments.

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

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

class atomiq.arguments.arguments.NativeArgumentProvider

Bases: ArgumentProvider

An argument provider that only returns the arguments defined by the arguments attribute in the target class and joins them with static_arguments (if defined) of this argument provider.

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

static_arguments = {}

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