load_fpp3#

load_fpp3(dataset, temp_folder=None)[source]#

Load a dataset from the fpp3 package.

Returns pd.DataFrame in one of the valid sktime mtype formats, depending on the dataset.

Valid datasets are listed in datasets.DATASET_NAMES_FPP3.

Requires rdata and requests packages in the environment.

Parameters:

datasetstr: The name of the dataset to load. Valid values are listed in datasets.DATASET_NAMES_FPP3.
temp_folder: str, optional: Location of temporary data folder for downloading and extracting the dataset. Deleted if the operation is successful.

Returns:

ypd.DataFrame: The loaded data. The mtype format is pd.DataFrame for single time series, pd-multiindex for collections of time series, and pd_multiindex_hier for hierarchical time series.

Raises:

ValueError: If the dataset is not known.
RuntimeError: If there is an error loading the dataset.