adapt.feature_based.SA

class adapt.feature_based.SA(estimator=None, Xt=None, n_components=None, copy=True, verbose=1, random_state=None, **params)[source]

SA : Subspace Alignment

Linearly align the source domain to the target domain in a reduced PCA subspace of dimension n_components.

Parameters

estimatorsklearn estimator or tensorflow Model (default=None): Estimator used to learn the task. If estimator is None, a LinearRegression instance is used as estimator.
Xtnumpy array (default=None): Target input data.
n_componentsint (default=None): Number of components of the PCA transformation. If None the number of components is equal to the input dimension of X
copyboolean (default=True): Whether to make a copy of estimator or not.
verboseint (default=1): Verbosity level.
random_stateint (default=None): Seed of random generator.
paramskey, value arguments: Arguments given at the different level of the adapt object. It can be, for instance, compile or fit parameters of the estimator or kernel parameters etc… Accepted parameters can be found by calling the method _get_legal_params(params).

References

1: [1] B. Fernando, A. Habrard, M. Sebban, and T. Tuytelaars. “Unsupervised visual domain adaptation using subspace alignment”. In ICCV, 2013.

Examples

>>> from sklearn.linear_model import RidgeClassifier
>>> from adapt.utils import make_classification_da
>>> from adapt.feature_based import SA
>>> Xs, ys, Xt, yt = make_classification_da()
>>> model = SA(RidgeClassifier(), Xt=Xt, random_state=0)
>>> model.fit(Xs, ys)
>>> model.score(Xt, yt)
0.91

Attributes

estimator_object: Fitted estimator.
pca_src_sklearn PCA: Source PCA
pca_tgt_sklearn PCA: Target PCA
M_numpy array: Alignment matrix

Methods

`__init__`([estimator, Xt, n_components, ...])
`fit`(X, y[, Xt, yt, domains])	Fit Adapt Model.
`fit_estimator`(X, y[, sample_weight, ...])	Fit estimator on X, y.
`fit_transform`(Xs, Xt, **kwargs)	Fit embeddings.
`get_metadata_routing`()	Get metadata routing of this object.
`get_params`([deep])	Get parameters for this estimator.
`predict`(X[, domain])	Return estimator predictions after adaptation.
`predict_estimator`(X, **predict_params)	Return estimator predictions for X.
`score`(X, y[, sample_weight, domain])	Return the estimator score.
`set_fit_request`(*[, domains])	Request metadata passed to the `fit` method.
`set_params`(**params)	Set the parameters of this estimator.
`set_predict_request`(*[, domain])	Request metadata passed to the `predict` method.
`set_score_request`(*[, domain, sample_weight])	Request metadata passed to the `score` method.
`set_transform_request`(*[, domain])	Request metadata passed to the `transform` method.
`transform`(X[, domain])	Project X in the target subspace.
`unsupervised_score`(Xs, Xt)	Return unsupervised score.

__init__(estimator=None, Xt=None, n_components=None, copy=True, verbose=1, random_state=None, **params)[source]

fit(X, y, Xt=None, yt=None, domains=None, **fit_params)[source]

Fit Adapt Model.

For feature-based models, the transformation of the input features Xs and Xt is first fitted. In a second stage, the estimator_ is fitted on the transformed features.

For instance-based models, source importance weights are first learned based on Xs, ys and Xt. In a second stage, the estimator_ is fitted on Xs, ys with the learned importance weights.

Parameters

Xnumpy array: Source input data.
ynumpy array: Source output data.
Xtarray (default=None): Target input data. If None, the Xt argument given in init is used.
ytarray (default=None): Target input data. Only needed for supervised and semi-supervised Adapt model. If None, the yt argument given in init is used.
domainsarray (default=None): Vector giving the domain for each source data. Can be used for multisource purpose.
fit_paramskey, value arguments: Arguments given to the fit method of the estimator.

Returns

selfreturns an instance of self

fit_estimator(X, y, sample_weight=None, random_state=None, warm_start=True, **fit_params)[source]

Fit estimator on X, y.

Parameters

Xarray: Input data.
yarray: Output data.
sample_weightarray: Importance weighting.
random_stateint (default=None): Seed of the random generator
warm_startbool (default=True): If True, continue to fit estimator_, else, a new estimator is fitted based on a copy of estimator. (Be sure to set copy=True to use warm_start=False)
fit_paramskey, value arguments: Arguments given to the fit method of the estimator and to the compile method for tensorflow estimator.

Returns

estimator_fitted estimator

fit_transform(Xs, Xt, **kwargs)[source]

Fit embeddings.

Parameters

Xsarray: Input source data.
Xtarray: Input target data.
kwargskey, value argument: Not used, present here for adapt consistency.

Returns

Xs_embembedded source data

