Skip to content

Abstract acquisition function

smac.acquisition.function.abstract_acquisition_function #

AbstractAcquisitionFunction #

AbstractAcquisitionFunction()

Abstract base class for acquisition function.

Source code in smac/acquisition/function/abstract_acquisition_function.py 
23
24
def __init__(self) -> None:
    self._model: AbstractModel | None = None

meta property #

meta: dict[str, Any]

Returns the meta data of the created object.

model property writable #

model: AbstractModel | None

Return the used surrogate model in the acquisition function.

name property #

name: str

Returns the full name of the acquisition function.

__call__ #

__call__(configurations: list[Configuration]) -> ndarray

Compute the acquisition value for a given configuration.

Parameters#

configurations : list[Configuration] The configurations where the acquisition function should be evaluated.

Returns#

np.ndarray [N, 1] Acquisition values for X

Source code in smac/acquisition/function/abstract_acquisition_function.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
def __call__(self, configurations: list[Configuration]) -> np.ndarray:
    """Compute the acquisition value for a given configuration.

    Parameters
    ----------
    configurations : list[Configuration]
        The configurations where the acquisition function should be evaluated.

    Returns
    -------
    np.ndarray [N, 1]
        Acquisition values for X
    """
    X = convert_configurations_to_array(configurations)
    if len(X.shape) == 1:
        X = X[np.newaxis, :]

    acq = self._compute(X)
    if np.any(np.isnan(acq)):
        idx = np.where(np.isnan(acq))[0]
        acq[idx, :] = -np.finfo(float).max

    return acq

update #

update(model: AbstractModel, **kwargs: Any) -> None

Update 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 acquisition 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.

Source code in smac/acquisition/function/abstract_acquisition_function.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def update(self, model: AbstractModel, **kwargs: Any) -> None:
    """Update 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 acquisition 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.
    """
    self.model = model
    self._update(**kwargs)