Skip to content

Optimization Events

Compute steps emit EnOptEvent objects at lifecycle milestones. Event handlers (ResultsHandler, CallbackHandler, etc.) consume these events to track progress, store results, or trigger user logic.

See Working with Results for an example of subscribing to events, and EnOptEventType for the available event types.

ropt.events

Optimization event data structures.

EnOptEvent dataclass

Container for data emitted with optimization workflow events.

Attributes:

Name Type Description
event_type EnOptEventType

Type of event that occurred.

context EnOptContext

Optimizer context associated with the event.

results tuple[Results, ...]

Tuple of result objects associated with the event.

See Optimization Workflows for a detailed description of events and their lifecycle.