forecast
Run a saved plan to predict future time series or evaluate on a test set, exporting predictions and metrics to CSV and returning a run ID.
Instructions
Run a plan: forecast the future, or evaluate on a test set with test_size. Predictions and metrics go to CSV files. Returns a forecast id.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan_id | Yes | Id of the plan to run (from `plan`, `refine_plan` or `links.best_plan_id` of `compare`). | |
| exog_path | No | Absolute path of a CSV file with the future values of the exogenous variables, one row per date (and series) of the horizon. Required to forecast the future when the plan uses exogenous variables. The script of `get_code` reads them from 'exog_future.csv' in its working directory. | |
| test_size | No | Null to forecast the future. To evaluate instead, the test set: the last n observations (an integer, which must equal `steps`) or the ISO 8601 date it starts at. A fraction in (0, 1) only works when it gives exactly `steps` observations. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| cost | No | ||
| kind | Yes | ||
| files | No | ||
| links | No | ||
| notices | No | ||
| summary | Yes | ||
| changeable | No | ||
| notices_omitted | No | ||
| values_included | No | ||
| summary_truncated | No |