M3

module datasetsforecast.m3

---

class Yearly

Yearly(seasonality: int = 1, horizon: int = 6, freq: str = ‘Y’, sheet_name: str = ‘M3Year’, name: str = ‘Yearly’, n_ts: int = 645)

method __init__

__init__(
    seasonality: int = 1,
    horizon: int = 6,
    freq: str = 'Y',
    sheet_name: str = 'M3Year',
    name: str = 'Yearly',
    n_ts: int = 645
) → None

---

class Quarterly

Quarterly(seasonality: int = 4, horizon: int = 8, freq: str = ‘Q’, sheet_name: str = ‘M3Quart’, name: str = ‘Quarterly’, n_ts: int = 756)

method __init__

__init__(
    seasonality: int = 4,
    horizon: int = 8,
    freq: str = 'Q',
    sheet_name: str = 'M3Quart',
    name: str = 'Quarterly',
    n_ts: int = 756
) → None

---

class Monthly

Monthly(seasonality: int = 12, horizon: int = 18, freq: str = ‘M’, sheet_name: str = ‘M3Month’, name: str = ‘Monthly’, n_ts: int = 1428)

method __init__

__init__(
    seasonality: int = 12,
    horizon: int = 18,
    freq: str = 'M',
    sheet_name: str = 'M3Month',
    name: str = 'Monthly',
    n_ts: int = 1428
) → None

---

class Other

Other(seasonality: int = 1, horizon: int = 8, freq: str = ‘D’, sheet_name: str = ‘M3Other’, name: str = ‘Other’, n_ts: int = 174)

method __init__

__init__(
    seasonality: int = 1,
    horizon: int = 8,
    freq: str = 'D',
    sheet_name: str = 'M3Other',
    name: str = 'Other',
    n_ts: int = 174
) → None

---

class M3

M3()

method __init__

__init__() → None

---

method download

download(directory: str) → None

Download M3 Dataset.

Args:

• directory (str): Directory path to download dataset.

---

method load

load(
    directory: str,
    group: str
) → Tuple[DataFrame, Optional[DataFrame], Optional[DataFrame]]

Downloads and loads M3 data.

Args:

• directory (str): Directory where data will be downloaded.
• group (str): Group name.
• Allowed groups: ‘Yearly’, ‘Quarterly’, ‘Monthly’, ‘Other’.

Returns:

• pd.DataFrame: Target time series with columns [‘unique_id’, ‘ds’, ‘y’].

---

This file was automatically generated via lazydocs.