元数据路由#
本文档展示了如何在 scikit-learn 中使用 元数据路由机制 将元数据路由到使用它们的估计器、评分器和 CV 分割器。
为了更好地理解以下文档，我们需要介绍两个概念：路由器和消费者。路由器是一个将给定数据和元数据转发到其他对象的物体。在大多数情况下，路由器是一个 元估计器，即一个将另一个估计器作为参数的估计器。像 sklearn.model_selection.cross_validate 这样的函数，它将估计器作为参数并转发数据和元数据，也是一个路由器。
另一方面，消费者是一个接受并使用给定元数据的物体。例如，一个在它的 fit 方法中考虑 sample_weight 的估计器是 sample_weight 的消费者。
一个物体可以同时是路由器和消费者。例如，元估计器可能会在某些计算中考虑 sample_weight，但它也可能会将其路由到底层估计器。
首先，一些导入和一些用于脚本其余部分的随机数据。
import warnings
from pprint import pprint
import numpy as np
from sklearn import set_config
from sklearn.base import (
BaseEstimator,
ClassifierMixin,
MetaEstimatorMixin,
RegressorMixin,
TransformerMixin,
clone,
)
from sklearn.linear_model import LinearRegression
from sklearn.utils import metadata_routing
from sklearn.utils.metadata_routing import (
MetadataRouter,
MethodMapping,
get_routing_for_object,
process_routing,
)
from sklearn.utils.validation import check_is_fitted
n_samples, n_features = 100, 4
rng = np.random.RandomState(42)
X = rng.rand(n_samples, n_features)
y = rng.randint(0, 2, size=n_samples)
my_groups = rng.randint(0, 10, size=n_samples)
my_weights = rng.rand(n_samples)
my_other_weights = rng.rand(n_samples)
元数据路由只有在明确启用时才可用
set_config(enable_metadata_routing=True)
此实用程序函数是一个虚拟函数，用于检查是否传递了元数据
def check_metadata(obj, **kwargs):
for key, value in kwargs.items():
if value is not None:
print(
f"Received {key} of length = {len(value)} in {obj.__class__.__name__}."
)
else:
print(f"{key} is None in {obj.__class__.__name__}.")
一个实用程序函数，用于很好地打印对象的路由信息
def print_routing(obj):
pprint(obj.get_metadata_routing()._serialize())
使用估计器#
这里我们演示了估计器如何公开所需的 API 来支持元数据路由作为消费者。想象一个简单的分类器，它在它的 fit 方法中接受 sample_weight 作为元数据，并在它的 predict 方法中接受 groups
class ExampleClassifier(ClassifierMixin, BaseEstimator):
def fit(self, X, y, sample_weight=None):
check_metadata(self, sample_weight=sample_weight)
# all classifiers need to expose a classes_ attribute once they're fit.
self.classes_ = np.array([0, 1])
return self
def predict(self, X, groups=None):
check_metadata(self, groups=groups)
# return a constant value of 1, not a very smart classifier!
return np.ones(len(X))
上面的估计器现在拥有了它需要的所有内容来使用元数据。这是通过在 BaseEstimator 中进行的一些魔术操作实现的。现在，上面的类公开了三个方法：set_fit_request、set_predict_request 和 get_metadata_routing。还有一个用于 sample_weight 的 set_score_request，它存在是因为 ClassifierMixin 实现了一个接受 sample_weight 的 score 方法。同样适用于从 RegressorMixin 继承的回归器。
默认情况下，不请求任何元数据，我们可以看到
print_routing(ExampleClassifier())
{'fit': {'sample_weight': None},
'predict': {'groups': None},
'score': {'sample_weight': None}}
上面的输出意味着 ExampleClassifier 不请求 sample_weight 和 groups，如果路由器给出了这些元数据，它应该抛出错误，因为用户没有明确设置它们是否需要。对于 score 方法中的 sample_weight 也是如此，它是从 ClassifierMixin 继承的。为了明确设置这些元数据的请求值，我们可以使用这些方法
est = (
ExampleClassifier()
.set_fit_request(sample_weight=False)
.set_predict_request(groups=True)
.set_score_request(sample_weight=False)
)
print_routing(est)
{'fit': {'sample_weight': False},
'predict': {'groups': True},
'score': {'sample_weight': False}}
注意
请注意，只要上面的估计器没有在元估计器中使用，用户就不需要为元数据设置任何请求，并且设置的值会被忽略，因为消费者不会验证或路由给定的元数据。对上面估计器的简单使用将按预期工作。
est = ExampleClassifier()
est.fit(X, y, sample_weight=my_weights)
est.predict(X[:3, :], groups=my_groups)
Received sample_weight of length = 100 in ExampleClassifier.
Received groups of length = 100 in ExampleClassifier.
array([1., 1., 1.])
路由元估计器#
现在，我们展示如何设计一个元估计器来成为一个路由器。作为一个简化的例子，这里有一个元估计器，它除了路由元数据之外什么也不做。
class MetaClassifier(MetaEstimatorMixin, ClassifierMixin, BaseEstimator):
def __init__(self, estimator):
self.estimator = estimator
def get_metadata_routing(self):
# This method defines the routing for this meta-estimator.
# In order to do so, a `MetadataRouter` instance is created, and the
# routing is added to it. More explanations follow below.
router = MetadataRouter(owner=self.__class__.__name__).add(
estimator=self.estimator,
method_mapping=MethodMapping()
.add(caller="fit", callee="fit")
.add(caller="predict", callee="predict")
.add(caller="score", callee="score"),
)
return router
def fit(self, X, y, **fit_params):
# `get_routing_for_object` returns a copy of the `MetadataRouter`
# constructed by the above `get_metadata_routing` method, that is
# internally called.
request_router = get_routing_for_object(self)
# Meta-estimators are responsible for validating the given metadata.
# `method` refers to the parent's method, i.e. `fit` in this example.
request_router.validate_metadata(params=fit_params, method="fit")
# `MetadataRouter.route_params` maps the given metadata to the metadata
# required by the underlying estimator based on the routing information
# defined by the MetadataRouter. The output of type `Bunch` has a key
# for each consuming object and those hold keys for their consuming
# methods, which then contain key for the metadata which should be
# routed to them.
routed_params = request_router.route_params(params=fit_params, caller="fit")
# A sub-estimator is fitted and its classes are attributed to the
# meta-estimator.
self.estimator_ = clone(self.estimator).fit(X, y, **routed_params.estimator.fit)
self.classes_ = self.estimator_.classes_
return self
def predict(self, X, **predict_params):
check_is_fitted(self)
# As in `fit`, we get a copy of the object's MetadataRouter,
request_router = get_routing_for_object(self)
# then we validate the given metadata,
request_router.validate_metadata(params=predict_params, method="predict")
# and then prepare the input to the underlying `predict` method.
routed_params = request_router.route_params(
params=predict_params, caller="predict"
)
return self.estimator_.predict(X, **routed_params.estimator.predict)
让我们分解上面代码的不同部分。
首先，get_routing_for_object 获取我们的元估计器 (self) 并返回一个 MetadataRouter 或，如果对象是消费者，则返回一个 MetadataRequest，这取决于估计器的 get_metadata_routing 方法的输出。
然后，在每个方法中，我们使用 route_params 方法构建一个字典，形式为 {"object_name": {"method_name": {"metadata": value}}}，传递给底层估计器的相应方法。 object_name（在上面的 routed_params.estimator.fit 示例中为 estimator）与在 get_metadata_routing 中添加的名称相同。 validate_metadata 确保所有给定的元数据都被请求，以避免静默错误。
接下来，我们将说明不同的行为，特别是引发的错误类型。
meta_est = MetaClassifier(
estimator=ExampleClassifier().set_fit_request(sample_weight=True)
)
meta_est.fit(X, y, sample_weight=my_weights)
Received sample_weight of length = 100 in ExampleClassifier.
请注意，上面的示例通过 ExampleClassifier 调用我们的实用函数 check_metadata()。它检查 sample_weight 是否正确传递给它。如果它没有传递，就像下面的示例一样，它会打印 sample_weight 为 None
meta_est.fit(X, y)
sample_weight is None in ExampleClassifier.
如果我们传递一个未知的元数据，就会引发错误
try:
meta_est.fit(X, y, test=my_weights)
except TypeError as e:
print(e)
MetaClassifier.fit got unexpected argument(s) {'test'}, which are not routed to any object.
如果我们传递一个没有明确请求的元数据
try:
meta_est.fit(X, y, sample_weight=my_weights).predict(X, groups=my_groups)
except ValueError as e:
print(e)
Received sample_weight of length = 100 in ExampleClassifier.
[groups] are passed but are not explicitly set as requested or not requested for ExampleClassifier.predict, which is used within MetaClassifier.predict. Call `ExampleClassifier.set_predict_request({metadata}=True/False)` for each metadata you want to request/ignore.
同样，如果我们明确将其设置为未请求，但它被提供
meta_est = MetaClassifier(
estimator=ExampleClassifier()
.set_fit_request(sample_weight=True)
.set_predict_request(groups=False)
)
try:
meta_est.fit(X, y, sample_weight=my_weights).predict(X[:3, :], groups=my_groups)
except TypeError as e:
print(e)
Received sample_weight of length = 100 in ExampleClassifier.
MetaClassifier.predict got unexpected argument(s) {'groups'}, which are not routed to any object.
另一个需要介绍的概念是 **别名元数据**。当估计器请求的元数据变量名与默认变量名不同时，就会出现这种情况。例如，在一个管道中有两个估计器的设置中，一个估计器可以请求 sample_weight1，另一个估计器可以请求 sample_weight2。请注意，这不会改变估计器期望的内容，它只是告诉元估计器如何将提供的元数据映射到所需的内容。以下是一个示例，我们向元估计器传递 aliased_sample_weight，但元估计器理解 aliased_sample_weight 是 sample_weight 的别名，并将其作为 sample_weight 传递给底层估计器
meta_est = MetaClassifier(
estimator=ExampleClassifier().set_fit_request(sample_weight="aliased_sample_weight")
)
meta_est.fit(X, y, aliased_sample_weight=my_weights)
Received sample_weight of length = 100 in ExampleClassifier.
在这里传递 sample_weight 会失败，因为它使用别名请求，并且没有请求名为 sample_weight 的元数据
try:
meta_est.fit(X, y, sample_weight=my_weights)
except TypeError as e:
print(e)
MetaClassifier.fit got unexpected argument(s) {'sample_weight'}, which are not routed to any object.
这将我们引入了 get_metadata_routing。scikit-learn 中的路由工作方式是，消费者请求他们需要的东西，路由器将这些东西传递过去。此外，路由器会公开它自己所需的内容，以便它可以在另一个路由器中使用，例如网格搜索对象中的管道。 get_metadata_routing 的输出是一个 MetadataRouter 的字典表示，它包含所有嵌套对象请求的元数据的完整树及其相应的路由方法，即元估计器的哪个方法在元估计器的哪个方法中使用
print_routing(meta_est)
{'estimator': {'mapping': [{'callee': 'fit', 'caller': 'fit'},
{'callee': 'predict', 'caller': 'predict'},
{'callee': 'score', 'caller': 'score'}],
'router': {'fit': {'sample_weight': 'aliased_sample_weight'},
'predict': {'groups': None},
'score': {'sample_weight': None}}}}
如您所见，方法 fit 唯一请求的元数据是 "sample_weight"，别名为 "aliased_sample_weight"。 ~utils.metadata_routing.MetadataRouter 类使我们能够轻松地创建路由对象，该对象将创建我们 get_metadata_routing 所需的输出。
为了理解别名在元估计器中的工作原理，假设我们的元估计器在另一个元估计器中
meta_meta_est = MetaClassifier(estimator=meta_est).fit(
X, y, aliased_sample_weight=my_weights
)
Received sample_weight of length = 100 in ExampleClassifier.
在上面的示例中，这是 meta_meta_est 的 fit 方法调用其子估计器的 fit 方法的方式
# user feeds `my_weights` as `aliased_sample_weight` into `meta_meta_est`:
meta_meta_est.fit(X, y, aliased_sample_weight=my_weights):
...
# the first sub-estimator (`meta_est`) expects `aliased_sample_weight`
self.estimator_.fit(X, y, aliased_sample_weight=aliased_sample_weight):
...
# the second sub-estimator (`est`) expects `sample_weight`
self.estimator_.fit(X, y, sample_weight=aliased_sample_weight):
...
使用和路由元估计器#
对于一个稍微复杂的示例，考虑一个元估计器，它像以前一样将元数据路由到底层估计器，但它还在自己的方法中使用了一些元数据。这个元估计器同时是消费者和路由器。实现一个与我们之前的方法非常相似，但有一些调整。
class RouterConsumerClassifier(MetaEstimatorMixin, ClassifierMixin, BaseEstimator):
def __init__(self, estimator):
self.estimator = estimator
def get_metadata_routing(self):
router = (
MetadataRouter(owner=self.__class__.__name__)
# defining metadata routing request values for usage in the meta-estimator
.add_self_request(self)
# defining metadata routing request values for usage in the sub-estimator
.add(
estimator=self.estimator,
method_mapping=MethodMapping()
.add(caller="fit", callee="fit")
.add(caller="predict", callee="predict")
.add(caller="score", callee="score"),
)
)
return router
# Since `sample_weight` is used and consumed here, it should be defined as
# an explicit argument in the method's signature. All other metadata which
# are only routed, will be passed as `**fit_params`:
def fit(self, X, y, sample_weight, **fit_params):
if self.estimator is None:
raise ValueError("estimator cannot be None!")
check_metadata(self, sample_weight=sample_weight)
# We add `sample_weight` to the `fit_params` dictionary.
if sample_weight is not None:
fit_params["sample_weight"] = sample_weight
request_router = get_routing_for_object(self)
request_router.validate_metadata(params=fit_params, method="fit")
routed_params = request_router.route_params(params=fit_params, caller="fit")
self.estimator_ = clone(self.estimator).fit(X, y, **routed_params.estimator.fit)
self.classes_ = self.estimator_.classes_
return self
def predict(self, X, **predict_params):
check_is_fitted(self)
# As in `fit`, we get a copy of the object's MetadataRouter,
request_router = get_routing_for_object(self)
# we validate the given metadata,
request_router.validate_metadata(params=predict_params, method="predict")
# and then prepare the input to the underlying ``predict`` method.
routed_params = request_router.route_params(
params=predict_params, caller="predict"
)
return self.estimator_.predict(X, **routed_params.estimator.predict)
上述元估计器与我们之前的元估计器不同的关键部分是，在 fit 中明确接受 sample_weight 并将其包含在 fit_params 中。由于 sample_weight 是一个显式参数，我们可以确定此方法存在 set_fit_request(sample_weight=...)。元估计器既是消费者，也是 sample_weight 的路由器。
在 get_metadata_routing 中，我们使用 add_self_request 将 self 添加到路由中，以指示此估计器正在使用 sample_weight 并且是路由器；这也将 $self_request 键添加到路由信息中，如下所示。现在让我们看一些示例
没有请求元数据
meta_est = RouterConsumerClassifier(estimator=ExampleClassifier())
print_routing(meta_est)
{'$self_request': {'fit': {'sample_weight': None},
'score': {'sample_weight': None}},
'estimator': {'mapping': [{'callee': 'fit', 'caller': 'fit'},
{'callee': 'predict', 'caller': 'predict'},
{'callee': 'score', 'caller': 'score'}],
'router': {'fit': {'sample_weight': None},
'predict': {'groups': None},
'score': {'sample_weight': None}}}}
子估计器请求
sample_weight
meta_est = RouterConsumerClassifier(
estimator=ExampleClassifier().set_fit_request(sample_weight=True)
)
print_routing(meta_est)
{'$self_request': {'fit': {'sample_weight': None},
'score': {'sample_weight': None}},
'estimator': {'mapping': [{'callee': 'fit', 'caller': 'fit'},
{'callee': 'predict', 'caller': 'predict'},
{'callee': 'score', 'caller': 'score'}],
'router': {'fit': {'sample_weight': True},
'predict': {'groups': None},
'score': {'sample_weight': None}}}}
元估计器请求
sample_weight
meta_est = RouterConsumerClassifier(estimator=ExampleClassifier()).set_fit_request(
sample_weight=True
)
print_routing(meta_est)
{'$self_request': {'fit': {'sample_weight': True},
'score': {'sample_weight': None}},
'estimator': {'mapping': [{'callee': 'fit', 'caller': 'fit'},
{'callee': 'predict', 'caller': 'predict'},
{'callee': 'score', 'caller': 'score'}],
'router': {'fit': {'sample_weight': None},
'predict': {'groups': None},
'score': {'sample_weight': None}}}}
请注意上面请求的元数据表示之间的差异。
我们还可以对元数据进行别名处理，以便向元估计器和子估计器的拟合方法传递不同的值
meta_est = RouterConsumerClassifier(
estimator=ExampleClassifier().set_fit_request(sample_weight="clf_sample_weight"),
).set_fit_request(sample_weight="meta_clf_sample_weight")
print_routing(meta_est)
{'$self_request': {'fit': {'sample_weight': 'meta_clf_sample_weight'},
'score': {'sample_weight': None}},
'estimator': {'mapping': [{'callee': 'fit', 'caller': 'fit'},
{'callee': 'predict', 'caller': 'predict'},
{'callee': 'score', 'caller': 'score'}],
'router': {'fit': {'sample_weight': 'clf_sample_weight'},
'predict': {'groups': None},
'score': {'sample_weight': None}}}}
但是，元估计器的 fit 方法只需要子估计器的别名，并将自己的样本权重作为 sample_weight 处理，因为它不会验证和路由自己的所需元数据
meta_est.fit(X, y, sample_weight=my_weights, clf_sample_weight=my_other_weights)
Received sample_weight of length = 100 in RouterConsumerClassifier.
Received sample_weight of length = 100 in ExampleClassifier.
仅在子估计器上使用别名
当我们不希望元估计器使用元数据，但子估计器应该使用时，这很有用。
meta_est = RouterConsumerClassifier(
estimator=ExampleClassifier().set_fit_request(sample_weight="aliased_sample_weight")
)
print_routing(meta_est)
{'$self_request': {'fit': {'sample_weight': None},
'score': {'sample_weight': None}},
'estimator': {'mapping': [{'callee': 'fit', 'caller': 'fit'},
{'callee': 'predict', 'caller': 'predict'},
{'callee': 'score', 'caller': 'score'}],
'router': {'fit': {'sample_weight': 'aliased_sample_weight'},
'predict': {'groups': None},
'score': {'sample_weight': None}}}}
元估计器无法使用 aliased_sample_weight，因为它期望它作为 sample_weight 传递。即使在元估计器上设置了 set_fit_request(sample_weight=True)，也会发生这种情况。
简单管道#
一个稍微复杂一点的用例是一个类似于 Pipeline 的元估计器。这是一个元估计器，它接受一个转换器和一个分类器。当调用其 fit 方法时，它会应用转换器的 fit 和 transform，然后在转换后的数据上运行分类器。在 predict 时，它会应用转换器的 transform，然后在转换后的新数据上使用分类器的 predict 方法进行预测。
class SimplePipeline(ClassifierMixin, BaseEstimator):
def __init__(self, transformer, classifier):
self.transformer = transformer
self.classifier = classifier
def get_metadata_routing(self):
router = (
MetadataRouter(owner=self.__class__.__name__)
# We add the routing for the transformer.
.add(
transformer=self.transformer,
method_mapping=MethodMapping()
# The metadata is routed such that it retraces how
# `SimplePipeline` internally calls the transformer's `fit` and
# `transform` methods in its own methods (`fit` and `predict`).
.add(caller="fit", callee="fit")
.add(caller="fit", callee="transform")
.add(caller="predict", callee="transform"),
)
# We add the routing for the classifier.
.add(
classifier=self.classifier,
method_mapping=MethodMapping()
.add(caller="fit", callee="fit")
.add(caller="predict", callee="predict"),
)
)
return router
def fit(self, X, y, **fit_params):
routed_params = process_routing(self, "fit", **fit_params)
self.transformer_ = clone(self.transformer).fit(
X, y, **routed_params.transformer.fit
)
X_transformed = self.transformer_.transform(
X, **routed_params.transformer.transform
)
self.classifier_ = clone(self.classifier).fit(
X_transformed, y, **routed_params.classifier.fit
)
return self
def predict(self, X, **predict_params):
routed_params = process_routing(self, "predict", **predict_params)
X_transformed = self.transformer_.transform(
X, **routed_params.transformer.transform
)
return self.classifier_.predict(
X_transformed, **routed_params.classifier.predict
)
请注意使用 MethodMapping 来声明子估计器（被调用者）的哪些方法在元估计器（调用者）的哪些方法中使用。如您所见，SimplePipeline 在 fit 中使用转换器的 transform 和 fit 方法，并在 predict 中使用其 transform 方法，这就是您在管道类路由结构中看到的实现。
上述示例与之前示例的另一个区别是使用 process_routing，它处理输入参数，进行必要的验证，并返回我们在之前示例中创建的 routed_params。这减少了开发人员在每个元估计器方法中需要编写的样板代码。强烈建议开发人员使用此函数，除非有充分的理由不使用它。
为了测试上述管道，让我们添加一个示例转换器。
class ExampleTransformer(TransformerMixin, BaseEstimator):
def fit(self, X, y, sample_weight=None):
check_metadata(self, sample_weight=sample_weight)
return self
def transform(self, X, groups=None):
check_metadata(self, groups=groups)
return X
def fit_transform(self, X, y, sample_weight=None, groups=None):
return self.fit(X, y, sample_weight).transform(X, groups)
请注意，在上面的示例中，我们已经实现了 fit_transform，它使用适当的元数据调用 fit 和 transform。这只有在 transform 接受元数据时才需要，因为 TransformerMixin 中的默认 fit_transform 实现不会将元数据传递给 transform。
现在我们可以测试我们的管道，并查看元数据是否正确传递。此示例使用我们的 SimplePipeline、我们的 ExampleTransformer 以及我们的 RouterConsumerClassifier，它使用我们的 ExampleClassifier。
pipe = SimplePipeline(
transformer=ExampleTransformer()
# we set transformer's fit to receive sample_weight
.set_fit_request(sample_weight=True)
# we set transformer's transform to receive groups
.set_transform_request(groups=True),
classifier=RouterConsumerClassifier(
estimator=ExampleClassifier()
# we want this sub-estimator to receive sample_weight in fit
.set_fit_request(sample_weight=True)
# but not groups in predict
.set_predict_request(groups=False),
)
# and we want the meta-estimator to receive sample_weight as well
.set_fit_request(sample_weight=True),
)
pipe.fit(X, y, sample_weight=my_weights, groups=my_groups).predict(
X[:3], groups=my_groups
)
Received sample_weight of length = 100 in ExampleTransformer.
Received groups of length = 100 in ExampleTransformer.
Received sample_weight of length = 100 in RouterConsumerClassifier.
Received sample_weight of length = 100 in ExampleClassifier.
Received groups of length = 100 in ExampleTransformer.
groups is None in ExampleClassifier.
array([1., 1., 1.])
弃用/默认值更改#
在本节中，我们将展示如何处理路由器也成为消费者的情况，尤其是当它与子估计器使用相同的元数据时，或者消费者开始使用它在旧版本中没有使用的元数据时。在这种情况下，应该发出警告一段时间，让用户知道行为与以前版本不同。
class MetaRegressor(MetaEstimatorMixin, RegressorMixin, BaseEstimator):
def __init__(self, estimator):
self.estimator = estimator
def fit(self, X, y, **fit_params):
routed_params = process_routing(self, "fit", **fit_params)
self.estimator_ = clone(self.estimator).fit(X, y, **routed_params.estimator.fit)
def get_metadata_routing(self):
router = MetadataRouter(owner=self.__class__.__name__).add(
estimator=self.estimator,
method_mapping=MethodMapping().add(caller="fit", callee="fit"),
)
return router
如上所述，如果 my_weights 不应该作为 sample_weight 传递给 MetaRegressor，则这是一个有效的用法。
reg = MetaRegressor(estimator=LinearRegression().set_fit_request(sample_weight=True))
reg.fit(X, y, sample_weight=my_weights)
现在假设我们进一步开发 MetaRegressor，它现在也使用 sample_weight
class WeightedMetaRegressor(MetaEstimatorMixin, RegressorMixin, BaseEstimator):
# show warning to remind user to explicitly set the value with
# `.set_{method}_request(sample_weight={boolean})`
__metadata_request__fit = {"sample_weight": metadata_routing.WARN}
def __init__(self, estimator):
self.estimator = estimator
def fit(self, X, y, sample_weight=None, **fit_params):
routed_params = process_routing(
self, "fit", sample_weight=sample_weight, **fit_params
)
check_metadata(self, sample_weight=sample_weight)
self.estimator_ = clone(self.estimator).fit(X, y, **routed_params.estimator.fit)
def get_metadata_routing(self):
router = (
MetadataRouter(owner=self.__class__.__name__)
.add_self_request(self)
.add(
estimator=self.estimator,
method_mapping=MethodMapping().add(caller="fit", callee="fit"),
)
)
return router
上述实现与 MetaRegressor 几乎相同，并且由于在 __metadata_request__fit 中定义的默认请求值，因此在拟合时会发出警告。
with warnings.catch_warnings(record=True) as record:
WeightedMetaRegressor(
estimator=LinearRegression().set_fit_request(sample_weight=False)
).fit(X, y, sample_weight=my_weights)
for w in record:
print(w.message)
Received sample_weight of length = 100 in WeightedMetaRegressor.
Support for sample_weight has recently been added to this class. To maintain backward compatibility, it is ignored now. Using `set_fit_request(sample_weight={True, False})` on this method of the class, you can set the request value to False to silence this warning, or to True to consume and use the metadata.
当估计器使用它之前没有使用的元数据时，可以使用以下模式来警告用户。
class ExampleRegressor(RegressorMixin, BaseEstimator):
__metadata_request__fit = {"sample_weight": metadata_routing.WARN}
def fit(self, X, y, sample_weight=None):
check_metadata(self, sample_weight=sample_weight)
return self
def predict(self, X):
return np.zeros(shape=(len(X)))
with warnings.catch_warnings(record=True) as record:
MetaRegressor(estimator=ExampleRegressor()).fit(X, y, sample_weight=my_weights)
for w in record:
print(w.message)
sample_weight is None in ExampleRegressor.
Support for sample_weight has recently been added to this class. To maintain backward compatibility, it is ignored now. Using `set_fit_request(sample_weight={True, False})` on this method of the class, you can set the request value to False to silence this warning, or to True to consume and use the metadata.
最后，我们禁用元数据路由的配置标志。
set_config(enable_metadata_routing=False)
第三方开发和 scikit-learn 依赖项#
如上所述，信息使用 MetadataRequest 和 MetadataRouter 在类之间进行通信。强烈建议不要这样做，但如果严格希望拥有一个与 scikit-learn 兼容的估计器，而不依赖于 scikit-learn 包，则可以将与元数据路由相关的工具进行供应商化。如果满足以下所有条件，则您无需修改任何代码。
您的估计器继承自
BaseEstimator您的估计器方法（例如
fit）使用的参数在方法签名中明确定义，而不是*args或*kwargs。您的估计器不会将任何元数据路由到底层对象，即它不是路由器。
脚本的总运行时间：（0 分钟 0.050 秒）
相关示例
