M3

M3 dataset

Other

Other(seasonality=1, horizon=8, freq='D', name='Other', n_ts=174, source_url='https://zenodo.org/api/records/4656335/files/m3_other_dataset.zip/content', file_name='m3_other_dataset')

Monthly

Monthly(seasonality=12, horizon=18, freq='ME', name='Monthly', n_ts=1428, source_url='https://zenodo.org/api/records/4656298/files/m3_monthly_dataset.zip/content', file_name='m3_monthly_dataset')

Quarterly

Quarterly(seasonality=4, horizon=8, freq='QE', name='Quarterly', n_ts=756, source_url='https://zenodo.org/api/records/4656262/files/m3_quarterly_dataset.zip/content', file_name='m3_quarterly_dataset')

Yearly

Yearly(seasonality=1, horizon=6, freq='YE', name='Yearly', n_ts=645, source_url='https://zenodo.org/api/records/4656222/files/m3_yearly_dataset.zip/content', file_name='m3_yearly_dataset')

M3

M3()

M3.download

download(directory, class_group)

Download M3 Dataset.

Parameters:

Name	Type	Description	Default
directory	str	Directory path to download dataset.	required
class_group		Dataclass with source_url and file_name.	required

M3.load

load(directory, group)

Downloads and loads M3 data.

Parameters:

Name	Type	Description	Default
directory	str	Directory where data will be downloaded.	required
group	str	Group name. Allowed groups: ‘Yearly’, ‘Quarterly’, ‘Monthly’, ‘Other’.	required

Returns:

Type	Description
Tuple[DataFrame, Optional[DataFrame], Optional[DataFrame]]	pd.DataFrame: Target time series with columns [‘unique_id’, ‘ds’, ‘y’].