Observables

Observables represent additional outputs from the objective function that are recorded for analysis but not used directly for optimization.

Each entry in VOCS.observables is a key–value pair where:

key — observable name (string)
value — a shorthand or longhand definition.

Examples

Shorthand forms:

from gest_api.vocs import VOCS

# As a set of names
vocs = VOCS(observables={"temp", "pressure"})

# As a dictionary with explicit types
vocs = VOCS(observables={"temp": "float", "pressure": "float"})

# Explicit object type form
vocs = VOCS(observables={"temp": {"type": "Observable", "dtype": float}})

Longhand form:

from gest_api.vocs import Observable, VOCS

obs = Observable(dtype=float)
vocs = VOCS(observables={"temp": obs})

Associated classes:

class gest_api.vocs.Observable(*, dtype=None)

Parameters:: dtype (str | Type | Tuple | None)

Note

The dtype (data type) field for any parameter can be set according to https://numpy.org/doc/stable/reference/arrays.dtypes.html. The type specified must be supported by the generator.

By default, the dtype value is None, which means the variable is a scalar with a type determined by the generator.