sklearn.utils.metadata_routing.process_routing¶
- sklearn.utils.metadata_routing.process_routing(obj, method, other_params, **kwargs)[source]¶
Validate and route input parameters.
This function is used inside a router’s method, e.g. fit, to validate the metadata and handle the routing.
Assuming this signature:
fit(self, X, y, sample_weight=None, **fit_params), a call to this function would be:process_routing(self, fit_params, sample_weight=sample_weight).New in version 1.3.
- Parameters:
- objobject
An object implementing
get_metadata_routing. Typically a meta-estimator.- methodstr
The name of the router’s method in which this function is called.
- other_paramsdict
A dictionary of extra parameters passed to the router’s method, e.g.
**fit_paramspassed to a meta-estimator’s fit.- **kwargsdict
Parameters explicitly accepted and included in the router’s method signature.
- Returns:
- routed_paramsBunch
A
Bunchof the form{"object_name": {"method_name": {prop: value}}}which can be used to pass the required metadata to corresponding methods or corresponding child objects. The object names are those defined inobj.get_metadata_routing().
