5.9. TuningContext

class TuningContext

The hyper parameter accessor.

If user defined its hyper parameter tuner, use this class to retrieve information and set new value for hyper parameters.

Properties

ALM_OBJ	Argument lagrange multipliers value
ALPHA	Over-relaxation alpha
DUAL_INF	Dual residual
ITER_NUM	Iteration number
METRIC1	One metric for dual during solving (|1/rho y - Bz|_inf)
PRIMAL_INF	Primal residual
PRIMAL_OBJ	Primal objective value
RHO	Constraint penalty multiplier
TIME	Solving time(s)
constr_penalty	Constraint penalty factor
over_relaxation_alpha	Over-relaxation factor

property ALM_OBJ: float

Type: float, min: -1e+30, max: 1e+30, settable: true

Argument lagrange multipliers value

property ALPHA: float

Type: float, min: 0.1, max: 1.618, settable: true

Over-relaxation alpha

property DUAL_INF: float

Type: float, min: 0.0, max: 1e+30, settable: true

Dual residual

property ITER_NUM: int

Type: int, min: 0, max: 1000000, settable: false

Iteration number

property METRIC1: float

Type: float, min: 0.0, max: 1e+30, settable: false

One metric for dual during solving (|1/rho y - Bz|_inf)

property PRIMAL_INF: float

Type: float, min: 0.0, max: 1e+30, settable: false

Primal residual

property PRIMAL_OBJ: float

Type: float, min: -1e+30, max: 1e+30, settable: false

Primal objective value

property RHO: float

Type: float, min: 1e-06, max: 1000000.0, settable: false

Constraint penalty multiplier

property TIME: float

Type: float, min: 0.0, max: 100000000.0, settable: false

Solving time(s)

property constr_penalty: float

Type: float, min: 1e-06, max: 1000000.0, settable: false

Constraint penalty factor

property over_relaxation_alpha: float

Type: float, min: 0.1, max: 1.618, settable: true

Over-relaxation factor