aiq.builder.front_end#

Classes#

FrontEndBase

Helper class that provides a standard way to create an ABC using

Module Contents#

class FrontEndBase(full_config: aiq.data_models.config.AIQConfig)#

Bases: Generic[aiq.data_models.front_end.FrontEndConfigT], abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Initializes the FrontEndBase object with the specified AIQ Toolkit configuration.

Parameters#

full_configAIQConfig

The configuration object to use for the front end.

_full_config: aiq.data_models.config.AIQConfig#
_front_end_config: aiq.data_models.front_end.FrontEndConfigT#
property front_end_config: aiq.data_models.front_end.FrontEndConfigT#

Returns the front end configuration object extracted from the AIQ Toolkit configuration.

Returns#

FrontEndConfigT

The front end configuration object.

property full_config: aiq.data_models.config.AIQConfig#

Returns the full AIQ Toolkit configuration object.

Returns#

AIQConfig

The full AIQ Toolkit configuration object.

abstractmethod run()#
Async:

Runs the specified configuration file, launching the workflow until the front end is complete.