This tutorial provides and example on how to use the predict_insample function of the core class to produce forecasts of the train and validation sets. In this example we will train the NHITS model on the AirPassengers data, and show how to recover the insample predictions after model is fitted. Predict Insample: The process of producing forecasts of the train and validation sets. Use Cases: * Debugging: producing insample predictions is useful for debugging purposes. For example, to check if the model is able to fit the train set. * Training convergence: check if the the model has converged. * Anomaly detection: insample predictions can be used to detect anomalous behavior in the train set (e.g. outliers). (Note: if a model is too flexible it might be able to perfectly forecast outliers) You can run these experiments using GPU with Google Colab. Open In Colab

​
1. Installing NeuralForecast

!pip install neuralforecast

​
2. Loading AirPassengers Data

The core.NeuralForecast class contains shared, fit, predict and other methods that take as inputs pandas DataFrames with columns ['unique_id', 'ds', 'y'], where unique_id identifies individual time series from the dataset, ds is the date, and y is the target variable. In this example dataset consists of a set of a single series, but you can easily fit your model to larger datasets in long format. 
from neuralforecast.utils import AirPassengersPanel

Y_df = AirPassengersPanel
Y_df.head()
unique_iddsytrendy_[lag12]
0Airline11949-01-31112.00112.0
1Airline11949-02-28118.01118.0
2Airline11949-03-31132.02132.0
3Airline11949-04-30129.03129.0
4Airline11949-05-31121.04121.0

​
3. Model Training

First, we train the NHITS models on the AirPassengers data. We will use the fit method of the core class to train the models. 
import logging
import pandas as pd

from neuralforecast import NeuralForecast
from neuralforecast.models import NHITS, LSTM

logging.getLogger('pytorch_lightning').setLevel(logging.ERROR)

horizon = 12

# Try different hyperparameters to improve accuracy.
models = [NHITS(h=horizon,                      # Forecast horizon
                input_size=2 * horizon,         # Length of input sequence
                max_steps=100,                  # Number of steps to train
                n_freq_downsample=[2, 1, 1],    # Downsampling factors for each stack output
                mlp_units = 3 * [[1024, 1024]],
               ) # Number of units in each block.
          ]
nf = NeuralForecast(models=models, freq='ME')
nf.fit(df=Y_df, val_size=horizon)

​
4. Predict Insample

Using the NeuralForecast.predict_insample method you can obtain the forecasts for the train and validation sets after the models are fitted. The function will always take the last dataset used for training in either the fit or cross_validation methods. With the step_size parameter you can specify the step size between consecutive windows to produce the forecasts. In this example we will set step_size=horizon to produce non-overlapping forecasts. The following diagram shows how the forecasts are produced based on the step_size parameter and h (horizon) of the model. In the diagram we set step_size=2 and h=4. 
Y_hat_insample = nf.predict_insample(step_size=horizon)
The predict_insample function returns a pandas DataFrame with the following columns: * unique_id: the unique identifier of the time series. * ds: the datestamp of the forecast for each row. * cutoff: the datestamp at which the forecast was made. * y: the actual value of the target variable. * model_name: the forecasted values for the models. In this case, NHITS. 
Y_hat_insample.head()
unique_iddscutoffNHITSy
0Airline11949-01-311948-12-310.064625112.0
1Airline11949-02-281948-12-310.074300118.0
2Airline11949-03-311948-12-310.133020132.0
3Airline11949-04-301948-12-310.221040129.0
4Airline11949-05-311948-12-310.176580121.0
Important The function will produce forecasts from the first timestamp of the time series. For these initial timestamps, the forecasts might not be accurate given that models have very limited input information to produce forecasts.

​
5. Plot Predictions

Finally, we plot the forecasts for the train and validation sets. 
from utilsforecast.plotting import plot_series

plot_series(forecasts_df=Y_hat_insample.drop(columns='cutoff'))

​
6. Insample predictions with prediction intervals

We can also show insample prediction intervals for models trained with a distribution loss function. This can be achieved by simply specifying the required level in the predict_insample function. Note that the following settings are not yet supported: - Prediction intervals on insample predictions on models trained with conformal prediction intervals (e.g. a model trained with MAE and conformal prediction intervals); - Prediction intervals on insample predictions on multivariate models (e.g. a TSMixer model). 
from neuralforecast.losses.pytorch import DistributionLoss, GMM

horizon = 12

# Try different hyperparameters to improve accuracy.
models = [
            NHITS(h=horizon,
                input_size=2 * horizon,
                loss=DistributionLoss(distribution="Poisson", num_samples=50),
                max_steps=100,
                scaler_type="robust",
               ),
           LSTM(h=horizon,
                input_size=2 * horizon,
                loss=GMM(),
                max_steps=500,
                scaler_type="robust",
               ),
          ]
nf = NeuralForecast(models=models, freq='ME')
nf.fit(df=Y_df, val_size=horizon)

Y_hat_insample = nf.predict_insample(
    step_size=horizon,
    level=[80],
)

plot_series(forecasts_df=Y_hat_insample.drop(columns=['cutoff']), level=[80])

​
References