get_metadata_routing()[source]

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)[source]

Get parameters for this estimator.

Parameters

deepbool, default=True: Not used, here for scikit-learn compatibility.

Returns

paramsdict: Parameter names mapped to their values.

predict(X, domain=None, **predict_params)[source]

Return estimator predictions after adaptation.

For feature-based method (object which implements a transform method), the input feature X are first transformed. Then the predict method of the fitted estimator estimator_ is applied on the transformed X.

Parameters

Xarray: input data
domainstr (default=None): For antisymetric feature-based method, different transformation of the input X are applied for different domains. The domain should then be specified between “src” and “tgt”. If None the default transformation is the target one.

Returns

y_predarray: prediction of the Adapt Model.

predict_estimator(X, **predict_params)[source]

Return estimator predictions for X.

Parameters

Xarray: input data

Returns

y_predarray: prediction of estimator.

score(X, y, sample_weight=None, domain=None)[source]

Return the estimator score.

If the object has a transform method, the estimator is applied on the transformed features X. For antisymetric transformation, a parameter domain can be set to specified between source and target transformation.

Call score on sklearn estimator and evaluate on tensorflow Model.

Parameters

Xarray: input data
yarray: output data
sample_weightarray (default=None): Sample weights
domainstr (default=None): This parameter specifies for antisymetric feature-based method which transformation will be applied between “source” and “target”. If None the transformation by default is the target one.

Returns

scorefloat: estimator score.

set_fit_request(*, domains: Union[bool, None, str] = '$UNCHANGED$') → adapt.feature_based._sa.SA[source]

Request metadata passed to the fit method.

Note that this method is only relevant if enable_metadata_routing=True (see sklearn.set_config()). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

True: metadata is requested, and passed to fit if provided. The request is ignored if metadata is not provided.
False: metadata is not requested and the meta-estimator will not pass it to fit.
None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.
str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

New in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a Pipeline. Otherwise it has no effect.

Parameters

domainsstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED: Metadata routing for domains parameter in fit.

Returns

selfobject: The updated object.

set_params(**params)[source]

Set the parameters of this estimator.

Parameters

**paramsdict: Estimator parameters.

Returns

selfestimator instance: Estimator instance.

set_predict_request(*, domain: Union[bool, None, str] = '$UNCHANGED$') → adapt.feature_based._sa.SA[source]

Request metadata passed to the predict method.

Note that this method is only relevant if enable_metadata_routing=True (see sklearn.set_config()). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

True: metadata is requested, and passed to predict if provided. The request is ignored if metadata is not provided.
False: metadata is not requested and the meta-estimator will not pass it to predict.
None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.
str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

New in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a Pipeline. Otherwise it has no effect.

Parameters

domainstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED: Metadata routing for domain parameter in predict.

Returns

selfobject: The updated object.

set_score_request(*, domain: Union[bool, None, str] = '$UNCHANGED$', sample_weight: Union[bool, None, str] = '$UNCHANGED$') → adapt.feature_based._sa.SA[source]

Request metadata passed to the score method.

Note that this method is only relevant if enable_metadata_routing=True (see sklearn.set_config()). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

True: metadata is requested, and passed to score if provided. The request is ignored if metadata is not provided.
False: metadata is not requested and the meta-estimator will not pass it to score.
None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.
str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

New in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a Pipeline. Otherwise it has no effect.

Parameters

domainstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED: Metadata routing for domain parameter in score.
sample_weightstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED: Metadata routing for sample_weight parameter in score.

Returns

selfobject: The updated object.

set_transform_request(*, domain: Union[bool, None, str] = '$UNCHANGED$') → adapt.feature_based._sa.SA[source]

Request metadata passed to the transform method.

Note that this method is only relevant if enable_metadata_routing=True (see sklearn.set_config()). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

True: metadata is requested, and passed to transform if provided. The request is ignored if metadata is not provided.
False: metadata is not requested and the meta-estimator will not pass it to transform.
None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.
str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

New in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a Pipeline. Otherwise it has no effect.

Parameters

domainstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED: Metadata routing for domain parameter in transform.

Returns

selfobject: The updated object.

transform(X, domain='tgt')[source]

Project X in the target subspace.

The paramter domain specify if X should be considered as source or target data. As the transformation is assymetric, the source transformation should be applied on source data and the target transformation on target data.

Parameters

Xarray: Input data.
domainstr (default=”tgt”): Choose between "source", "src" or "target", "tgt" feature embedding.

Returns

X_embarray: Embeddings of X.

unsupervised_score(Xs, Xt)[source]

Return unsupervised score.

The normalized discrepancy distance is computed between the reweighted/transformed source input data and the target input data.

Parameters

Xsarray: Source input data.
Xtarray: Source input data.

Returns

scorefloat: Unsupervised score.