smac.acquisition.function.abstract_acquisition_function

Classes

AbstractAcquisitionFunction()

Abstract base class for acquisition function.

Interfaces

class smac.acquisition.function.abstract_acquisition_function.AbstractAcquisitionFunction

Bases: object

Abstract base class for acquisition function.

__call__(configurations)

Compute the acquisition value for a given X.

Parameters:

configurations (list[Configuration]) – The configurations where the acquisition function should be evaluated.

Returns:

Acquisition values for X

Return type:

np.ndarray [N, 1]

property meta: dict[str, Any]

Returns the meta data of the created object.

Return type:

dict[str, Any]

property model: smac.model.abstract_model.AbstractModel | None

Returns the used surrogate model in the acquisition function.

Return type:

Optional[AbstractModel]

property name: str

Returns the full name of the acquisition function.

Return type:

str

update(model, **kwargs)

Updates the acquisition function attributes required for calculation.

This method will be called after fitting the model, but before maximizing the acquisition function. As an examples, EI uses it to update the current fmin. The default implementation only updates the attributes of the acqusition function which are already present.

Calls _update to update the acquisition function attributes.

Parameters:

• model (AbstractModel) – The model which was used to fit the data.

• kwargs (Any) – Additional arguments to update the specific acquisition function.

Return type:

None

previous

smac.acquisition.function

next

smac.acquisition.function.confidence_bound