M3 - Nixtla

Other(seasonality=1, horizon=8, freq='D', sheet_name='M3Other', name='Other', n_ts=174)

Monthly(seasonality=12, horizon=18, freq='M', sheet_name='M3Month', name='Monthly', n_ts=1428)

Quarterly(seasonality=4, horizon=8, freq='Q', sheet_name='M3Quart', name='Quarterly', n_ts=756)

Yearly(seasonality=1, horizon=6, freq='Y', sheet_name='M3Year', name='Yearly', n_ts=645)

M3()

download(directory)

Download M3 Dataset. Parameters:

Name	Type	Description	Default
`directory`	`str`	Directory path to download dataset.	required

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’].

​