MetadataRequest

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

Контейнер для хранения информации о запросе метаданных и связанного с ним потребителя (owner).

В этом классе для каждого доступного метода в MetadataRequest(owner=obj).{method} используются экземпляры MethodMetadataRequest.

У каждого потребителя в scikit-learn есть атрибут _metadata_request, представляющий собой MetadataRequest.

Подробнее о разработке пользовательских оценщиков, способных маршрутизировать метаданные, читайте в руководстве по разработке маршрутизации метаданных.

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

Параметры:

ownerobject

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

Примеры

>>> from sklearn import set_config
>>> set_config(enable_metadata_routing=True)
>>> from pprint import pprint
>>> from sklearn.utils.metadata_routing import MetadataRequest
>>> r = MetadataRequest(owner="any_object")
>>> r.fit.add_request(param="sample_weight", alias=True)
{'sample_weight': True}
>>> r.score.add_request(param="sample_weight", alias=False)
{'sample_weight': False}
>>> pprint(r)
{'fit': {'sample_weight': True}, 'score': {'sample_weight': False}}
>>> set_config(enable_metadata_routing=False)

consumes(method, params)[source]

Возвращает параметры, используемые в качестве метаданных потребителем (потребителем).

Этот метод возвращает подмножество заданных params, которые используются указанным method. Его можно использовать, чтобы проверить, используются ли параметры в качестве метаданных в указанном методе потребителя, которому принадлежит этот экземпляр MetadataRequest.

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

Параметры:

methodstr

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

paramsiterable of str

Итерируемый объект с названиями параметров, использование которых нужно проверить.

Возвращает:

consumed_paramsset of str

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