Foundational Time Series Model Multi Series Cross Validation

Perform Cross Validation for multiple series

post/v2/cross_validation

Request body

freqstring required

The frequency of the data represented as a string. 'D' for daily, 'M' for monthly, 'H' for hourly, and 'W' for weekly frequencies are available.

n_windowsinteger required

Number of windows to evaluate.

hinteger required

The forecasting horizon. This represents the number of time steps into the future that the forecast should predict.

modelstring

Model to use as a string. Common options are (but not restricted to) timegpt-1 and timegpt-1-long-horizon. Full options vary by different users. Contact support@nixtla.io for more information. We recommend using timegpt-1-long-horizon for forecasting if you want to predict more than one seasonal period given the frequency of your data.

clean_ex_firstboolean

A boolean flag that indicates whether the API should preprocess (clean) the exogenous signal before applying the large time model. If True, the exogenous signal is cleaned; if False, the exogenous variables are applied after the large time model.

finetune_stepsinteger

The number of tuning steps used to train the large time model on the data. Set this value to 0 for zero-shot inference, i.e., to make predictions without any further model tuning.

finetune_loss'default' | 'mae' | 'mse' | 'rmse' | 'mape' | 'smape' | 'poisson'

The loss used to train the large time model on the data. Select from ['default', 'mae', 'mse', 'rmse', 'mape', 'smape']. It will only be used if finetune_steps larger than 0. Default is a robust loss function that is less sensitive to outliers.

finetune_depth1 | 2 | 3 | 4 | 5

The depth of the finetuning. Uses a scale from 1 to 5, where 1 means little finetuning, and 5 means that the entire model is finetuned. By default, the value is set to 1.

finetuned_model_idstring nullable

ID of previously finetuned model

step_sizeinteger nullable

Step size between each cross validation window. If None it will be equal to the forecasting horizon.

hist_exoginteger[] nullable

Zero-based indices of the exogenous features to treat as historical.

refitboolean

Fine-tune the model in each window. If False, only fine-tunes on the first window. Only used if finetune_steps > 0.

Response

Successful Response

input_tokensinteger required
output_tokensinteger required
finetune_tokensinteger required
meannumber[] required
sizesinteger[] required
idxsinteger[] required
intervalsobject nullable

Changes