Table Of Contents
Table Of Contents

gluonts.dataset.repository.datasets module

gluonts.dataset.repository.datasets.get_dataset(dataset_name: str, path: pathlib.Path = PosixPath('/var/lib/jenkins/.mxnet/gluon-ts/datasets'), regenerate: bool = False) → gluonts.dataset.common.TrainDatasets[source]

Get a repository dataset.

The datasets that can be obtained through this function have been used with different processing over time by several papers (e.g., [SFG17], [LCY+18], and [YRD15]).

Parameters:
  • dataset_name – name of the dataset, for instance “m4_hourly”
  • regenerate – whether to regenerate the dataset even if a local file is present. If this flag is False and the file is present, the dataset will not be downloaded again.
  • path – where the dataset should be saved
Returns:

Return type:

dataset obtained by either downloading or reloading from local file.

gluonts.dataset.repository.datasets.materialize_dataset(dataset_name: str, path: pathlib.Path = PosixPath('/var/lib/jenkins/.mxnet/gluon-ts/datasets'), regenerate: bool = False) → pathlib.Path[source]

Ensures that the dataset is materialized under the path / dataset_name path.

Parameters:
  • dataset_name – name of the dataset, for instance “m4_hourly”
  • regenerate – whether to regenerate the dataset even if a local file is present. If this flag is False and the file is present, the dataset will not be downloaded again.
  • path – where the dataset should be saved
Returns:

Return type:

the path where the dataset is materialized