process_routing

sklearn.utils.metadata_routing.process_routing(_obj, _method, /, **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 of a router’s fit method: fit(self, X, y, sample_weight=None, **fit_params), a call to this function would be: process_routing(self, "fit", sample_weight=sample_weight, **fit_params).

Note that if routing is not enabled and kwargs is empty, then it returns an empty routing where process_routing(...).ANYTHING.ANY_METHOD is always an empty dictionary.

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

**kwargsdict

Metadata to be routed.

Returns:

routed_paramsBunch

A Bunch of the form {"object_name": {"method_name": {params: value}}} which can be used to pass the required metadata to A Bunch of the form {"object_name": {"method_name": {params: value}}} which can be used to pass the required metadata to corresponding methods or corresponding child objects. The object names are those defined in obj.get_metadata_routing().

Gallery examples

Metadata Routing