pyhelios.ParameterOptimization.Parameter Class Reference

A single optimizable parameter. More...

Detailed Description

A single optimizable parameter.

Parameters

value	Initial value
min	Lower bound. Ignored for CATEGORICAL parameters.
max	Upper bound. Ignored for CATEGORICAL parameters.
type	Parameter kind
categories	Allowed values, required for CATEGORICAL parameters

Definition at line 62 of file ParameterOptimization.py.

Collaboration diagram for pyhelios.ParameterOptimization.Parameter:

Public Member Functions
"Parameter"	continuous (cls, float value, float min, float max)
	Create a continuous parameter bounded by [min, max].
"Parameter"	integer (cls, float value, float min, float max)
	Create an integer parameter bounded by [min, max].
"Parameter"	categorical (cls, float value, Sequence[float] categories)
	Create a parameter restricted to an explicit set of values.

Static Public Attributes
float	min = 0.0
float	max = 0.0
ParameterType	type = ParameterType.FLOAT
tuple	categories = ()

Member Function Documentation

categorical()

"Parameter" pyhelios.ParameterOptimization.Parameter.categorical	(		cls,
		float	value,
		Sequence[float]	categories )

Create a parameter restricted to an explicit set of values.

Definition at line 82 of file ParameterOptimization.py.

continuous()

"Parameter" pyhelios.ParameterOptimization.Parameter.continuous	(		cls,
		float	value,
		float	min,
		float	max )

Create a continuous parameter bounded by [min, max].

Definition at line 72 of file ParameterOptimization.py.

integer()

"Parameter" pyhelios.ParameterOptimization.Parameter.integer	(		cls,
		float	value,
		float	min,
		float	max )

Create an integer parameter bounded by [min, max].

Definition at line 77 of file ParameterOptimization.py.

Member Data Documentation

categories

tuple pyhelios.ParameterOptimization.Parameter.categories = ()

static

Definition at line 68 of file ParameterOptimization.py.

max

float pyhelios.ParameterOptimization.Parameter.max = 0.0

static

Definition at line 66 of file ParameterOptimization.py.

min

float pyhelios.ParameterOptimization.Parameter.min = 0.0

static

Definition at line 65 of file ParameterOptimization.py.

type

ParameterType pyhelios.ParameterOptimization.Parameter.type = ParameterType.FLOAT

static

Definition at line 67 of file ParameterOptimization.py.

---

The documentation for this class was generated from the following file:

• pyhelios/ParameterOptimization.py