GreedySamplingX#

class skactiveml.pool.GreedySamplingX(metric=None, metric_dict=None, missing_label=nan, random_state=None, target_type='auto')[source]#

Bases: SingleAnnotatorPoolQueryStrategy

Greedy Sampling in the Feature Space (GSx)

This class implements the query strategy Greedy Sampling in the Feature Space (GSx) [1]. It selects candidates that maximize the minimum distance to labeled samples and samples already selected in the batch. Without labeled samples, the first selected sample minimizes the sum of distances to the samples in X. Originally, this query strategy was only proposed for regression. Nevertheless, it is task-agnostic such that it can handle class labels, numerical targets, and multilabel targets represented by a two-dimensional y.

Parameters:
metricstr, default=”euclidean”

Metric used for calculating the distances of the samples in the feature space. It must be a valid argument for sklearn.metrics.pairwise_distances argument metric.

metric_dictdict, default=None

Any further parameters are passed directly to the pairwise_distances function.

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

Value to represent a missing label.

random_stateint or np.random.RandomState, default=None

Random state for candidate selection.

target_type“auto” or “single-output” or “multi-label”, default=”auto”

Declared target structure. Automatic resolution accepts only single-output targets. Multi-label targets must be declared explicitly.

References

[1]

D. Wu, C.-T. Lin, and J. Huang. Active Learning for Regression using Greedy Sampling. Inf. Sci., 474:90–105, 2019.

Methods

query(X, y[, candidates, batch_size, ...])

Query the next samples to be labeled.

get_metadata_routing()

Get metadata routing of this object.

get_params([deep])

Get parameters for this estimator.

set_params(**params)

Set the parameters of this estimator.

GreedySamplingX.query(X, y, candidates=None, batch_size=1, return_utilities=False)[source]#

Query the next samples to be labeled.

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,) or (n_samples, n_outputs)

Labels of the training data set (possibly including unlabeled ones indicated by self.missing_label). If y is two-dimensional, a row y[i] must either contain only observed labels or only missing_label values, i.e., no mixing within a row.

candidatesNone or array-like of shape (n_candidates, ) of type int, 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). Labeled candidates remain eligible and also serve as initial centers.

  • If candidates is of shape (n_candidates, …), the candidate samples are directly given in candidates (not necessarily contained in X).

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 be 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)

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 samples outside the candidate set and samples already selected in the batch are set to np.nan.

  • If candidates is None, the indexing refers to the samples in X.

  • If candidates is of shape (n_candidates,) and of type int, utilities refers to the samples in X.

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

GreedySamplingX.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.

GreedySamplingX.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.

GreedySamplingX.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.GreedySamplingX#

Greedy Sampling on the Feature Space (GSx)

Greedy Sampling on the Feature Space (GSx)