pyeeg.models.TRFEstimator.set_score_request

TRFEstimator.set_score_request(*, Xtest: bool | None | str = '$UNCHANGED$', reduce_multi: bool | None | str = '$UNCHANGED$', scoring: bool | None | str = '$UNCHANGED$', ytrue: bool | None | str = '$UNCHANGED$') → TRFEstimator

Request metadata passed to the score method.

Note that this method is only relevant if enable_metadata_routing=True (see sklearn.set_config()). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

  • True: metadata is requested, and passed to score if provided. The request is ignored if metadata is not provided.

  • False: metadata is not requested and the meta-estimator will not pass it to score.

  • None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.

  • str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

Added in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a Pipeline. Otherwise it has no effect.

Parameters:

  • Xtest (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – Metadata routing for Xtest parameter in score.

  • reduce_multi (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – Metadata routing for reduce_multi parameter in score.

  • scoring (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – Metadata routing for scoring parameter in score.

  • ytrue (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – Metadata routing for ytrue parameter in score.

Returns:

self – The updated object.

Return type:

object