cbx.scheduler.param_update

class cbx.scheduler.param_update(name='alpha', maximum=100000.0, minimum=1e-05)

Bases: object

Base class for parameter updates

This class implements the base class for parameter updates.

Parameters:

• name (str) – The name of the parameter that should be updated. The default is ‘alpha’.

• maximum (float) – The maximum value of the parameter. The default is 1e5.

update(dyn)

Updates the object with the given dyn parameter.

Parameters:

dyn – The dynamic of which the parameter should be updated.

Return type:

None

ensure_max(dyn)

Ensures that the parameter does not exceed its maximum value.