qNegIntegratedPosteriorVariance

class baybe.acquisition.acqfs.qNegIntegratedPosteriorVariance[source]

Bases: AcquisitionFunction

Monte Carlo based negative integrated posterior variance.

This is typically used for active learning as it is a measure for global model uncertainty.

Public methods

__init__([sampling_n_points, ...])

Method generated by attrs for class qNegIntegratedPosteriorVariance.

from_dict(dictionary)

Create an object from its dictionary representation.

from_json(string)

Create an object from its JSON representation.

get_integration_points(searchspace)

Sample points from a search space for integration purposes.

to_botorch(surrogate, searchspace, train_x, ...)

Create the botorch-ready representation of the function.

to_dict()

Create an object's dictionary representation.

to_json()

Create an object's JSON representation.

Public attributes and properties

sampling_n_points

Number of data points sampled for integrating the posterior.

sampling_fraction

Fraction of data sampled for integrating the posterior.

sampling_method

Sampling strategy used for integrating the posterior.

abbreviation

An alternative name for type resolution.

is_mc

__init__(sampling_n_points: int | None = None, sampling_fraction=NOTHING, sampling_method=DiscreteSamplingMethod.Random)

Method generated by attrs for class qNegIntegratedPosteriorVariance.

For details on the parameters, see Public attributes and properties.

classmethod from_dict(dictionary: dict)

Create an object from its dictionary representation.

Parameters:

dictionary (dict) – The dictionary representation.

Return type:

TypeVar(_T)

Returns:

The reconstructed object.

classmethod from_json(string: str)

Create an object from its JSON representation.

Parameters:

string (str) – The JSON representation of the object.

Return type:

TypeVar(_T)

Returns:

The reconstructed object.

get_integration_points(searchspace: SearchSpace)[source]

Sample points from a search space for integration purposes.

Sampling of the discrete part can be controlled via ‘sampling_method’, but sampling of the continuous part will always be random.

Parameters:

searchspace (SearchSpace) – The searchspace from which to sample integration points.

Return type:

DataFrame

Returns:

The sampled data points.

Raises:

ValueError – If the search space is purely continuous and ‘sampling_n_points’ was not provided.

to_botorch(surrogate: Surrogate, searchspace: SearchSpace, train_x: DataFrame, train_y: DataFrame)

Create the botorch-ready representation of the function.

to_dict()

Create an object’s dictionary representation.

Return type:

dict

to_json()

Create an object’s JSON representation.

Return type:

str

Returns:

The JSON representation as a string.

abbreviation: ClassVar[str] = 'qNIPV'

An alternative name for type resolution.

sampling_fraction: float | None

Fraction of data sampled for integrating the posterior.

Cannot be used if sampling_n_points is not None.

sampling_method: DiscreteSamplingMethod

Sampling strategy used for integrating the posterior.

sampling_n_points: int | None

Number of data points sampled for integrating the posterior.

Cannot be used if sampling_fraction is not None.