check_search_predict_delegates¶

def check_search_predict_delegates(
    search_cv,
    y_test: pl.DataFrame,
    X_future: pl.DataFrame | None = None,
    X_forecast: pl.DataFrame | None = None,
) -> None:
    """Check predict() delegates to best_forecaster_.predict() correctly.

    Parameters
    ----------
    search_cv : BaseSearchCV
        Fitted search CV instance
    y_test : pl.DataFrame
        Test target data
    X_future : pl.DataFrame, optional
        Known-future features forwarded to predict()
    X_forecast : pl.DataFrame, optional
        External forecast features forwarded to predict()

    Raises
    ------
    AssertionError
        If predict() doesn't delegate correctly

    """
    forecasting_horizon = min(3, len(y_test))

    # Make predictions from search CV
    y_pred_search = search_cv.predict(forecasting_horizon=forecasting_horizon, X_future=X_future, X_forecast=X_forecast)

    # Make predictions from best_forecaster_ directly
    y_pred_best = search_cv.best_forecaster_.predict(
        forecasting_horizon=forecasting_horizon, X_future=X_future, X_forecast=X_forecast
    )

    # Predictions should be identical
    assert_frame_equal(y_pred_search, y_pred_best, check_exact=False)