BoundOptimizer#

Class Arguments

Argument

Type

Default Value

actor_min

TFloat

actor_max

TFloat

actor_component

Parametrizable

actor_name

TStr

monitor_component

Measurable

monitor_name

TStr

Bold arguments are mandatory. For more documentation on the listed arguments refer to the class definition below. If parameters appear in this list but not in the class definition below, please recursively check the linked base classes for the definition of the parameter.

Inheritance Diagram

Inheritance diagram of atomiq.components.optimizers.BoundOptimizer

Example Component Dictionary

   {
    "optimizers_example": {
        "classname": "atomiq.components.optimizers.BoundOptimizer",
        "arguments": {
            "actor_min": "<mandatory parameter (TFloat)>",
            "actor_max": "<mandatory parameter (TFloat)>",
            "actor_component": "<mandatory parameter (Parametrizable)>",
            "actor_name": "<mandatory parameter (TStr)>",
            "monitor_component": "<mandatory parameter (Measurable)>",
            "monitor_name": "<mandatory parameter (TStr)>"
        }
    }
}

Class Description

class atomiq.components.optimizers.BoundOptimizer(actor_min, actor_max, *args, **kwargs)

Bases: Optimizer

An Optimizer with restrictions on the values of the actor.

Parameters:
  • actor_min (TFloat) -- The minumum value the actor is allowed to take during optimization

  • actor_max (TFloat) -- The maxiumum value the actor is allowed to take during optimization