Skip to content

check_estimator_parameter

yohou.testing.reduction.check_estimator_parameter(forecaster)

Check estimator parameter is sklearn BaseEstimator.

Parameters

Name Type Description Default
forecaster BaseReductionForecaster

Reduction forecaster instance

required

Raises

Type Description
AssertionError

If estimator is not a sklearn BaseEstimator

Source Code

Show/Hide source
def check_estimator_parameter(forecaster) -> None:
    """Check estimator parameter is sklearn BaseEstimator.

    Parameters
    ----------
    forecaster : BaseReductionForecaster
        Reduction forecaster instance

    Raises
    ------
    AssertionError
        If estimator is not a sklearn BaseEstimator

    """
    assert hasattr(forecaster, "estimator"), "Reduction forecaster must have 'estimator' parameter"

    estimator = forecaster.estimator
    assert isinstance(estimator, BaseEstimator), f"estimator should be sklearn BaseEstimator, got {type(estimator)}"