class darts.datasets.dataset_loaders.DatasetLoader(metadata, root_path=None)[source]

Bases: ABC

Class that downloads a dataset and caches it locally. Assumes that the file can be downloaded (i.e. publicly available via a URI)

Methods

load()

Load the dataset in memory, as a TimeSeries.

load()[source]

Load the dataset in memory, as a TimeSeries. Downloads the dataset if it is not present already

Raises

DatasetLoadingException – If loading fails (MD5 Checksum is invalid, Download failed, Reading from disk failed)

Returns

time_series – A TimeSeries object that contains the dataset

Return type

TimeSeries

class darts.datasets.dataset_loaders.DatasetLoaderCSV(metadata, root_path=None)[source]

Bases: DatasetLoader

Methods

load()

Load the dataset in memory, as a TimeSeries.

load()

Load the dataset in memory, as a TimeSeries. Downloads the dataset if it is not present already

Raises

DatasetLoadingException – If loading fails (MD5 Checksum is invalid, Download failed, Reading from disk failed)

Returns

time_series – A TimeSeries object that contains the dataset

Return type

TimeSeries

class darts.datasets.dataset_loaders.DatasetLoaderMetadata(name, uri, hash, header_time, format_time=None, freq=None, pre_process_zipped_csv_fn=None, pre_process_csv_fn=None, multivariate=None)[source]

Bases: object

Attributes

format_time

freq

multivariate

pre_process_csv_fn

pre_process_zipped_csv_fn

format_time: Optional[str] = None
freq: Optional[str] = None
hash: str
header_time: Optional[str]
multivariate: Optional[bool] = None
name: str
pre_process_csv_fn: Optional[Callable] = None
pre_process_zipped_csv_fn: Optional[Callable] = None
uri: str
exception darts.datasets.dataset_loaders.DatasetLoadingException[source]

Bases: BaseException

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.