skactiveml.pool.BatchBALD#

class skactiveml.pool.BatchBALD(n_MC_samples=None, eps=1e-07, sample_predictions_method_name=None, sample_predictions_dict=None, missing_label=nan, random_state=None)[source]#

Bases: _GeneralBALD

Batch Bayesian Active Learning by Disagreement (BatchBALD)

The Batch Bayesian Active Learning by Disagreement (BatchBALD) [1] strategy reduces the number of possible hypotheses maximally fast to minimize the uncertainty about the parameters using Shannon’s entropy. It seeks the data point that maximises the decrease in expected posterior entropy.

Parameters
n_MC_samplesint > 0, default=n_estimators

The number of monte carlo samples used for label estimation.

epsfloat > 0, default=1e-7

Minimum probability threshold to compute log-probabilities.

sample_predictions_method_namestr, default=None

Certain estimators may offer methods enabling to construct a committee by sampling predictions of committee members. This parameter is to indicate the name of such a method.

  • If sample_predictions_method_name=None no sampling is performed.

  • If sample_predictions_method_name is not None and in the case of classification, the method is expected to take samples of the shape (n_samples, *) as input and to output probabilities of the shape (n_members, n_samples, n_classes), e.g., sample_proba in skactiveml.base.ClassFrequencyEstimator.

sample_predictions_dictdict, default=None

Parameters (excluding the samples) that are passed to the method with the name sample_predictions_method_name.

  • This parameter must be None, if sample_predictions_method_name is None.

  • Otherwise, it may be used to define the number of sampled members, e.g., by defining n_samples as parameter to the method sample_proba of skactiveml.base.ClassFrequencyEstimator.

missing_labelscalar or string or np.nan or None, default=np.nan

Value to represent a missing label.

random_stateint or None or np.random.RandomState, default=None

The random state to use.

References

1

Kirsch, Andreas, Joost Van Amersfoort, and Yarin Gal. “BatchBALD: Efficient and Diverse Batch Acquisition for Deep Bayesian Active Learning.” Advances in Neural Information Processing Systems 32 (2019).

Methods

get_metadata_routing()

Get metadata routing of this object.

get_params([deep])

Get parameters for this estimator.

query(X, y, ensemble[, fit_ensemble, ...])

Determines for which candidate samples labels are to be queried.

set_params(**params)

Set the parameters of this estimator.
get_metadata_routing()#

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Returns
routingMetadataRequest

A MetadataRequest encapsulating routing information.

get_params(deep=True)#

Get parameters for this estimator.

Parameters
deepbool, default=True

If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns
paramsdict

Parameter names mapped to their values.

query(X, y, ensemble, fit_ensemble=True, sample_weight=None, candidates=None, batch_size=1, return_utilities=False)#

Determines for which candidate samples labels are to be queried.

Parameters
Xarray-like of shape (n_samples, n_features)

Training data set, usually complete, i.e. including the labeled and unlabeled samples.

yarray-like of shape (n_samples,)

Labels of the training data set (possibly including unlabeled ones indicated by self.missing_label).

ensemblearray-like of SkactivemlClassifier or SkactivemlClassifier

  • If ensemble is a SkactivemlClassifier and has n_estimators plus estimators_ after fitting as attributes, its estimators will be used as committee.

  • If ensemble is array-like, each element of this list must be SkactivemlClassifier and will be used as committee member.

  • If ensemble is a SkactivemlClassifier and implements a method with the name sample_predictions_method_name, this method is used to sample predictions of committee members.

fit_ensemblebool, default=True

Defines whether the ensemble should be fitted on X, y, and sample_weight.

sample_weight: array-like of shape (n_samples), default=None

Weights of training samples in X.

candidatesNone or array-like of shape (n_candidates), dtype=int or array-like of shape (n_candidates, n_features), default=None

  • If candidates is None, the unlabeled samples from (X,y) are considered as candidates.

  • If candidates is of shape (n_candidates,) and of type int, candidates is considered as the indices of the samples in (X,y).

  • If candidates is of shape (n_candidates, *), the candidate samples are directly given in candidates (not necessarily contained in X). This is not supported by all query strategies.

batch_sizeint, default=1

The number of samples to be selected in one AL cycle.

return_utilitiesbool, default=False

If True, also return the utilities based on the query strategy.

Returns
query_indicesnumpy.ndarray of shape (batch_size)

The query_indices indicate for which candidate sample a label is to queried, e.g., query_indices[0] indicates the first selected sample.

  • If candidates is None or of shape (n_candidates,), the indexing refers to the samples in X.

  • If candidates is of shape (n_candidates, n_features), the indexing refers to the samples in candidates.

utilitiesnumpy.ndarray of shape (batch_size, n_samples) or numpy.ndarray of shape (batch_size, n_candidates)

The utilities of samples after each selected sample of the batch, e.g., utilities[0] indicates the utilities used for selecting the first sample (with index query_indices[0]) of the batch. Utilities for labeled samples will be set to np.nan.

  • If candidates is None or of shape (n_candidates,), the indexing refers to the samples in X.

  • If candidates is of shape (n_candidates, n_features), the indexing refers to the samples in candidates.

set_params(**params)#

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as Pipeline). The latter have parameters of the form <component>__<parameter> so that it’s possible to update each component of a nested object.

Parameters
**paramsdict

Estimator parameters.

Returns
selfestimator instance

Estimator instance.

Examples using skactiveml.pool.BatchBALD#

Batch Bayesian Active Learning by Disagreement (BatchBALD)

Batch Bayesian Active Learning by Disagreement (BatchBALD)