MetadataRouter#

класс sklearn.utils.metadata_routing.MetadataRouter(владелец)[источник]#

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

Этот класс используется мета-оценщики или функции, которые могут маршрутизировать метаданные, для обработки их маршрутизации метаданных. Информация о маршрутизации хранится в структуре, похожей на словарь, вида {"object_name": RouterMappingPair(mapping, router)}, где mapping является экземпляром MethodMapping и router является либо MetadataRequest или другой MetadataRouter экземпляр.

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

Параметры:
владелецobject

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

добавить(*, method_mapping, **объекты)[источник]#

Добавить потребители в MetadataRouter.

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

Параметры:
method_mappingMethodMapping

Соответствие между дочерним (потребитель) и родительского (маршрутизаторметоды.

**objsdict

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

Возвращает:
selfMetadataRouter

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

add_self_request(obj)[источник]#

Добавить self (как потребитель) к MetadataRouter.

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

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

Параметры:
objobject

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

Возвращает:
selfMetadataRouter

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

потребляет(метод, params)[источник]#

Возвращает параметры, использованные как метаданные в маршрутизатор или его под-оценщики.

Этот метод возвращает подмножество params которые потребляются method. A param считается использованным, если он применяется в указанном методе маршрутизатор самого или любого из его подоценщиков (или их подоценщиков).

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

Параметры:
методstr

Название метода, для которого необходимо определить использованные параметры.

paramsитерируемый объект из str

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

Возвращает:
consumed_paramsнабор строк

Подмножество параметров из params которые используются этим методом.

route_params(*, вызывающий, params)[источник]#

Получить значения метаданных, запрошенные потребители.

Возвращает Bunch содержащий метаданные, которые маршрутизатор’s caller метод должен маршрутизировать, организованный каждым потребитель и их соответствующие методы.

Это можно использовать для передачи необходимых метаданных соответствующим методам в потребителях.

Параметры:
вызывающийstr

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

paramsdict

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

Возвращает:
paramsBunch

A Bunch вида {"object_name": {"method_name": {metadata: value}}}.

validate_metadata(*, метод, params)[источник]#

Проверить заданные метаданные для метода.

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

Параметры:
методstr

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

paramsdict

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