Plugin Bases

ropt.plugins.backend.BackendPlugin

Bases: Plugin

Abstract Base Class for Backend Plugins (Factories).

This class defines the interface for plugins responsible for creating Backend instances. These plugins act as factories for specific optimization algorithms or backends.

create abstractmethod classmethod

create(backend_config: BackendConfig) -> Backend

Create an Backend instance.

This abstract class method serves as a factory for creating concrete Backend objects. Plugin implementations must override this method to return an instance of their specific Backend subclass.

The PluginManager calls this method when an optimization workflow requires an optimizer provided by this plugin.

Parameters:

Name	Type	Description	Default
backend_config	BackendConfig	The configuration object containing the backend settings.	required

Returns:

Type	Description
Backend	An initialized instance of an Backend subclass.

ropt.plugins.function_estimator.FunctionEstimatorPlugin

Bases: Plugin

Abstract Base Class for Function Estimator Plugins (Factories).

This class defines the interface for plugins responsible for creating FunctionEstimator instances. These plugins act as factories for specific function estimation strategies.

During optimization execution, the PluginManager identifies the appropriate function estimator plugin based on the configuration and uses its create class method to instantiate the actual FunctionEstimator object that will perform the aggregation of ensemble results (function values and gradients).

create abstractmethod classmethod

create(
    estimator_config: FunctionEstimatorConfig,
) -> FunctionEstimator

Factory method to create a concrete FunctionEstimator instance.

This abstract class method serves as a factory for creating concrete FunctionEstimator objects. Plugin implementations must override this method to return an instance of their specific FunctionEstimator subclass.

The PluginManager calls this method when the optimization requires a function estimator provided by this plugin.

Parameters:

Name	Type	Description	Default
estimator_config	FunctionEstimatorConfig	The configuration object for this function estimator.	required

Returns:

Type	Description
FunctionEstimator	An initialized FunctionEstimator object ready for use.

ropt.plugins.realization_filter.RealizationFilterPlugin

Bases: Plugin

Abstract Base Class for Realization Filter Plugins (Factories).

This class defines the interface for plugins responsible for creating RealizationFilter instances. These plugins act as factories for specific realization filtering strategies.

create abstractmethod classmethod

create(
    filter_config: RealizationFilterConfig,
) -> RealizationFilter

Factory method to create a concrete RealizationFilter instance.

This abstract class method serves as a factory for creating concrete RealizationFilter objects. Plugin implementations must override this method to return an instance of their specific RealizationFilter subclass.

The PluginManager calls this method when an optimization requires realization weights calculated by this plugin.

Parameters:

Name	Type	Description	Default
filter_config	RealizationFilterConfig	The configuration object for this realization filter.	required

Returns:

Type	Description
RealizationFilter	An initialized RealizationFilter object ready for use.

ropt.plugins.sampler.SamplerPlugin

Bases: Plugin

Abstract Base Class for Sampler Plugins (Factories).

This class defines the interface for plugins responsible for creating Sampler instances. These plugins act as factories for specific sampling algorithms or strategies.

create abstractmethod classmethod

create(sampler_config: SamplerConfig) -> Sampler

Factory method to create a concrete Sampler instance.

This abstract class method serves as a factory for creating concrete Sampler objects. Plugin implementations must override this method to return an instance of their specific Sampler subclass.

The PluginManager calls this method when an optimization requires samples generated by this plugin.

Parameters:

Name	Type	Description	Default
sampler_config	SamplerConfig	The sampler configuration object.	required

Returns:

Type	Description
Sampler	An initialized Sampler object ready for use.

ropt.plugins.transforms.VariableTransformPlugin

Bases: Plugin

Abstract Base Class for Variable Transform Plugins (Factories).

This class defines the interface for plugins responsible for creating VariableTransform instances. These plugins act as factories for specific variable transformation algorithms or strategies.

create abstractmethod classmethod

create(
    config: VariableTransformConfig,
) -> VariableTransform

Factory method to create a concrete VariableTransform instance.

This abstract class method serves as a factory for creating concrete VariableTransform objects. Plugin implementations must override this method to return an instance of their specific VariableTransform subclass.

The PluginManager calls this method when an optimization requires variable transformations provided by this plugin.

Parameters:

Name	Type	Description	Default
config	VariableTransformConfig	The variable transform configuration object.	required

Returns:

Type	Description
VariableTransform	An initialized VariableTransform object ready for use.

ropt.plugins.transforms.ObjectiveTransformPlugin

Bases: Plugin

Abstract Base Class for Objective Transform Plugins (Factories).

This class defines the interface for plugins responsible for creating ObjectiveTransform instances. These plugins act as factories for specific objective transformation algorithms or strategies.

create abstractmethod classmethod

create(
    config: ObjectiveTransformConfig,
) -> ObjectiveTransform

Factory method to create a concrete ObjectiveTransform instance.

This abstract class method serves as a factory for creating concrete ObjectiveTransform objects. Plugin implementations must override this method to return an instance of their specific ObjectiveTransform subclass.

The PluginManager calls this method when an optimization requires objective transformations provided by this plugin.

Parameters:

Name	Type	Description	Default
config	ObjectiveTransformConfig	The objective transform configuration object.	required

Returns:

Type	Description
ObjectiveTransform	An initialized ObjectiveTransform object ready for use.

ropt.plugins.transforms.NonlinearConstraintTransformPlugin

Bases: Plugin

Abstract Base Class for Nonlinear Constraint Transform Plugins (Factories).

This class defines the interface for plugins responsible for creating NonlinearConstraintTransform instances. These plugins act as factories for specific nonlinear constraint transformation algorithms or strategies.

create abstractmethod classmethod

create(
    config: NonlinearConstraintTransformConfig,
) -> NonlinearConstraintTransform

Factory method to create a concrete NonlinearConstraintTransform instance.

This abstract class method serves as a factory for creating concrete NonlinearConstraintTransform objects. Plugin implementations must override this method to return an instance of their specific NonlinearConstraintTransform subclass.

The PluginManager calls this method when an optimization requires nonlinear constraint transformations provided by this plugin.

Parameters:

Name	Type	Description	Default
config	NonlinearConstraintTransformConfig	The nonlinear constraint transform configuration object.	required

Returns:

Type	Description
NonlinearConstraintTransform	An initialized NonlinearConstraintTransform object ready for use.