Skip to main content

Ready-to-use time series datasets for PyTorch Lightning

Project description

chronocratic-datasets

Ready-to-use time series datasets for PyTorch Lightning.

License: BSD 3-Clause PyPI version Python 3.12+ PyPI Downloads Build and Test Documentation Status code style - ruff GitHub Stars

Installation

Install the package via pip:

pip install chronocratic-datasets

Note: The PyPI package name uses a hyphen (chronocratic-datasets), but the import uses the chronocratic.datasets namespace:

from chronocratic.datasets import ...

Quick Start

from pathlib import Path

from chronocratic.datasets import ForecastingMode, WeatherDataModule

weather = WeatherDataModule(
    dataset_file_path=Path("data/weather.csv"),
    mode=ForecastingMode.UNIVARIATE,
)
weather.prepare_data()
weather.setup()
train_loader = weather.train_dataloader()

Datasets

Forecasting

  • ETT (Electricity Transformer Temperature): ETTh1, ETTh2, ETTm1, ETTm2 — transformer temperature data at hourly and 15-minute intervals
  • Weather: Weather and meteorological features from 2012 to 2017
  • Electricity: Hourly electricity load data

Classification

  • UCR (Univariate): Archive of univariate time series classification datasets
  • UEA (Multivariate): Archive of multivariate time series classification datasets

Features

  • PyTorch Lightning DataModules — Drop-in LightningDataModule implementations for seamless integration with Lightning training loops
  • Automatic caching with atomic writes — Downloaded and processed data is cached locally with atomic file operations to prevent corruption
  • DDP-compliant data loading — Workers share cached data correctly under Distributed Data Parallel training
  • Multiple forecasting modes — Switch between UNIVARIATE and MULTIVARIATE forecasting configurations
  • Built-in scaling — MinMax and Standard scalers applied automatically per dataset conventions
  • Type-safe API — Full type hints and Google-style docstrings for IDE autocomplete and static analysis

Documentation

Comprehensive documentation, including API reference, quickstart guides, and contributing instructions, is available at chronocratic-datasets.readthedocs.io.

License

BSD 3-Clause — see LICENSE for the full text.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chronocratic_datasets-0.1.0a3.tar.gz (254.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chronocratic_datasets-0.1.0a3-py3-none-any.whl (67.0 kB view details)

Uploaded Python 3

File details

Details for the file chronocratic_datasets-0.1.0a3.tar.gz.

File metadata

  • Download URL: chronocratic_datasets-0.1.0a3.tar.gz
  • Upload date:
  • Size: 254.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for chronocratic_datasets-0.1.0a3.tar.gz
Algorithm Hash digest
SHA256 bd98eea2b573b5078d124651acd7da937eb0a51793a2fc8ce3986afd112f1e3e
MD5 cd26b48075e4db5c333689e856a889fb
BLAKE2b-256 35974dc88de9afeff761b8bdc94617f5e3fc403453f70a84b01003c77e1c8d59

See more details on using hashes here.

Provenance

The following attestation bundles were made for chronocratic_datasets-0.1.0a3.tar.gz:

Publisher: pypi-publish.yml on chronocratic/chronocratic-datasets

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file chronocratic_datasets-0.1.0a3-py3-none-any.whl.

File metadata

File hashes

Hashes for chronocratic_datasets-0.1.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 0d20b7c0b3f7b187b6982ed5bab4bc125fbd237c0f0194b695d60090f61cbf0e
MD5 a1e29b7a3789d23052558f9891d55f6f
BLAKE2b-256 9b95bf03cd66bf491572b1868f330c2a5f682873146f070007ffa11aeebff1c4

See more details on using hashes here.

Provenance

The following attestation bundles were made for chronocratic_datasets-0.1.0a3-py3-none-any.whl:

Publisher: pypi-publish.yml on chronocratic/chronocratic-datasets

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page