MetadataRouter

classsklearn.utils.metadata_routing.MetadataRouter(owner)[source]

Хранит и обрабатывает маршрутизацию метаданных для объекта маршрутизатора.

Этот класс используется объектами маршрутизаторов для хранения и обработки маршрутизации метаданных. Информация о маршрутизации хранится в виде словаря следующего формата {"object_name": RouteMappingPair(method_mapping, routing_info)}, где method_mapping — экземпляр MethodMapping, а routing_info — либо экземпляр MetadataRequest, либо экземпляр MetadataRouter.

Добавлен в версии 1.3.

Параметры:

ownerstr

Имя объекта, которому принадлежат эти запросы.

add(*, method_mapping, **objs)[source]

Добавление объектов с соответствующей картой методов.

Параметры:

method_mappingMethodMapping

Сопоставление методов дочернего и родительского объектов.

**objsdict

Словарь объектов, из которых извлекаются метаданные путем вызова get_routing_for_object на них.

Возвращаемое значение:

selfMetadataRouter

Возвращает self.

add_self_request(obj)[source]

Добавление self (в качестве потребителя) в маршрутизацию.

Этот метод используется, если маршрутизатор также является потребителем, и, следовательно, сам маршрутизатор должен быть включен в маршрутизацию. Передаваемый объект может быть оценщиком или MetadataRequest.

Маршрутизатор должен добавлять себя с помощью этого метода, а не add, поскольку он должен обрабатываться иначе, чем другие объекты, которым метаданные маршрутизируются маршрутизатором.

Параметры:

objobject

Обычно это экземпляр маршрутизатора, т. е. self в реализации get_metadata_routing(). Он также может быть экземпляром MetadataRequest.

Возвращаемое значение:

selfMetadataRouter

Возвращает self.

consumes(method, params)[source]

Проверка, потребляются ли данные параметров заданным методом.

Добавлен в версии 1.4.

Параметры:

methodstr

Имя метода для проверки.

paramsiterable of str

Итерируемый объект строк для проверки.

Возвращаемое значение:

consumedset of str

Множество параметров, потребляемых заданным методом.

route_params(*, caller, params)[source]

Возвращает параметры ввода, запрашиваемые дочерними объектами.

Выход этого метода — Bunch, который включает метаданные для всех методов каждого дочернего объекта, используемого в методе caller маршрутизатора.

Если маршрутизатор также является потребителем, он также проверяет предупреждения о запрошенных метаданных self/потребителя.

Параметры:

callerstr

Имя метода, для которого запрашиваются и маршрутизируются параметры. Если вызывается внутри метода fit маршрутизатора, это будет "fit".

paramsdict

Словарь предоставленных метаданных.

Возвращаемое значение:

paramsBunch

Bunch в формате {"object_name": {"method_name": {params: value}}}, который можно использовать для передачи необходимых метаданных соответствующим методам или соответствующим дочерним объектам.

validate_metadata(*, method, params)[source]

Проверка переданных метаданных для метода.

Выбрасывает TypeError, если некоторые из переданных метаданных не понятны дочерним объектам.

Параметры:

methodstr

Имя метода, для которого запрашиваются и маршрутизируются параметры. Если вызывается внутри метода fit маршрутизатора, это будет "fit".

paramsdict

Словарь предоставленных метаданных.

Примеры галереи

Маршрутизация метаданных