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.0a2.tar.gz (254.3 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.0a2-py3-none-any.whl (67.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chronocratic_datasets-0.1.0a2.tar.gz
  • Upload date:
  • Size: 254.3 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.0a2.tar.gz
Algorithm Hash digest
SHA256 8f13f1643231b32ade78dc147cab04b124512f33d741b97a3c85b6ffa7c5adf4
MD5 e6a5cf613a26af66708a3a40c1f19571
BLAKE2b-256 abaea83c456d76dc6dd945ad5289040bfec53a3386cb15fb5331a4a810b6ea70

See more details on using hashes here.

Provenance

The following attestation bundles were made for chronocratic_datasets-0.1.0a2.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.0a2-py3-none-any.whl.

File metadata

File hashes

Hashes for chronocratic_datasets-0.1.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 bcfd08c89230788876de6528c77a6f3c4dc7322e08f7f3aea5172c783d0366f7
MD5 ada1aa63963fca86bbe9472401c3da87
BLAKE2b-256 0d86d665c1941099324c437ac8f9ef4cc249bb256ae6aa801054cb6277b358dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for chronocratic_datasets-0.1.0a2-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