tests/testthat/test-algo-temporal_hierarchy.R

In modeltime: The Tidymodels Extension for Time Series Modeling

# ---- HIERARCHICAL REG ----
context("TEST temporal_hierarchy: thief")


# TESTS
test_that("thief", {

    skip_on_cran()

    # temporal_hierarchy: thief, Test Model Fit Object ----

    # SETUP ----

    # Data
    m750 <- timetk::m4_monthly %>% dplyr::filter(id == "M750")

    # Split Data 80/20
    splits <- rsample::initial_time_split(m750, prop = 0.9)

    # Model Spec
    model_spec <- temporal_hierarchy() %>%
        parsnip::set_engine("thief")


    # HIERARCHICAL PARSNIP ----

    # * NO XREGS ----

    # Fit Spec
    model_fit <- model_spec %>%
        fit(log(value) ~ date, data = rsample::training(splits))

    # Predictions
    predictions_tbl <- model_fit %>%
        modeltime_calibrate(rsample::testing(splits)) %>%
        modeltime_forecast(new_data = rsample::testing(splits))

    expect_s3_class(model_fit$fit, "temporal_hier_fit_impl")

    # $fit

    expect_s3_class(model_fit$fit$models$model_1, "forecast")

    expect_s3_class(model_fit$fit$data, "tbl_df")

    expect_equal(names(model_fit$fit$data)[1], "date")

    expect_null(model_fit$fit$extras$xreg_recipe)

    # $preproc

    expect_equal(model_fit$preproc$y_var, "value")


    # Structure
    expect_identical(nrow(rsample::testing(splits)), nrow(predictions_tbl))
    expect_identical(rsample::testing(splits)$date, predictions_tbl$.index)

    # Out-of-Sample Accuracy Tests

    resid <- rsample::testing(splits)$value - exp(predictions_tbl$.value)

    # - Max Error less than 1500
    expect_lte(max(abs(resid)), 320)

    # - MAE less than 700
    expect_lte(mean(abs(resid)), 100)




    # ---- ETS WORKFLOWS ----

    # Model Spec
    model_spec <- temporal_hierarchy() %>%
        parsnip::set_engine("thief")

    # Recipe spec
    recipe_spec <- recipes::recipe(value ~ date, data = rsample::training(splits)) %>%
        recipes::step_log(value, skip = FALSE)

    # Workflow
    wflw <- workflows::workflow() %>%
        workflows::add_recipe(recipe_spec) %>%
        workflows::add_model(model_spec)

    wflw_fit <- wflw %>%
        fit(rsample::training(splits))

    # Forecast
    predictions_tbl <- wflw_fit %>%
        modeltime_calibrate(rsample::testing(splits)) %>%
        modeltime_forecast(new_data = rsample::testing(splits),
                           actual_data = rsample::training(splits)) %>%
        dplyr::mutate(dplyr::across(.value, exp))

    # Tests

    expect_s3_class(wflw_fit$fit$fit$fit, "temporal_hier_fit_impl")

    # $fit

    expect_s3_class(wflw_fit$fit$fit$fit$models$model_1, "forecast")

    expect_s3_class(wflw_fit$fit$fit$fit$data, "tbl_df")

    expect_equal(names(wflw_fit$fit$fit$fit$data)[1], "date")

    expect_null(wflw_fit$fit$fit$fit$extras$xreg_recipe)

    # $preproc
    mld <- wflw_fit %>% workflows::extract_mold()
    expect_equal(names(mld$outcomes), "value")


    full_data <- dplyr::bind_rows(rsample::training(splits), rsample::testing(splits))

    # Structure
    expect_identical(nrow(full_data), nrow(predictions_tbl))
    expect_identical(full_data$date, predictions_tbl$.index)

    # Out-of-Sample Accuracy Tests
    predictions_tbl <- predictions_tbl %>% dplyr::filter(.key == "prediction")
    resid <- rsample::testing(splits)$value - predictions_tbl$.value

    # - Max Error less than 1500
    expect_lte(max(abs(resid)), 320)

    # - MAE less than 700
    expect_lte(mean(abs(resid)), 100)

})