pycaret.time_series.finalize_model

pycaret.time_series.finalize_model(estimator, fit_kwargs: dict | None = None, model_only: bool = False) → Any

This function trains a given estimator on the entire dataset including the holdout set.

Example

>>> from pycaret.datasets import get_data
>>> data = get_data('airline')
>>> from pycaret.time_series import *
>>> exp_name = setup(data = data, fh = 12)
>>> arima = create_model('arima')
>>> final_arima = finalize_model(arima)

estimator: sktime compatible object

Trained model object

fit_kwargs: dict, default = None

Dictionary of arguments passed to the fit method of the model.

model_only: bool, default = True

Parameter not in use for now. Behavior may change in future.

Returns:

Trained pipeline or model object fitted on complete dataset.