Created on 05 May, 2018 @author: Tomasz Kacprzak
Bases: BaseEstimator
, RegressorMixin
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.
Added 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.
Metadata routing for method
parameter in fit
.
Metadata routing for var_y
parameter in fit
.
The updated object.
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.
Added 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.
Metadata routing for batch_size
parameter in predict
.
The updated object.
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.
Added 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.
Metadata routing for sample_weight
parameter in score
.
The updated object.
Bases: ValueError
Raised when trying to fit an underdetermined model.