Stay organized with collectionsSave and categorize content based on your preferences.
The ML.HOLIDAY_INFO function
This document describes theML.HOLIDAY_INFOfunction, which you can use to
return the list of holidays being modeled by anARIMA_PLUSorARIMA_PLUS_XREGtime series forecasting model.
Syntax
ML.HOLIDAY_INFO(
MODEL `PROJECT_ID.DATASET.MODEL_NAME`
)
Arguments
ML.HOLIDAY_INFOtakes the following arguments:
PROJECT_ID: your project ID.
DATASET: the BigQuery dataset that contains
the model.
MODEL_NAME: the name of the model.
Output
ML.HOLIDAY_INFOreturns the following columns:
region: aSTRINGvalue that identifies the holiday region.
holiday_name: aSTRINGvalue that identifies the holiday.
primary_date: aDATEvalue that identifies the date the holiday
falls on.
preholiday_days: anINT64value that identifies the start of the
holiday window around the holiday that was taken into account when
modeling.
postholiday_days: anINT64value that identifies the end of the
holiday window around the holiday that was taken into account when
modeling.
Example
The following example returns the results for a model that uses acustom holiday:
+-----------------------+--------------+-----------------+------------------+
| region | holiday_name | primary_date | preholiday_days | postholiday_days |
+--------------------------------------------------------+------------------+
| US | Members day | 2001-10-21 | 3 | 1 |
+-----------------------+--------------+-----------------+------------------+
| US | Members day | 2002-10-22 | 3 | 1 |
+-----------------------+--------------+-----------------+------------------+
| US | Members day | 2003-10-21 | 3 | 1 |
+-----------------------+--------------+-----------------+------------------+
| US | Members day | 2004-10-23 | 3 | 1 |
+-----------------------+--------------+-----------------+------------------+
Limitation
Results returned byML.HOLIDAY_INFOonly indicate the holiday information
used during model fitting. They don't necessarily indicate the detection of a
holiday effect. UseML.EXPLAIN_FORECASTinstead for actual holiday effect results.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eML.HOLIDAY_INFO\u003c/code\u003e function provides a list of holidays considered by \u003ccode\u003eARIMA_PLUS\u003c/code\u003e or \u003ccode\u003eARIMA_PLUS_XREG\u003c/code\u003e time series forecasting models.\u003c/p\u003e\n"],["\u003cp\u003eThe function requires the model's project ID, dataset, and name as arguments, and its syntax is \u003ccode\u003eML.HOLIDAY_INFO(MODEL \u003c/code\u003eproject_id.dataset.model\u003ccode\u003e)\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe output includes details such as the holiday region, holiday name, primary date, and the number of pre-holiday and post-holiday days.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eML.HOLIDAY_INFO\u003c/code\u003e displays information on the holidays that were taken into account during model fitting, and does not provide results for the detection of an effect from holidays, for that use \u003ccode\u003eML.EXPLAIN_FORECAST\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# The ML.HOLIDAY_INFO function\n============================\n\nThis document describes the `ML.HOLIDAY_INFO` function, which you can use to\nreturn the list of holidays being modeled by an\n[`ARIMA_PLUS`](/bigquery/docs/reference/standard-sql/bigqueryml-syntax-create-time-series)\nor\n[`ARIMA_PLUS_XREG`](/bigquery/docs/reference/standard-sql/bigqueryml-syntax-create-time-series)\ntime series forecasting model.\n\nSyntax\n------\n\n```sql\nML.HOLIDAY_INFO(\n MODEL `PROJECT_ID.DATASET.MODEL_NAME`\n)\n```\n\n### Arguments\n\n`ML.HOLIDAY_INFO` takes the following arguments:\n\n- \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: your project ID.\n- \u003cvar translate=\"no\"\u003eDATASET\u003c/var\u003e: the BigQuery dataset that contains the model.\n- \u003cvar translate=\"no\"\u003eMODEL_NAME\u003c/var\u003e: the name of the model.\n\nOutput\n------\n\n`ML.HOLIDAY_INFO` returns the following columns:\n\n- `region`: a `STRING` value that identifies the holiday region.\n- `holiday_name`: a `STRING` value that identifies the holiday.\n- `primary_date`: a `DATE` value that identifies the date the holiday falls on.\n- `preholiday_days`: an `INT64` value that identifies the start of the holiday window around the holiday that was taken into account when modeling.\n- `postholiday_days`: an `INT64` value that identifies the end of the holiday window around the holiday that was taken into account when modeling.\n\nExample\n-------\n\nThe following example returns the results for a model that uses a\n[custom holiday](/bigquery/docs/reference/standard-sql/bigqueryml-syntax-create-time-series#custom_holidays): \n\n```sql\nSELECT * FROM\nML.HOLIDAY_INFO(MODEL `mydataset.arima_model`);\n```\n\nThe output looks similar to the following: \n\n```\n+-----------------------+--------------+-----------------+------------------+\n| region | holiday_name | primary_date | preholiday_days | postholiday_days |\n+--------------------------------------------------------+------------------+\n| US | Members day | 2001-10-21 | 3 | 1 |\n+-----------------------+--------------+-----------------+------------------+\n| US | Members day | 2002-10-22 | 3 | 1 |\n+-----------------------+--------------+-----------------+------------------+\n| US | Members day | 2003-10-21 | 3 | 1 |\n+-----------------------+--------------+-----------------+------------------+\n| US | Members day | 2004-10-23 | 3 | 1 |\n+-----------------------+--------------+-----------------+------------------+\n```\n\nLimitation\n----------\n\n- Results returned by `ML.HOLIDAY_INFO` only indicate the holiday information used during model fitting. They don't necessarily indicate the detection of a holiday effect. Use [`ML.EXPLAIN_FORECAST`](/bigquery/docs/reference/standard-sql/bigqueryml-syntax-explain-forecast) instead for actual holiday effect results.\n\nWhat's next\n-----------\n\n- For information about model evaluation, see [BigQuery ML model evaluation overview](/bigquery/docs/evaluate-overview).\n- For information about the supported SQL statements and functions for each model type, see [End-to-end user journey for each model](/bigquery/docs/e2e-journey)."]]
